method public static

InheritedPropertyTable::getList()

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

Сигнатура

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

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

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

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

use Bitrix\Main\Loader;
use Bitrix\Iblock\InheritedPropertyTable;

Loader::includeModule('iblock');

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

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

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

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

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