hiqdev\yii2\collection\ObjectTrait

Complexity

Total Complexity

22

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

93.94%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	get()	0	4	1
B	set()	0	8	5
A	add()	0	8	2
A	has()	0	4	3
A	delete()	0	4	1
A	__get()	0	8	3
A	__set()	0	4	1
A	__isset()	0	4	3
A	__unset()	0	8	3

<?php
/**
 * Collection library for Yii2.
 *
 * @link      https://github.com/hiqdev/yii2-collection
 * @package   yii2-collection
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2015-2017, HiQDev (http://hiqdev.com/)
 */

namespace hiqdev\yii2\collection;

use hiqdev\php\collection\BaseTrait;
use yii\base\ArrayableTrait;

/**
 * ObjectTrait.
 * Intended to be used for yii\base\BaseObject descendants.
 * Uses canSet/GetPropperty and magic functions to provide compatible getter/setter mechanisms.
 */
trait ObjectTrait
{
    use ArrayableTrait;
    use BaseTrait {
        BaseTrait::fields insteadof ArrayableTrait;
    }

    /**
     * Returns property of item by name.
     * @param mixed $name
     * @return mixed
     */
    public function get($name)
    {
        return $this->__get($name);
    }

    /**
     * Sets an item. Silently resets if already exists.
     * @param int|string   $name
     * @param mixed        $value the element value
     * @param string|array $where where to put, see [[setItem()]]
     * @see setItem()
     */
    public function set($name, $value, $where = '')
    {
        if (($name && $this->canSetProperty($name)) || strpos($name, 'on ') === 0 || strpos($name, 'as ') === 0) {

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

            parent::__set($name, $value);

It seems like you call parent on a different method (__set() instead of set()). Are you sure this is correct? If so, you might want to change this to $this->__set().

        } else {
            $this->setItem($name, $value, $where);
        }
    }

    /**
     * Adds an item. Does not touch if already exists.
     * @param int|string   $name  item name
     * @param array        $value item value
     * @param string|array $where where to put, see [[setItem()]]
     * @return $this for chaining
     * @see setItem()
     */
    public function add($name, $value = null, $where = '')
    {
        if (!$this->has($name)) {
            $this->set($name, $value, $where);
        }

        return $this;
    }

    /**
     * Check collection has the item.
     * @param string $name item name
     * @return bool whether item exist
     */
    public function has($name)
    {
        return ($name && $this->hasProperty($name)) || $this->hasItem($name);

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

    }

    /**
     * Delete an item.
     * @param $name
     */
    public function delete($name)
    {
        $this->__unset($name);
    }

    /**
     * This method is overridden to support accessing items like properties.
     * @param string $name item or property name
     * @return mixed item of found or the named property value
     */
    public function __get($name)
    {
        if ($name && $this->canGetProperty($name)) {

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

            return parent::__get($name);
        } else {
            return $this->getItem($name);
        }
    }

    /**
     * This method is overridden to support accessing items like properties.
     * @param string $name  item or property name
     * @param string $value value to be set
     * @return mixed item of found or the named property value
     */
    public function __set($name, $value)
    {
        $this->set($name, $value);
    }

    /**
     * Checks if a property value is null.
     * This method overrides the parent implementation by checking if the named item is loaded.
     * @param string $name the property name or the event name
     * @return bool whether the property value is null
     */
    public function __isset($name)
    {
        return ($name && parent::__isset($name)) || $this->issetItem($name);
    }

    /**
     * Checks if a property value is null.
     * This method overrides the parent implementation by checking if the named item is loaded.
     * @param string $name the property name or the event name
     * @return bool whether the property value is null
     */
    public function __unset($name)
    {
        if ($name && $this->canSetProperty($name)) {

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

            parent::__unset($name);
        } else {
            $this->unsetItem($name);
        }
    }
}