method public static

ElementTable::getList()

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

Сигнатура

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

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

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

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

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

Loader::includeModule('iblock');

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

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

ПолеТипСвойства
IDintобязательное
TIMESTAMP_Xdatetimeнеобязательное
MODIFIED_BYintнеобязательное
DATE_CREATEdatetimeнеобязательное
CREATED_BYintнеобязательное
IBLOCK_IDintобязательное
IBLOCK_SECTION_IDintнеобязательное
ACTIVEboolнеобязательное, по умолчанию 'Y'
ACTIVE_FROMdatetimeнеобязательное
ACTIVE_TOdatetimeнеобязательное
SORTintнеобязательное, по умолчанию 500
NAMEstring(255)обязательное
PREVIEW_PICTUREintнеобязательное
PREVIEW_TEXTstringнеобязательное
PREVIEW_TEXT_TYPEenumнеобязательное, по умолчанию 'text'
DETAIL_PICTUREintнеобязательное
DETAIL_TEXTstringнеобязательное
DETAIL_TEXT_TYPEenumнеобязательное, по умолчанию 'text'
SEARCHABLE_CONTENTstringнеобязательное
WF_STATUS_IDintнеобязательное, по умолчанию 1
WF_PARENT_ELEMENT_IDintнеобязательное
WF_NEWenumнеобязательное
WF_LOCKED_BYintнеобязательное
WF_DATE_LOCKdatetimeнеобязательное
WF_COMMENTSstringнеобязательное
IN_SECTIONSboolнеобязательное, по умолчанию 'N'
XML_IDstring(255)необязательное
CODEstring(255)необязательное
TAGSstring(255)необязательное
TMP_IDstring(40)необязательное
WF_LAST_HISTORY_IDintнеобязательное
SHOW_COUNTERintнеобязательное
SHOW_COUNTER_STARTdatetimeнеобязательное
PREVIEW_PICTURE_FILEreference
DETAIL_PICTURE_FILEreference
IBLOCKreference
WF_PARENT_ELEMENTreference
IBLOCK_SECTIONreference
MODIFIED_BY_USERreference
CREATED_BY_USERreference
WF_LOCKED_BY_USERreference

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

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

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

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

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

Что будем искать? Например,Продвижение