ByLocation::checkByEntity() — параметры и описание

Сигнатура

public static checkByEntity(Entity $entity, array<string|int, mixed> $restrictionParams, int $mode[, int $serviceId = 0 ]) : int

Описание

Проверка параметров службы на соответствие ограничению по сущности.

Параметры

$entity Entity

$restrictionParams array<string|int, mixed>

$mode int

$serviceId int = 0

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

int

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

ByLocation::checkByEntity() — метод класса \Bitrix\Sale\Delivery\Restrictions\ByLocation модуля «Интернет-магазин». ByLocation: Класс ByLocation Ограничивает доставку по местоположению(ям).

Статический метод — вызывается через имя класса ByLocation, без создания объекта.

use Bitrix\Main\Loader;
use Bitrix\Sale\Delivery\Restrictions\ByLocation;

Loader::includeModule('sale');

$entity = null; // Entity
$restrictionParams = [];
$mode = 1;
$result = ByLocation::checkByEntity($entity, $restrictionParams, $mode);
// $result: int

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

check() Эта функция должна принимать только location CODE, а не ID, являясь частью современного API
delete()
filterServicesArray()
getClassDescription()
getClassTitle()
getCode() Получить код ограничения, сопоставимый с кодом ограничения обработчика службы.
getOnApplyErrorMessage() Возвращает сообщение, которое отображается при возникновении ошибки во время применения ограничения
getParamsStructure() Возвращает структуру параметров для отображения пользователю
getSeverity()
isAvailable()
isMyCode()
prepareData()

checkByEntity() есть и у других классов модуля «Интернет-магазин»: Base, ByConcreteProduct, ByDimensions, ByMaxSize, ByPaySystem, ByPersonType, ByPrice, ByProductCategory.