Bitrix API

WebFormResultsRestriction extends Bitrix24AccessRestriction

Table of Contents

Constants

ERROR_CODE  = 'restriction_web_form_results'
SLIDER_ID  = 'limit_crm_100_form'

Methods

__construct()  : mixed
externalize()  : array<string|int, mixed>
filterRestrictedItemIds()  : array<string|int, mixed>
getErrorCode()  : string|null
getErrorMessage()  : string|null
getFieldsToShow()  : array<string|int, mixed>
getHtml()  : string
getInfoHelperId()  : string
Get id for tariff slider
getMobileInfoHelperId()  : string
Get id for tariff slider in mobile app
getName()  : string
getRestrictedItemIds()  : array<string|int, mixed>
Return list of restricted item Ids of type $entityTypeId
hasPermission()  : bool
internalize()  : void
isItemRestricted()  : bool
Check restriction for single item. Do not use it in cycle.
isLimitReached()  : bool
isPersistent()  : bool
isPersitent()  : bool
load()  : mixed
permit()  : void
prepareDisplayOptions()  : void
prepareFeaturePromoterScript()  : string
prepareInfoHelperScript()  : string
preparePopupScript()  : string
reset()  : mixed
save()  : mixed
setErrorCode()  : void
setErrorMessage()  : void
setName()  : void
setResultsLimit()  : self
setStartDate()  : self

Constants

Methods

__construct()

public __construct([mixed $name = '' ][, mixed $permitted = false ][, array<string|int, mixed> $htmlInfo = null ][, array<string|int, mixed> $popupInfo = null ]) : mixed
Parameters
$name : mixed = ''
$permitted : mixed = false
$htmlInfo : array<string|int, mixed> = null
$popupInfo : array<string|int, mixed> = null

externalize()

public externalize() : array<string|int, mixed>
Return values
array<string|int, mixed>

filterRestrictedItemIds()

public filterRestrictedItemIds(int $entityTypeId, array<string|int, mixed> $itemIds) : array<string|int, mixed>
Parameters
$entityTypeId : int
$itemIds : array<string|int, mixed>
Return values
array<string|int, mixed>

getFieldsToShow()

public getFieldsToShow([array<string|int, mixed> $additionalFields = [] ]) : array<string|int, mixed>
Parameters
$additionalFields : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getMobileInfoHelperId()

Get id for tariff slider in mobile app

public getMobileInfoHelperId() : string
Return values
string

getName()

public getName() : string
Return values
string

getRestrictedItemIds()

Return list of restricted item Ids of type $entityTypeId

public getRestrictedItemIds(int $entityTypeId) : array<string|int, mixed>
Parameters
$entityTypeId : int
Return values
array<string|int, mixed>

internalize()

public internalize(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>

Params

isItemRestricted()

Check restriction for single item. Do not use it in cycle.

public isItemRestricted(ItemIdentifier $identifier) : bool
Parameters
$identifier : ItemIdentifier
Return values
bool

isPersistent()

public isPersistent() : bool
Return values
bool

isPersitent()

public isPersitent() : bool

No longer used by internal code and not recommended. Please use isPersistent.

Return values
bool

permit()

public permit(bool $permitted) : void
Parameters
$permitted : bool

Permission Flag.

prepareDisplayOptions()

public prepareDisplayOptions(int $entityTypeId, array<string|int, mixed> $itemIds, Options $options) : void
Parameters
$entityTypeId : int
$itemIds : array<string|int, mixed>
$options : Options

setName()

public setName(string $name) : void
Parameters
$name : string

Name

setResultsLimit()

public setResultsLimit(int $resultsLimit[, Date|null $startDate = null ]) : self
Parameters
$resultsLimit : int
$startDate : Date|null = null
Return values
self

        
On this page

Search results