public function ArrayCollection::remove in Zircon Profile 8

Same name and namespace in other branches

1. 8.0 vendor/doctrine/collections/lib/Doctrine/Common/Collections/ArrayCollection.php \Doctrine\Common\Collections\ArrayCollection::remove()

Removes the element at the specified index from the collection.

Parameters

string|integer $key The kex/index of the element to remove.:

Return value

mixed The removed element or NULL, if the collection did not contain the element.

Overrides Collection::remove

1 call to ArrayCollection::remove()

ArrayCollection::offsetUnset in vendor/doctrine/collections/lib/Doctrine/Common/Collections/ArrayCollection.php

Required by interface ArrayAccess.

File

vendor/doctrine/collections/lib/Doctrine/Common/Collections/ArrayCollection.php, line 104

Class

ArrayCollection

An ArrayCollection is a Collection implementation that wraps a regular PHP array.

Namespace

Doctrine\Common\Collections

Code

public function remove($key) {
  if (!isset($this->elements[$key]) && !array_key_exists($key, $this->elements)) {
    return null;
  }
  $removed = $this->elements[$key];
  unset($this->elements[$key]);
  return $removed;
}