method public static

VatTable::setDefaultScope()

Сигнатура

public static setDefaultScope(Query $query) : Query

Параметры

$query Query

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

Query

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

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

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

use Bitrix\Main\ORM\Query\Query;

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

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

getActiveVatIdByRate() Возвращает ID активной ставки НДС для указанного значения. При необходимости создаёт новую ставку НДС.
getExcludeVatId() Возвращает id исключаемого НДС, если существует.
isExistsExcludeVat() Возвращает true, если существует системный НДС.

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

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