method public static

IblockMessageTable::getByPrimary()

Класс: \Bitrix\Iblock\IblockMessageTable

Сигнатура

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

Описание

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

Параметры

$primary mixed

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

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

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

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

EO_IblockMessage_Result

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Iblock\IblockMessageTable;

Loader::includeModule('iblock');

$primary = [/*    */];
$row = IblockMessageTable::getByPrimary($primary, [
    'select' => ['IBLOCK_ID', 'MESSAGE_ID', 'MESSAGE_TEXT'],
])->fetch();

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

Поле	Тип	Свойства
`IBLOCK_ID`	`int`	обязательное
`MESSAGE_ID`	`string(50)`	обязательное
`MESSAGE_TEXT`	`string(255)`	необязательное
`IBLOCK`	`reference`

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

Собственные методы IblockMessageTable

validateMessageId() Возвращает валидаторы для поля MESSAGE_ID.
validateMessageText() Возвращает валидаторы для поля MESSAGE_TEXT.

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

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