method public static

SectionTable::setDefaultScope()

Сигнатура

public static setDefaultScope(Query $query) : Query

Параметры

$query Query

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

Query

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

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

Добавляет условия по умолчанию в каждый запрос к SectionTable, созданный через query() или getList(). Переопределяют в наследнике, если, например, всегда нужно скрывать неактивные записи.

use Bitrix\Main\ORM\Query\Query;

class MySectionTable extends \Bitrix\Iblock\SectionTable
{
    public static function setDefaultScope(Query $query): Query
    {
        return $query->where('ID', '>', 0);
    }
}

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

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

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

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