Bitrix API

FilterLimit extends Limit

Class FilterLimit

Table of Contents

Constants

DEFAULT_LIMIT  = 100
OPTION_LIMIT_KEY  = '_tasks_restrict_limit_b'

Methods

getFeatureId()  : string
getLimitCode()  : string
getLimitLock()  : string
getLimitLockClick()  : string
getLimitWarningValue()  : int
isLimitExceeded()  : bool
Checks if limit exceeded
isLimitExist()  : bool
Checks if limit exist
isRelatedWithFeature()  : bool
The method checks whether the transferred feature is related to the current limit.
notifyLimitWarning()  : void
prepareStubInfo()  : array<string|int, mixed>|null

Constants

DEFAULT_LIMIT

public mixed DEFAULT_LIMIT = 100

OPTION_LIMIT_KEY

public mixed OPTION_LIMIT_KEY = '_tasks_restrict_limit_b'

Methods

getFeatureId()

public static getFeatureId() : string
Return values
string

getLimitCode()

public static getLimitCode() : string
Return values
string

getLimitLock()

public static getLimitLock(string $featureId[, string|null $bindElement = null ]) : string
Parameters
$featureId : string
$bindElement : string|null = null
Return values
string

getLimitLockClick()

public static getLimitLockClick(string $featureId[, string|null $bindElement = 'this' ][, string|null $analyticsSource = null ]) : string
Parameters
$featureId : string
$bindElement : string|null = 'this'
$analyticsSource : string|null = null
Return values
string

getLimitWarningValue()

public static getLimitWarningValue([int|null $userId = null ]) : int
Parameters
$userId : int|null = null
Tags
throws
ObjectPropertyException
throws
SystemException
Return values
int

isLimitExceeded()

Checks if limit exceeded

public static isLimitExceeded([int $limit = 0 ]) : bool
Parameters
$limit : int = 0
Tags
throws
ObjectPropertyException
throws
SystemException
Return values
bool

isLimitExist()

Checks if limit exist

public static isLimitExist([int $limit = 0 ]) : bool
Parameters
$limit : int = 0
Return values
bool

isRelatedWithFeature()

The method checks whether the transferred feature is related to the current limit.

public static isRelatedWithFeature(string $featureId) : bool

That is, it is responsible for the operation of the same functionality.

Parameters
$featureId : string

Feature id.

Return values
bool

notifyLimitWarning()

public static notifyLimitWarning([int|null $userId = null ][, int $warningCount = 0 ]) : void
Parameters
$userId : int|null = null
$warningCount : int = 0
Tags
throws
LoaderException

prepareStubInfo()

public static prepareStubInfo([array<string|int, mixed>|null $params = null ]) : array<string|int, mixed>|null
Parameters
$params : array<string|int, mixed>|null = null
Return values
array<string|int, mixed>|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results