brainworxx/kreXX

<?php

/**
 * kreXX: Krumo eXXtended
 *
 * kreXX is a debugging tool, which displays structured information
 * about any PHP object. It is a nice replacement for print_r() or var_dump()
 * which are used by a lot of PHP developers.
 *
 * kreXX is a fork of Krumo, which was originally written by:
 * Kaloyan K. Tsvetkov <kaloyan@kaloyan.info>
 *
 * @author
 *   brainworXX GmbH <info@brainworxx.de>
 *
 * @license
 *   http://opensource.org/licenses/LGPL-2.1
 *
 *   GNU Lesser General Public License Version 2.1
 *
 *   kreXX Copyright (C) 2014-2024 Brainworxx GmbH
 *
 *   This library is free software; you can redistribute it and/or modify it
 *   under the terms of the GNU Lesser General Public License as published by
 *   the Free Software Foundation; either version 2.1 of the License, or (at
 *   your option) any later version.
 *   This library is distributed in the hope that it will be useful, but WITHOUT
 *   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 *   FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
 *   for more details.
 *   You should have received a copy of the GNU Lesser General Public License
 *   along with this library; if not, write to the Free Software Foundation,
 *   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

declare(strict_types=1);

namespace Brainworxx\Krexx\Service\Reflection;

use ReflectionProperty;
use ReflectionClass;

/**
 * The original \ReflectionProperty may throw an error when used with
 * dynamically declared properties.
 *
 * For some reason, the \ReflectionProperty may claim that this property is
 * not there. We may have run into an interference of private properties in a
 * deeper class, __isset() which tries to dynamically resolve this, and some
 * public dynamically declared property with the same name as the private
 * property.
 * The __isset is called, because there is a private property somewhere with the
 * same name, so we can not rely on it.
 * The reflection property then claims that this property does not exist. The
 * only thing I can think of how to fix this, is with a mockup class for the
 * ReflectionProperty.
 * So. Much. Fun.
 */
class UndeclaredProperty extends ReflectionProperty
{
    /**
     * This one is always undeclared.
     *
     * @var bool
     */
    public bool $isUndeclared = true;

    /**
     * The name of the property.
     *
     * @var string|int
     */
    public $propertyName;

    /**
     * A reflection of the class, where the property was declared.
     *
     * @var \ReflectionClass
     */
    protected ReflectionClass $declaringClass;

    /**
     * Is this value actually reachable?
     *
     * The DateTime object has those. Undeclared and not reachable.
     *
     * @var bool
     */
    protected bool $isPublic = true;

    /**
     * Is this property protected? Probably not.
     *
     * @var bool
     */
    protected bool $isProtected = false;

    /**
     * Setting the necessary property's constructor.
     *
     * @param \ReflectionClass $ref
     *   The instance of the class with the property.
     * @param string|int $name
     *   The name of the property.
     */
    public function __construct(ReflectionClass $ref, $name)
    {
        $this->declaringClass = $ref;
        $this->propertyName = $name;
    }

    /**
     * A dynamically declared property can never be static.
     *
     * @return bool
     *   Always false.
     */
    public function isStatic(): bool
    {
        return false;
    }

    /**
     * Getter for the reflection of the class with the property.
     *
     * @return \ReflectionClass
     *   The refection.
     */
    public function getDeclaringClass(): ReflectionClass
    {
        return $this->declaringClass;
    }

    /**
     * A dynamically declared property can never have a default value.
     *
     * @return bool
     *   Always false.
     */
    public function isDefault(): bool
    {
        return false;
    }

    /**
     * A dynamically declared property can never be private.
     *
     * @return bool
     *   Always false.
     */
    public function isPrivate(): bool
    {
        return false;
    }

    /**
     * A dynamically declared property can never be protected.
     *
     * @return bool
     *   Always false.
     */
    public function isProtected(): bool
    {
        return $this->isProtected;
    }

    /**
     * A dynamically declared property is always public.
     *
     * @return bool
     *   Is it a public property?
     */
    public function isPublic(): bool
    {
        return $this->isPublic;
    }

    /**
     * Setter for the isPublic property.
     *
     * @param bool $isPublic
     *
     * @return UndeclaredProperty
     *   Return $this for chaining.
     */
    public function setIsPublic(bool $isPublic): UndeclaredProperty
    {
        $this->isPublic = $isPublic;
        return $this;
    }

    /**
     * Getter for the property name.
     *
     * @return string
     *   The property name.
     */
    public function getName(): string
    {
        return (string)$this->propertyName;
    }

    /**
     * We need to implement this one without the possibility of throwing an
     * error in order to be compatible with te original \ReflectionClass.
     *
     * @return string
     *   Always an empty string.
     */
    public function __toString(): string
    {
        return '';
    }

    /**
     * Undeclared properties are not typed.
     *
     * @return bool
     */
    public function hasType(): bool
    {
        return false;
    }

    /**
     * Undeclared properties have no default value.
     *
     * @return null
     */
    #[\ReturnTypeWillChange]
    public function getDefaultValue()
    {
        return null;
    }
}