Yiisoft\ActiveRecord\Trait\MagicPropertiesTrait

Complexity

Total Complexity

54

Size/Duplication

Total Lines	231
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	canSetProperty()	0	5	4
A	__set()	0	20	5
A	canGetProperty()	0	6	5
A	getAttribute()	0	7	2
A	setAttribute()	0	6	2
A	setAttributeInternal()	0	9	4
A	__get()	0	25	6
B	isAttributeChanged()	0	16	7
A	__isset()	0	6	2
A	populateAttribute()	0	6	2
A	hasProperty()	0	7	6
A	hasAttribute()	0	3	2
A	getAttributes()	0	10	2
A	__unset()	0	14	5

<?php

declare(strict_types=1);

namespace Yiisoft\ActiveRecord\Trait;

use ReflectionException;
use Throwable;
use Yiisoft\ActiveRecord\AbstractActiveRecord;
use Yiisoft\ActiveRecord\ActiveRecordInterface;
use Yiisoft\Db\Exception\Exception;
use Yiisoft\Db\Exception\InvalidArgumentException;
use Yiisoft\Db\Exception\InvalidCallException;
use Yiisoft\Db\Exception\InvalidConfigException;
use Yiisoft\Db\Exception\UnknownPropertyException;

use function array_diff;
use function array_flip;
use function array_intersect_key;
use function array_key_exists;
use function array_merge;
use function get_object_vars;
use function in_array;
use function method_exists;
use function property_exists;
use function ucfirst;

/**
 * Trait to define magic methods to access values of an ActiveRecord instance.
 *
 * @method array getOldAttributes()
 * @see AbstractActiveRecord::getOldAttributes()
 *
 * @method mixed getOldAttribute(string $name)
 * @see AbstractActiveRecord::getOldAttribute()
 *
 * @method array getRelatedRecords()
 * @see AbstractActiveRecord::getRelatedRecords()
 *
 * @method bool hasDependentRelations(string $attribute)
 * @see AbstractActiveRecord::hasDependentRelations()
 *
 * @method bool isRelationPopulated(string $name)
 * @see ActiveRecordInterface::isRelationPopulated()
 *
 * @method void resetDependentRelations(string $attribute)
 * @see AbstractActiveRecord::resetDependentRelations()
 *
 * @method void resetRelation(string $name)
 * @see ActiveRecordInterface::resetRelation()
 *
 * @method ActiveRecordInterface|array|null retrieveRelation(string $name)
 * @see AbstractActiveRecord::retrieveRelation()
 */
trait MagicPropertiesTrait
{
    private array $attributes = [];

    /**
     * PHP getter magic method.
     *
     * This method is overridden so that attributes and related objects can be accessed like properties.
     *
     * @param string $name property name.
     *
     * @throws InvalidArgumentException|InvalidCallException|InvalidConfigException|ReflectionException|Throwable
     * @throws UnknownPropertyException
     *
     * @throws Exception
     * @return mixed property value.
     *
     * {@see getAttribute()}
     */
    public function __get(string $name)
    {
        if ($this->hasAttribute($name)) {
            return $this->getAttribute($name);
        }

        if ($this->isRelationPopulated($name)) {
            return $this->getRelatedRecords()[$name];
        }

        if (method_exists($this, $getter = 'get' . ucfirst($name))) {
            /** read getter, e.g. getName() */
            return $this->$getter();
        }

        if (method_exists($this, 'get' . ucfirst($name) . 'Query')) {
            /** read relation query getter, e.g. getUserQuery() */
            return $this->retrieveRelation($name);
        }

        if (method_exists($this, 'set' . ucfirst($name))) {
            throw new InvalidCallException('Getting write-only property: ' . static::class . '::' . $name);
        }

        throw new UnknownPropertyException('Getting unknown property: ' . static::class . '::' . $name);
    }

    /**
     * Checks if a property value is null.
     *
     * This method overrides the parent implementation by checking if the named attribute is `null` or not.
     *
     * @param string $name the property name or the event name.
     *
     * @return bool whether the property value is null.
     */
    public function __isset(string $name): bool
    {
        try {
            return $this->__get($name) !== null;
        } catch (InvalidCallException|UnknownPropertyException) {

Expected at least 1 space before "|"; 0 found

Expected at least 1 space after "|"; 0 found

            return false;
        }
    }

    /**
     * Sets a component property to be null.
     *
     * This method overrides the parent implementation by clearing the specified attribute value.
     *
     * @param string $name the property name or the event name.
     */
    public function __unset(string $name): void
    {
        if ($this->hasAttribute($name)) {
            unset($this->attributes[$name]);

            if (property_exists($this, $name)) {
                $this->$name = null;
            }

            if ($this->hasDependentRelations($name)) {
                $this->resetDependentRelations($name);
            }
        } elseif ($this->isRelationPopulated($name)) {
            $this->resetRelation($name);
        }
    }

