Класс Restriction

Граф наследования:Restriction:

Открытые статические члены
static	getClassTitle ()
static	getClassDescription ()
static	getOnApplyErrorMessage ()
static	check ($params, array $restrictionParams, $serviceId=0)
static	checkByEntity (Entity $entity, array $restrictionParams, $mode, $serviceId=0)
static	validateRestriction ($fields)
static	getParamsStructure ($entityId=0)
static	prepareParamsValues (array $paramsValues, $entityId=0)
static	save (array $fields, $restrictionId=0)
static	delete ($restrictionId, $entityId=0)
static	getSeverity ($mode)
static	prepareData (array $servicesIds)
static	isAvailable ()
static	getCode ()
static	isMyCode (string $code)

Статические открытые данные
static	$easeSort = 100

Защищенные статические члены
static	extractParams (Entity $entity)

Подробное описание

См. определение в файле restriction.php строка 16

Методы

check()

static check ( $params, array $restrictionParams, $serviceId = 0 )

static

Checking the service parameters for compliance with the restriction.

To check of the constraint itself, use method self::validateRestriction

Аргументы

mixed	$params	Params to check.
array	$restrictionParams	Restriction params.
int	$serviceId	Service identifier.

Возвращает

bool

Исключения

NotImplementedException

Переопределяется в ConcreteProductRestriction, ProductCategoryRestriction, UserGroupRestriction, Company, PaySystem, TradeBindingRestriction, Currency, Delivery, EntityType, Location, PaySystem, Currency, Delivery, PersonType, Price и SiteRestriction.

См. определение в файле restriction.php строка 69

checkByEntity()

static checkByEntity ( Entity $entity, array $restrictionParams, $mode, $serviceId = 0 )

static

Checking the service parameters for compliance with the restriction by entity.

Аргументы

Entity	$entity
array	$restrictionParams
int	$mode
int	$serviceId

Возвращает

int

Исключения

NotImplementedException

См. определение в файле restriction.php строка 84

delete()

static delete ( $restrictionId, $entityId = 0 )

static

Аргументы

	$restrictionId
int	$entityId

Возвращает

\Bitrix\Main\Entity\DeleteResult

Исключения

Exception

Переопределяется в UserGroupRestriction, Delivery, Location, PaySystem и Delivery.

См. определение в файле restriction.php строка 167

extractParams()

static extractParams ( Entity $entity )

staticprotected

Аргументы

Entity

$entity

Возвращает

mixed

Исключения

NotImplementedException

Переопределяется в Company и UserGroupRestriction.

См. определение в файле restriction.php строка 115

getClassDescription()

static getClassDescription ( )

static

Возвращает

string

Исключения

NotImplementedException

Переопределяется в Company, PaySystem, ByConcreteProduct, ByProductCategory, SiteRestriction, TradeBindingRestriction, UserGroupRestriction, Currency, Delivery, EntityType, Location, PaySystem, ConcreteProduct, Currency, Delivery, PersonType, Price и ProductCategory.

См. определение в файле restriction.php строка 39

getClassTitle()

static getClassTitle ( )

static

Возвращает

string

Исключения

NotImplementedException

Переопределяется в Company, PaySystem, ConcreteProductRestriction, ProductCategoryRestriction, SiteRestriction, TradeBindingRestriction, UserGroupRestriction, Currency, Delivery, EntityType, Location, PaySystem, Currency, Delivery, PersonType и Price.

См. определение в файле restriction.php строка 30

getCode()

static getCode ( )

static

Get a restriction code that is comparable to the service handler restriction code.
Bitrix restrictions will return name of restriction class. Vendor restrictions must return full classname with namespace.

Example 1: for bitrix currency restriction class **Bitrix\Currency** it will return 'currency'
Example 2: for vendor currency restriction class **Vendor\Currency** it will return 'Vendor\Currency'

Возвращает

string

См. определение в файле restriction.php строка 214

getOnApplyErrorMessage()

static getOnApplyErrorMessage ( )

static

Returns message that will be display if error occurs while applying restriction

Возвращает

string

Переопределяется в ConcreteProductRestriction, ProductCategoryRestriction, SiteRestriction, TradeBindingRestriction, UserGroupRestriction, Currency, Delivery, PersonType и Price.

См. определение в файле restriction.php строка 49

getParamsStructure()

static getParamsStructure ( $entityId = 0 )

static

Returns params structure to show it to user

Возвращает

array

Переопределяется в Company, PaySystem, ConcreteProductRestriction, ProductCategoryRestriction, SiteRestriction, TradeBindingRestriction, UserGroupRestriction, Currency, Delivery, EntityType, Location, PaySystem, Delivery, PersonType и Price.

См. определение в файле restriction.php строка 124

getSeverity()

static getSeverity ( $mode )

static

Аргументы

int

$mode

- RestrictionManager::MODE_CLIENT | RestrictionManager::MODE_MANAGER

Возвращает

int

Переопределяется в Company, PaySystem, SiteRestriction, EntityType, PersonType и Price.

См. определение в файле restriction.php строка 176

isAvailable()

static isAvailable ( )

static

Возвращает

bool

Переопределяется в Company, SiteRestriction, TradeBindingRestriction и UserGroupRestriction.

См. определение в файле restriction.php строка 198

isMyCode()

static isMyCode ( string $code )

static

См. определение в файле restriction.php строка 225

prepareData()

static prepareData ( array $servicesIds )

static

Аргументы

array

$servicesIds

Возвращает

bool

Переопределяется в Delivery.

См. определение в файле restriction.php строка 190

prepareParamsValues()

static prepareParamsValues ( array $paramsValues, $entityId = 0 )

static

Аргументы

array	$paramsValues
int	$entityId

Возвращает

array

Переопределяется в UserGroupRestriction, Delivery, PaySystem и Delivery.

См. определение в файле restriction.php строка 134

save()

static save ( array $fields, $restrictionId = 0 )

static

Аргументы

array	$fields
int	$restrictionId

Возвращает

\Bitrix\Main\Entity\AddResult|\Bitrix\Main\Entity\UpdateResult

Исключения

Exception

Переопределяется в UserGroupRestriction, Delivery, Location, PaySystem, Currency и Delivery.

См. определение в файле restriction.php строка 145

validateRestriction()

static validateRestriction ( $fields )

static

Checking the restriction for compliance with business rules.

For example, for the restriction "currency" in this method, you can compare which currencies the payment system works with which the restriction is linked.

Аргументы

array

$fields

restriction fields

Возвращает

Result

См. определение в файле restriction.php строка 105

Данные класса

$easeSort

$easeSort = 100

static

См. определение в файле restriction.php строка 24