Метод removeElement

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

Синтаксис

public function removeElement(mixed $element): bool

Пример

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

<?php
	namespace App\Controller;

	use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
	use Symfony\Component\HttpFoundation\Response;
	use Doctrine\Common\Collections\ArrayCollection;

	class ArticleController extends AbstractController
	{
		public function index(): Response
		{
			$collection = new ArrayCollection(['abcde', 'article', 'user', 'hello']);

			$res = $collection->removeElement('abcde');

			var_dump($res);
			print_r($collection->toArray());

			return new Response('ok');
		}
	}
?>

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

true
["article", "user", "hello"]

Пример

Давайте попробуем удалить элемент, которого нет в коллекции:

<?php
	namespace App\Controller;

	use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
	use Symfony\Component\HttpFoundation\Response;
	use Doctrine\Common\Collections\ArrayCollection;

	class ArticleController extends AbstractController
	{
		public function index(): Response
		{
			$collection = new ArrayCollection(['abcde', 'article', 'user']);

			$res = $collection->removeElement('hello');

			var_dump($res);
			print_r($collection->toArray());

			return new Response('ok');
		}
	}
?>

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

false
["abcde", "article", "user"]

Пример

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

<?php
	namespace App\Controller;

	use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
	use Symfony\Component\HttpFoundation\Response;
	use Doctrine\Common\Collections\ArrayCollection;

	class ArticleController extends AbstractController
	{
		public function index(): Response
		{
			$collection = new ArrayCollection([1, 2, 3, 4, 5]);

			$collection->removeElement(3);

			print_r($collection->toArray());

			return new Response('ok');
		}
	}
?>

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

[1, 2, 4, 5]

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

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