Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AbstractArray.php

class AbstractArray

This class provides a basic implementation of `ArrayInterface`, to minimize the effort required to implement this interface.

@template T @implements ArrayInterface<T>

Hierarchy

  • class \Ramsey\Collection\AbstractArray implements \Ramsey\Collection\ArrayInterface

Expanded class hierarchy of AbstractArray

1 file declares its use of AbstractArray
AbstractMap.php in vendor/ramsey/collection/src/Map/AbstractMap.php

File

vendor/ramsey/collection/src/AbstractArray.php, line 29

Namespace

Ramsey\Collection
View source
abstract class AbstractArray implements ArrayInterface {
    
    /**
     * The items of this array.
     *
     * @var array<array-key, T>
     */
    protected array $data = [];
    
    /**
     * Constructs a new array object.
     *
     * @param array<array-key, T> $data The initial items to add to this array.
     */
    public function __construct(array $data = []) {
        // Invoke offsetSet() for each value added; in this way, sub-classes
        // may provide additional logic about values added to the array object.
        foreach ($data as $key => $value) {
            $this[$key] = $value;
        }
    }
    
    /**
     * Returns an iterator for this array.
     *
     * @link http://php.net/manual/en/iteratoraggregate.getiterator.php IteratorAggregate::getIterator()
     *
     * @return Traversable<array-key, T>
     */
    public function getIterator() : Traversable {
        return new ArrayIterator($this->data);
    }
    
    /**
     * Returns `true` if the given offset exists in this array.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetexists.php ArrayAccess::offsetExists()
     *
     * @param array-key $offset The offset to check.
     */
    public function offsetExists(mixed $offset) : bool {
        return isset($this->data[$offset]);
    }
    
    /**
     * Returns the value at the specified offset.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetget.php ArrayAccess::offsetGet()
     *
     * @param array-key $offset The offset for which a value should be returned.
     *
     * @return T the value stored at the offset, or null if the offset
     *     does not exist.
     */
    public function offsetGet(mixed $offset) : mixed {
        return $this->data[$offset];
    }
    
    /**
     * Sets the given value to the given offset in the array.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetset.php ArrayAccess::offsetSet()
     *
     * @param array-key | null $offset The offset to set. If `null`, the value
     *     may be set at a numerically-indexed offset.
     * @param T $value The value to set at the given offset.
     */
    public function offsetSet(mixed $offset, mixed $value) : void {
        if ($offset === null) {
            $this->data[] = $value;
        }
        else {
            $this->data[$offset] = $value;
        }
    }
    
    /**
     * Removes the given offset and its value from the array.
     *
     * @link http://php.net/manual/en/arrayaccess.offsetunset.php ArrayAccess::offsetUnset()
     *
     * @param array-key $offset The offset to remove from the array.
     */
    public function offsetUnset(mixed $offset) : void {
        unset($this->data[$offset]);
    }
    
    /**
     * Returns data suitable for PHP serialization.
     *
     * @link https://www.php.net/manual/en/language.oop5.magic.php#language.oop5.magic.serialize
     * @link https://www.php.net/serialize
     *
     * @return array<array-key, T>
     */
    public function __serialize() : array {
        return $this->data;
    }
    
    /**
     * Adds unserialized data to the object.
     *
     * @param array<array-key, T> $data
     */
    public function __unserialize(array $data) : void {
        $this->data = $data;
    }
    
    /**
     * Returns the number of items in this array.
     *
     * @link http://php.net/manual/en/countable.count.php Countable::count()
     */
    public function count() : int {
        return count($this->data);
    }
    public function clear() : void {
        $this->data = [];
    }
    
    /**
     * @inheritDoc
     */
    public function toArray() : array {
        return $this->data;
    }
    public function isEmpty() : bool {
        return $this->data === [];
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
AbstractArray::$data protected property The items of this array.
AbstractArray::clear public function Removes all items from this array. Overrides ArrayInterface::clear
AbstractArray::count public function Returns the number of items in this array.
AbstractArray::getIterator public function Returns an iterator for this array. 2
AbstractArray::isEmpty public function Returns `true` if this array is empty. Overrides ArrayInterface::isEmpty
AbstractArray::offsetExists public function Returns `true` if the given offset exists in this array.
AbstractArray::offsetGet public function Returns the value at the specified offset.
AbstractArray::offsetSet public function Sets the given value to the given offset in the array. 3
AbstractArray::offsetUnset public function Removes the given offset and its value from the array.
AbstractArray::toArray public function @inheritDoc Overrides ArrayInterface::toArray 1
AbstractArray::__construct public function Constructs a new array object. 4
AbstractArray::__serialize public function Returns data suitable for PHP serialization. 1
AbstractArray::__unserialize public function Adds unserialized data to the object.
RSS feed
Powered by Drupal