class DeprecatedArray

An array that triggers a deprecation warning when accessed.

Hierarchy

  • class \Drupal\Component\Utility\DeprecatedArray extends \Drupal\Component\Utility\ArrayObject

Expanded class hierarchy of DeprecatedArray

File

View on git.drupalcode.org

core/lib/Drupal/Component/Utility/DeprecatedArray.php, line 8

Namespace

Drupal\Component\Utility
View source 
class DeprecatedArray extends \ArrayObject {
  
  /**
   * The deprecation message.
   *
   * @var string
   */
  protected $message;
  
  /**
   * DeprecatedArray constructor.
   *
   * @param array $values
   *   The array values.
   * @param $message
   *   The deprecation message.
   */
  public function __construct(array $values, $message) {
    $this->message = $message;
    parent::__construct($values);
  }
  
  /**
   * {@inheritdoc}
   */
  public function offsetExists($offset) {
    @trigger_error($this->message, E_USER_DEPRECATED);
    return parent::offsetExists($offset);
  }
  
  /**
   * {@inheritdoc}
   */
  public function offsetGet($offset) {
    @trigger_error($this->message, E_USER_DEPRECATED);
    return parent::offsetGet($offset);
  }
  
  /**
   * {@inheritdoc}
   */
  public function offsetSet($offset, $value) {
    @trigger_error($this->message, E_USER_DEPRECATED);
    parent::offsetSet($offset, $value);
  }
  
  /**
   * {@inheritdoc}
   */
  public function offsetUnset($offset) {
    @trigger_error($this->message, E_USER_DEPRECATED);
    parent::offsetUnset($offset);
  }
  
  /**
   * {@inheritdoc}
   */
  public function getIterator() {
    @trigger_error($this->message, E_USER_DEPRECATED);
    return parent::getIterator();
  }
  
  /**
   * {@inheritdoc}
   */
  public function unserialize($serialized) {
    @trigger_error($this->message, E_USER_DEPRECATED);
    parent::unserialize($serialized);
  }
  
  /**
   * {@inheritdoc}
   */
  public function serialize() {
    @trigger_error($this->message, E_USER_DEPRECATED);
    return parent::serialize();
  }
  
  /**
   * {@inheritdoc}
   */
  public function count() {
    @trigger_error($this->message, E_USER_DEPRECATED);
    return parent::count();
  }

}

Members

Title Modifiers Object type Summary
DeprecatedArray::$message protected property The deprecation message.
DeprecatedArray::count public function #[\ReturnTypeWillChange]
DeprecatedArray::getIterator public function #[\ReturnTypeWillChange]
DeprecatedArray::offsetExists public function #[\ReturnTypeWillChange]
DeprecatedArray::offsetGet public function #[\ReturnTypeWillChange]
DeprecatedArray::offsetSet public function #[\ReturnTypeWillChange]
DeprecatedArray::offsetUnset public function #[\ReturnTypeWillChange]
DeprecatedArray::serialize public function #[\ReturnTypeWillChange]
DeprecatedArray::unserialize public function #[\ReturnTypeWillChange]
DeprecatedArray::__construct public function DeprecatedArray constructor.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.