Удалить сущность из памяти Entity::destroy

Модуль: main — подключать отдельно не нужно

Статический метод Entity::destroy удаляет сущность из внутреннего хранилища класса Entity и класса таблицы. Следующий вызов get или getEntity построит сущность заново. Ядро вызывает метод, когда меняются пользовательские поля сущности.

Сигнатура метода в классе Bitrix\Main\ORM\Entity:

public static function destroy($entity)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
entity* Entity или string Задает сущность объектом или именем

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

Возвращаемое значение

Метод возвращает true, если удалил сущность, и false, если сущности в памяти не было.

Особенности

Метод не удаляет класс таблицы и таблицу в базе данных.

Примеры

Пример. Код удаляет сущность из памяти дважды:

<?php
use Bitrix\Main\Localization\LanguageTable;
use Bitrix\Main\ORM\Entity;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$entity = LanguageTable::getEntity();

var_dump(Entity::destroy($entity), Entity::destroy('Bitrix\Main\Localization\Language'), LanguageTable::getEntity() === $entity);

Код выведет:

bool(true)
bool(false)
bool(false)

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