method public static

ElementTable::getByPrimary()

Сигнатура

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Element_Result

Описание

Возвращает выборку по первичному ключу сущности и необязательным параметрам для getList()

Параметры

$primary mixed

Первичный ключ сущности

$parameters array<string|int, mixed> = = '[]'

Дополнительные параметры для getList()

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

EO_Element_Result

Как применяется в ElementTable

ElementTable::getByPrimary() — метод класса \Bitrix\Iblock\ElementTable модуля «Информационные блоки». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_Element, наборы — как EO_Element_Collection. Метод достаётся ElementTable от DataManager::getByPrimary: поведение общее для всех сущностей, а данные, поля и классы — свои.

То же, что getById(), но с параметрами getList() вторым аргументом. Для составного ключа ElementTable передаётся массивом.

use Bitrix\Main\Loader;
use Bitrix\Iblock\ElementTable;

Loader::includeModule('iblock');

$row = ElementTable::getByPrimary(1, [
    'select' => ['ID', 'TIMESTAMP_X', 'MODIFIED_BY'],
])->fetch();

Поля сущности ElementTable

Поле	Тип	Свойства
`ID`	`int`	обязательное
`TIMESTAMP_X`	`datetime`	необязательное
`MODIFIED_BY`	`int`	необязательное
`DATE_CREATE`	`datetime`	необязательное
`CREATED_BY`	`int`	необязательное
`IBLOCK_ID`	`int`	обязательное
`IBLOCK_SECTION_ID`	`int`	необязательное
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`ACTIVE_FROM`	`datetime`	необязательное
`ACTIVE_TO`	`datetime`	необязательное
`SORT`	`int`	необязательное, по умолчанию 500
`NAME`	`string(255)`	обязательное
`PREVIEW_PICTURE`	`int`	необязательное
`PREVIEW_TEXT`	`string`	необязательное
`PREVIEW_TEXT_TYPE`	`enum`	необязательное, по умолчанию 'text'
`DETAIL_PICTURE`	`int`	необязательное
`DETAIL_TEXT`	`string`	необязательное
`DETAIL_TEXT_TYPE`	`enum`	необязательное, по умолчанию 'text'
`SEARCHABLE_CONTENT`	`string`	необязательное
`WF_STATUS_ID`	`int`	необязательное, по умолчанию 1
`WF_PARENT_ELEMENT_ID`	`int`	необязательное
`WF_NEW`	`enum`	необязательное
`WF_LOCKED_BY`	`int`	необязательное
`WF_DATE_LOCK`	`datetime`	необязательное
`WF_COMMENTS`	`string`	необязательное
`IN_SECTIONS`	`bool`	необязательное, по умолчанию 'N'
`XML_ID`	`string(255)`	необязательное
`CODE`	`string(255)`	необязательное
`TAGS`	`string(255)`	необязательное
`TMP_ID`	`string(40)`	необязательное
`WF_LAST_HISTORY_ID`	`int`	необязательное
`SHOW_COUNTER`	`int`	необязательное
`SHOW_COUNTER_START`	`datetime`	необязательное
`PREVIEW_PICTURE_FILE`	`reference`
`DETAIL_PICTURE_FILE`	`reference`
`IBLOCK`	`reference`
`WF_PARENT_ELEMENT`	`reference`
`IBLOCK_SECTION`	`reference`
`MODIFIED_BY_USER`	`reference`
`CREATED_BY_USER`	`reference`
`WF_LOCKED_BY_USER`	`reference`

Список — из описания класса в исходном коде; точный состав в вашей версии вернёт ElementTable::getEntity()->getFields().

Другие методы ElementTable

add() Добавляет элемент инфоблока.
addMulti() Добавляет несколько строк в таблицу сущности.
checkFields() Проверяет поля данных перед сохранением в БД. Результат хранится в объекте $result
cleanCache() Очищает кеш таблета после модификаций данных.
createCollection()
createObject()
cryptoEnabled() Возвращает true, если для поля включено шифрование.
delete() Удаляет элемент инфоблока по первичному ключу.
enableCrypto() Устанавливает флаг, указывающий на поддержку шифрования для поля.
getById() Возвращает выборку по первичному ключу сущности
getCollectionClass() Возвращает класс коллекции объектов для текущей сущности.
getCollectionClassName() Возвращает имя класса (без пространства имён) коллекции объектов для текущей сущности.

getByPrimary() есть и у других классов модуля «Информационные блоки»: IblockFieldTable, IblockGroupTable, IblockMessageTable, IblockRssTable, IblockSiteTable, IblockTable, InheritedPropertyTable, PropertyEnumerationTable.

Исходный файл: source/iblock/lib/elementtable.php