method public static

PropertyTable::getList()

Сигнатура

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Property_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_Property_Result

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Iblock\PropertyTable;

Loader::includeModule('iblock');

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

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

Поле	Тип	Свойства
`ID`	`int`	обязательное
`TIMESTAMP_X`	`datetime`	обязательное, по умолчанию 'CURRENT_TIMESTAMP'
`IBLOCK_ID`	`int`	обязательное
`NAME`	`string(255)`	обязательное
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`SORT`	`int`	необязательное, по умолчанию 500
`CODE`	`string(50)`	необязательное
`DEFAULT_VALUE`	`text`	необязательное
`PROPERTY_TYPE`	`enum`	необязательное, по умолчанию 'S'
`ROW_COUNT`	`int`	необязательное, по умолчанию 1
`COL_COUNT`	`int`	необязательное, по умолчанию 30
`LIST_TYPE`	`enum`	необязательное, по умолчанию 'L'
`MULTIPLE`	`bool`	необязательное, по умолчанию 'N'
`XML_ID`	`string(100)`	необязательное
`FILE_TYPE`	`string(200)`	необязательное
`MULTIPLE_CNT`	`int`	необязательное
`TMP_ID`	`string(40)`	необязательное
`LINK_IBLOCK_ID`	`int`	необязательное
`WITH_DESCRIPTION`	`bool`	необязательное, по умолчанию 'N'
`SEARCHABLE`	`bool`	необязательное, по умолчанию 'N'
`FILTRABLE`	`bool`	необязательное, по умолчанию 'N'
`IS_REQUIRED`	`bool`	необязательное, по умолчанию 'N'
`VERSION`	`enum`	необязательное, по умолчанию 1
`USER_TYPE`	`string(255)`	необязательное
`USER_TYPE_SETTINGS`	`string`	необязательное
`HINT`	`string(255)`	необязательное
`LINK_IBLOCK`	`reference`
`IBLOCK`	`reference`

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

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

defaultValueFetchModifier() Модификатор выборки для значения по умолчанию пользовательского типа из старого ядра инфоблоков.
fillOldCoreFetchModifiers() Добавляет модификаторы выборки для эмуляции старого ядра инфоблоков.
userTypeSettingsFetchModifer() Модификатор выборки для настроек пользовательского типа из старого ядра инфоблоков.

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

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