Yiisoft\Arrays\ArrayAccessTrait

Complexity

Total Complexity

7

Size/Duplication

Total Lines	70
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getIterator()	0	3	1
A	count()	0	3	1
A	offsetUnset()	0	3	1
A	offsetGet()	0	3	1
A	offsetExists()	0	3	1
A	offsetSet()	0	6	2

<?php

declare(strict_types=1);

namespace Yiisoft\Arrays;

use ArrayIterator;

/**
 * `ArrayAccessTrait` provides the implementation for {@see \IteratorAggregate}, {@see \ArrayAccess}
 * and {@see \Countable}.
 *
 * 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.
 *
 * @property array $data
 */
trait ArrayAccessTrait
{
    /**
     * Returns an iterator for traversing the data.
     * This method is required by the SPL interface {@see \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(): ArrayIterator
    {
        return new ArrayIterator($this->data);
    }

    /**
     * Returns the number of data items.
     * This method is required by Countable interface.
     *
     * @return int Number of data elements.
     */
    public function count(): int
    {
        return count($this->data);
    }

    /**
     * This method is required by the interface {@see \ArrayAccess}.
     *
     * @param mixed $offset The offset to check on.
     */
    public function offsetExists(mixed $offset): bool
    {
        return isset($this->data[$offset]);
    }

    /**
     * This method is required by the interface {@see \ArrayAccess}.
     *
     * @param mixed $offset The offset to retrieve element.
     *
     * @return mixed The element at the offset, null if no element is found at the offset.
     */
    public function offsetGet(mixed $offset): mixed
    {
        return $this->data[$offset] ?? null;
    }

    /**
     * This method is required by the interface {@see \ArrayAccess}.
     *
     * @param mixed $offset The offset to set element.
     * @param mixed $value The element value.
     */
    public function offsetSet(mixed $offset, mixed $value): void
    {
        if ($offset === null) {
            $this->data[] = $value;
        } else {
            $this->data[$offset] = $value;
        }
    }

    /**
     * This method is required by the interface {@see \ArrayAccess}.
     *
     * @param mixed $offset The offset to unset element.
     */
    public function offsetUnset(mixed $offset): void
    {
        unset($this->data[$offset]);
    }
}