method public static

GroupAccessTable::setDefaultScope()

Сигнатура

public static setDefaultScope(Query $query) : Query

Параметры

$query Query

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

Query

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

GroupAccessTable::setDefaultScope() — метод класса \Bitrix\Catalog\GroupAccessTable модуля «Торговый каталог». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_GroupAccess, наборы — как EO_GroupAccess_Collection. Метод достаётся GroupAccessTable от DataManager::setDefaultScope: поведение общее для всех сущностей, а данные, поля и классы — свои.

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

use Bitrix\Main\ORM\Query\Query;

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

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

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

setDefaultScope() есть и у других классов модуля «Торговый каталог»: CatalogIblockTable, CatalogViewedProductTable, DiscountCouponTable, DiscountModuleTable, DiscountRestrictionTable, DiscountTable, ExtraTable, GroupLangTable.

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