You are here

public function ArrayCollection::removeElement 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::removeElement()

Removes the specified element from the collection, if it is found.

Parameters

mixed $element The element to remove.:

Return value

boolean TRUE if this collection contained the specified element, FALSE otherwise.

Overrides Collection::removeElement

File

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

Class

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

Namespace

Doctrine\Common\Collections

Code

public function removeElement($element) {
  $key = array_search($element, $this->elements, true);
  if ($key === false) {
    return false;
  }
  unset($this->elements[$key]);
  return true;
}