method public static

DiscountCouponTable::getByPrimary()

Класс: \Bitrix\Sale\Internals\DiscountCouponTable

Сигнатура

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_DiscountCoupon_Result

Описание

Возвращает выборку по первичному ключу сущности и необязательным параметрам для getList()

Параметры

$primary mixed

Первичный ключ сущности

$parameters array<string|int, mixed> = = '[]'

Дополнительные параметры для getList()

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

EO_DiscountCoupon_Result

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

DiscountCouponTable::getByPrimary() — метод класса \Bitrix\Sale\Internals\DiscountCouponTable модуля «Интернет-магазин». Это ORM-сущность D7 (наследник DataManager): строки читаются как объекты EO_DiscountCoupon, наборы — как EO_DiscountCoupon_Collection. Метод достаётся DiscountCouponTable от DataManager::getByPrimary: поведение общее для всех сущностей, а данные, поля и классы — свои.

То же, что getById(), но с параметрами getList() вторым аргументом. Для составного ключа DiscountCouponTable передаётся массивом.

use Bitrix\Main\Loader;
use Bitrix\Sale\Internals\DiscountCouponTable;

Loader::includeModule('sale');

$row = DiscountCouponTable::getByPrimary(1, [
    'select' => ['ID', 'DISCOUNT_ID', 'ACTIVE'],
])->fetch();

Поля сущности DiscountCouponTable

Поле	Тип	Свойства
`ID`	`int`	обязательное
`DISCOUNT_ID`	`int`	обязательное
`ACTIVE`	`bool`	необязательное, по умолчанию 'Y'
`ACTIVE_FROM`	`datetime`	необязательное
`ACTIVE_TO`	`datetime`	необязательное
`COUPON`	`string(32)`	обязательное
`TYPE`	`int`	обязательное
`MAX_USE`	`int`	обязательное
`USE_COUNT`	`int`	обязательное
`USER_ID`	`int`	обязательное
`DATE_APPLY`	`datetime`	необязательное
`TIMESTAMP_X`	`datetime`	необязательное
`MODIFIED_BY`	`int`	необязательное
`DATE_CREATE`	`datetime`	необязательное
`CREATED_BY`	`int`	необязательное
`DESCRIPTION`	`text`	необязательное
`CREATED_BY_USER`	`reference`
`MODIFIED_BY_USER`	`reference`
`DISCOUNT`	`reference`

Список — из описания класса в исходном коде; точный состав в вашей версии вернёт DiscountCouponTable::getEntity()->getFields().

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

addPacket() Создаёт один или несколько купонов для скидки.
checkCoupon() Проверяет купон — уникальность и существование.
checkDiscountId() Проверить id скидки.
checkPacket() Проверяет данные для создания одного или нескольких купонов.
checkType() Проверяет тип купона.
clearDiscountCheckList() Очищает список скидок для обновления флага использования купонов.
deleteByDiscount() Удалить все купоны для скидки.
disableCheckCouponsUse() Отключает проверку использования купонов для скидки перед множественным добавлением/обновлением/удалением.
enableCheckCouponsUse() Включает проверку использования купонов для скидки после множественного добавления/обновления/удаления.
generateCoupon() Создаёт код купона.
getCouponTypes() Возвращает список типов купонов.
isCheckedCouponsUse() Возвращает текущий режим проверки использования купонов.

getByPrimary() есть и у других классов модуля «Интернет-магазин»: BasketArchivePackedTable, BasketArchiveTable, BasketPropertyTable, BasketTable, BusinessValueCode1CTable, BusinessValuePersonDomainTable, BusinessValueTable, BuyerStatisticTable.

Исходный файл: source/sale/lib/internals/discountcoupon.php