    /**
     * PHP setter magic method.
     *
     * This method is overridden so that AR attributes can be accessed like properties.
     *
     * @param string $name property name.
     *
     * @throws InvalidCallException|UnknownPropertyException
     */
    public function __set(string $name, mixed $value): void
    {
        if ($this->hasAttribute($name)) {
            $this->setAttributeInternal($name, $value);
            return;
        }

        if (method_exists($this, $setter = 'set' . ucfirst($name))) {
            $this->$setter($value);
            return;
        }

        if (
            method_exists($this, 'get' . ucfirst($name))
            || method_exists($this, 'get' . ucfirst($name) . 'Query')
        ) {
            throw new InvalidCallException('Setting read-only property: ' . static::class . '::' . $name);
        }

        throw new UnknownPropertyException('Setting unknown property: ' . static::class . '::' . $name);
    }

    public function getAttribute(string $name): mixed
    {
        if (property_exists($this, $name)) {
            return get_object_vars($this)[$name] ?? null;
        }

        return $this->attributes[$name] ?? null;
    }

    public function getAttributes(array $names = null, array $except = []): array
    {
        $names ??= $this->attributes();

It seems like attributes() must be provided by classes using this trait. How about adding it as abstract method to this trait?

        $attributes = array_merge($this->attributes, get_object_vars($this));

        if ($except !== []) {
            $names = array_diff($names, $except);
        }

        return array_intersect_key($attributes, array_flip($names));
    }

    public function hasAttribute(string $name): bool
    {
        return isset($this->attributes[$name]) || in_array($name, $this->attributes(), true);
    }

    public function isAttributeChanged(string $name, bool $identical = true): bool
    {
        $hasOldAttribute = array_key_exists($name, $this->getOldAttributes());

        if (!$hasOldAttribute) {
            return property_exists($this, $name) && array_key_exists($name, get_object_vars($this))
                || array_key_exists($name, $this->attributes);
        }

        if (property_exists($this, $name)) {
            return !array_key_exists($name, get_object_vars($this))
                || $this->getOldAttribute($name) !== $this->$name;
        }

        return !array_key_exists($name, $this->attributes)
            || $this->getOldAttribute($name) !== $this->attributes[$name];
    }

    public function setAttribute(string $name, mixed $value): void
    {
        if ($this->hasAttribute($name)) {
            $this->setAttributeInternal($name, $value);
        } else {
            throw new InvalidArgumentException(static::class . ' has no attribute named "' . $name . '".');
        }
    }

    /**
     * Returns a value indicating whether a property is defined for this component.
     *
     * A property is defined if:
     *
     * - the class has a getter or setter method associated with the specified name (in this case, property name is
     *   case-insensitive).
     * - the class has a member variable with the specified name (when `$checkVars` is true).
     *
     * @param string $name the property name.
     * @param bool $checkVars whether to treat member variables as properties.
     *
     * @return bool whether the property is defined.
     *
     * {@see canGetProperty()}
     * {@see canSetProperty()}
     */
    public function hasProperty(string $name, bool $checkVars = true): bool
    {
        return method_exists($this, 'get' . ucfirst($name))
            || method_exists($this, 'set' . ucfirst($name))
            || method_exists($this, 'get' . ucfirst($name) . 'Query')
            || ($checkVars && property_exists($this, $name))
            || $this->hasAttribute($name);
    }

    public function canGetProperty(string $name, bool $checkVars = true): bool
    {
        return method_exists($this, 'get' . ucfirst($name))
            || method_exists($this, 'get' . ucfirst($name) . 'Query')
            || ($checkVars && property_exists($this, $name))
            || $this->hasAttribute($name);
    }

    public function canSetProperty(string $name, bool $checkVars = true): bool
    {
        return method_exists($this, 'set' . ucfirst($name))
            || ($checkVars && property_exists($this, $name))
            || $this->hasAttribute($name);
    }

    protected function populateAttribute(string $name, mixed $value): void
    {
        if (property_exists($this, $name)) {
            $this->$name = $value;
        } else {
            $this->attributes[$name] = $value;
        }
    }

    private function setAttributeInternal(string $name, mixed $value): void
    {
        if ($this->hasDependentRelations($name)

The first expression of a multi-line control structure must be on the line after the opening parenthesis

            && ($value === null || $this->getAttribute($name) !== $value)
        ) {
            $this->resetDependentRelations($name);
        }

        $this->populateAttribute($name, $value);
    }
}