Aura\Marshal\Data

Complexity

Total Complexity

7

Size/Duplication

Total Lines	109
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

7 Methods

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

<?php
/**
 *
 * This file is part of the Aura project for PHP.
 *
 * @package Aura.Marshal
 *
 * @license https://opensource.org/licenses/mit-license.php MIT
 *
 */
namespace Aura\Marshal;

/**
 *
 * Represents a data set. This is similar to the SPL ArrayObject, but allows
 * you easier access to the underlying data itself. This class serves as a
 * base for ...
 *
 * - the generic type object, where $data represents an IdentityMap;
 *
 * - the generic entity object, where $data represents the entity fields; and
 *
 * - the generic collection object, where $data represents an array of
 *   entities.
 *
 * @package Aura.Marshal
 * 
 * @implements \ArrayAccess<int|string, mixed>
 * @implements \IteratorAggregate<int|string, mixed>
 *
 */
class Data implements \ArrayAccess, \Countable, \IteratorAggregate
{
    /**
     *
     * Key-value pairs of data.
     *
     * @var array<int|string, GenericEntity|mixed>
     *
     */
    protected $data = [];

    /**
     *
     * Constructor.
     *
     * @param array<int|string, mixed> $data The data for this object.
     *
     */
    public function __construct(array $data = [])
    {
        $this->data = $data;
    }

    /**
     *
     * ArrayAccess: does the requested key exist?
     *
     * @param int|string $key The requested key.
     *
     * @return bool
     *
     */
    #[\ReturnTypeWillChange]
    public function offsetExists($key)
    {
        return array_key_exists($key, $this->data);
    }

    /**
     *
     * ArrayAccess: get a key value.
     *
     * @param int|string $key The requested key.
     *
     * @return mixed
     *
     */
    #[\ReturnTypeWillChange]
    public function offsetGet($key)
    {
        return $this->data[$key];
    }

    /**
     *
     * ArrayAccess: set a key value.
     *
     * @param int|string $key The requested key.
     *
     * @param mixed $val The value to set it to.
     *
     * @return void
     *
     */
    #[\ReturnTypeWillChange]
    public function offsetSet($key, $val)
    {
        $this->data[$key] = $val;
    }

    /**
     *
     * ArrayAccess: unset a key.
     *
     * @param int|string $key The requested key.
     *
     * @return void
     *
     */
    #[\ReturnTypeWillChange]
    public function offsetUnset($key)
    {
        unset($this->data[$key]);
    }

    /**
     *
     * Countable: how many keys are there?
     *
     * @return int
     *
     */
    #[\ReturnTypeWillChange]
    public function count()
    {
        return count($this->data);
    }

    /**
     *
     * IteratorAggregate: returns an external iterator for this struct.
     *
     * @return DataIterator
     *
     */
    #[\ReturnTypeWillChange]
    public function getIterator()
    {
        return new DataIterator($this, array_keys($this->data));
    }
}