method public static

PropertyEnumerationTable::getList()

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

Сигнатура

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_PropertyEnumeration_Result

Описание

Выполняет запрос и возвращает выборку по параметрам запроса. Эта функция является псевдонимом для функций объекта Query

Параметры

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

Массив параметров запроса, доступные ключи: "select" => массив полей в части SELECT запроса, возможны псевдонимы в виде "alias"=>"field"; "filter" => массив фильтров в части WHERE/HAVING запроса в виде "(condition)field"=>"value"; также может быть экземпляром Filter; "group" => массив полей в части GROUP BY запроса; "order" => массив полей в части ORDER BY запроса в виде "field"=>"asc|desc"; "limit" => целое число, указывающее максимальное количество строк в выборке (как LIMIT n в MySql); "offset" => целое число, указывающее номер первой строки в выборке (как LIMIT n, 100 в MySql); "runtime" => массив полей сущности, создаваемых динамически; "cache => массив опций кеширования: "ttl" => целое число, указывающее время жизни кеша (TTL); "cache_joins" => булево значение, включающее кеширование объединений, по умолчанию false.

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

EO_PropertyEnumeration_Result

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

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

Основной способ читать записи PropertyEnumerationTable. Параметры select, filter, order, limit, runtime передаются одним массивом, а возвращается EO_PropertyEnumeration_Result — по нему идут fetch() (массивы) или fetchObject() (объекты EO_PropertyEnumeration).

use Bitrix\Main\Loader;
use Bitrix\Iblock\PropertyEnumerationTable;

Loader::includeModule('iblock');

$result = PropertyEnumerationTable::getList([
    'select' => ['ID', 'PROPERTY_ID', 'VALUE'],
    'filter' => ['>ID' => 0],
    'limit'  => 20,
]);
while ($row = $result->fetch()) {
    // $row — массив с выбранными полями
}

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`PROPERTY_ID`	`int`	обязательное
`VALUE`	`string(255)`	обязательное
`DEF`	`bool`	необязательное, по умолчанию 'N'
`SORT`	`int`	необязательное, по умолчанию 500
`XML_ID`	`string(200)`	обязательное
`TMP_ID`	`string(40)`	необязательное
`PROPERTY`	`reference`

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

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

validateTmpId() Возвращает валидаторы для поля TMP_ID.
validateValue() Возвращает валидаторы для поля VALUE.
validateXmlId() Возвращает валидаторы для поля XML_ID.

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

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