method public static

GroupTable::setDefaultScope()

Сигнатура

public static setDefaultScope(Query $query) : Query

Параметры

$query Query

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

Query

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

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

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

use Bitrix\Main\ORM\Query\Query;

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

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

getBasePriceType() Возвращает кешированный базовый тип цены или null.
getBasePriceTypeId() Возвращает кешированный id базового типа цены или null.
getTypeList() Возвращает кешированный список типов цен.

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

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