Метод remove

Метод remove класса ArrayCollection удаляет элемент из коллекции по указанному ключу. Первым параметром передаётся ключ элемента, который нужно удалить. Метод возвращает удалённое значение или null, если такого ключа в коллекции не было.

Важно учитывать, что remove удаляет элемент именно по ключу, а не по значению. Если нужно удалить элемент по значению, используйте метод removeElement.

Синтаксис

$res = $collection->remove($key);

Пример

Давайте создадим коллекцию и удалим из неё элемент по ключу:

<?php
	use Doctrine\Common\Collections\ArrayCollection;
	
	$collection = new ArrayCollection(['a', 'b', 'c', 'd', 'e']);
	
	$res = $collection->remove(2);
	
	echo $res;
?>

Результат выполнения кода:

"c"

Пример

Давайте посмотрим, как изменится коллекция после удаления элемента:

<?php
	use Doctrine\Common\Collections\ArrayCollection;
	
	$collection = new ArrayCollection(['a', 'b', 'c', 'd', 'e']);
	
	$collection->remove(2);
	
	print_r($collection->toArray());
?>

Результат выполнения кода:

[0 => "a", 1 => "b", 3 => "d", 4 => "e"]

Пример

Давайте удалим несуществующий ключ и посмотрим на результат:

<?php
	use Doctrine\Common\Collections\ArrayCollection;
	
	$collection = new ArrayCollection(['a', 'b', 'c', 'd', 'e']);
	
	$res = $collection->remove(10);
	
	var_dump($res);
?>

Результат выполнения кода:

NULL

Смотрите также

класс ArrayCollection,
который представляет собой коллекцию элементов
метод removeElement,
который удаляет элемент по значению
метод add,
который добавляет элемент в коллекцию
метод contains,
который проверяет наличие элемента в коллекции