ArrayAccessTrait.php 2.32 KB
Newer Older
Qiang Xue committed
1 2 3 4 5 6 7 8 9 10
<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\base;

/**
11
 * ArrayAccessTrait provides the implementation for [[\IteratorAggregate]], [[\ArrayAccess]] and [[\Countable]].
Qiang Xue committed
12 13 14 15
 *
 * Note that ArrayAccessTrait requires the class using it contain a property named `data` which should be an array.
 * The data will be exposed by ArrayAccessTrait to support accessing the class object like an array.
 *
Carsten Brandt committed
16 17
 * @property array $data
 *
Qiang Xue committed
18 19 20 21 22
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
trait ArrayAccessTrait
{
23 24 25 26 27 28 29 30 31 32
    /**
     * Returns an iterator for traversing the data.
     * This method is required by the SPL interface `IteratorAggregate`.
     * It will be implicitly called when you use `foreach` to traverse the collection.
     * @return \ArrayIterator an iterator for traversing the cookies in the collection.
     */
    public function getIterator()
    {
        return new \ArrayIterator($this->data);
    }
Qiang Xue committed
33

34 35 36 37 38 39 40 41 42
    /**
     * Returns the number of data items.
     * This method is required by Countable interface.
     * @return integer number of data elements.
     */
    public function count()
    {
        return count($this->data);
    }
Qiang Xue committed
43

44 45
    /**
     * This method is required by the interface ArrayAccess.
46
     * @param mixed $offset the offset to check on
47 48 49 50 51 52
     * @return boolean
     */
    public function offsetExists($offset)
    {
        return isset($this->data[$offset]);
    }
Qiang Xue committed
53

54 55
    /**
     * This method is required by the interface ArrayAccess.
56 57
     * @param integer $offset the offset to retrieve element.
     * @return mixed the element at the offset, null if no element is found at the offset
58 59 60 61 62
     */
    public function offsetGet($offset)
    {
        return isset($this->data[$offset]) ? $this->data[$offset] : null;
    }
Qiang Xue committed
63

64 65 66
    /**
     * This method is required by the interface ArrayAccess.
     * @param integer $offset the offset to set element
67
     * @param mixed $item the element value
68 69 70 71 72
     */
    public function offsetSet($offset, $item)
    {
        $this->data[$offset] = $item;
    }
Qiang Xue committed
73

74 75 76 77 78 79 80 81
    /**
     * This method is required by the interface ArrayAccess.
     * @param mixed $offset the offset to unset element
     */
    public function offsetUnset($offset)
    {
        unset($this->data[$offset]);
    }
Qiang Xue committed
82
}