Bitrix API

Filter

Table of Contents

Constants

MAX_YEAR  = 9999
MIN_YEAR  = 1000

Methods

__construct()  : mixed
addDateType()  : mixed
convertPeriodFromDateType()  : mixed
Convert System Date Type to Widget Period.
externalizeParams()  : array<string|int, mixed>
getContextEntityID()  : string
getContextEntityTypeName()  : string
getDateType()  : mixed
getEnd()  : mixed
getExtraParam()  : mixed
Get extra parameter value.
getExtras()  : array<string|int, mixed>
Get extra parameters.
getMonth()  : int
getParams()  : array<string|int, mixed>
getPeriod()  : array<string|int, mixed>
getPeriodTypeID()  : string
getQuarter()  : int
getResponsibleIDs()  : mixed
getStart()  : mixed
getYear()  : int
internalizeParams()  : array<string|int, mixed>
isEmpty()  : bool
merge()  : void
Merge params of two filters.
removeExtraParam()  : void
Remove extra parameter.
sanitizeParams()  : void
Sanitize parameter array (before pass in constructor)
setContextEntityID()  : mixed
setContextEntityTypeName()  : mixed
setEnd()  : mixed
setEndFromPeriod()  : mixed
setExtraParam()  : void
Set extra parameter value.
setExtras()  : void
Setup extra parameters.
setMonth()  : void
setPeriodTypeID()  : mixed
setQuarter()  : void
setResponsibleIDs()  : void
setStart()  : mixed
setStartFromPeriod()  : mixed
setYear()  : void

Constants

MAX_YEAR

public mixed MAX_YEAR = 9999

MIN_YEAR

public mixed MIN_YEAR = 1000

Methods

__construct()

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

addDateType()

public static addDateType(array<string|int, mixed> &$filter, mixed $fieldName, mixed $dateType) : mixed
Parameters
$filter : array<string|int, mixed>
$fieldName : mixed
$dateType : mixed

convertPeriodFromDateType()

Convert System Date Type to Widget Period.

public static convertPeriodFromDateType(array<string|int, mixed> &$filter, string $fieldName) : mixed
Parameters
$filter : array<string|int, mixed>

Source Filter.

$fieldName : string

Period Field Name.

externalizeParams()

public static externalizeParams(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

getContextEntityID()

public getContextEntityID() : string
Return values
string

getContextEntityTypeName()

public getContextEntityTypeName() : string
Return values
string

getDateType()

public static getDateType(array<string|int, mixed> &$filter, mixed $fieldName) : mixed
Parameters
$filter : array<string|int, mixed>
$fieldName : mixed

getEnd()

public getEnd() : mixed

getExtraParam()

Get extra parameter value.

public getExtraParam(string $name, mixed $defaultValue) : mixed
Parameters
$name : string

Parameter name.

$defaultValue : mixed

Default value.

getExtras()

Get extra parameters.

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

getMonth()

public getMonth() : int
Return values
int

getParams()

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

getPeriod()

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

getPeriodTypeID()

public getPeriodTypeID() : string
Return values
string

getQuarter()

public getQuarter() : int
Return values
int

getResponsibleIDs()

public getResponsibleIDs() : mixed

getStart()

public getStart() : mixed

getYear()

public getYear() : int
Return values
int

internalizeParams()

public static internalizeParams(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>
Return values
array<string|int, mixed>

isEmpty()

public isEmpty() : bool
Return values
bool

merge()

Merge params of two filters.

public static merge(Filter $seed, Filter $target[, array<string|int, mixed> $options = null ]) : void

If parameter is absent in target filter it will be copied from seed filter.

Parameters
$seed : Filter

Seed (is source filter).

$target : Filter

Target (is target filter).

$options : array<string|int, mixed> = null

Options array.

removeExtraParam()

Remove extra parameter.

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

Parameter name.

sanitizeParams()

Sanitize parameter array (before pass in constructor)

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

Parameter array.

setContextEntityID()

public setContextEntityID(int $entityID) : mixed
Parameters
$entityID : int

setContextEntityTypeName()

public setContextEntityTypeName(string $entityTypeName) : mixed
Parameters
$entityTypeName : string

setEnd()

public setEnd([Date $date = null ]) : mixed
Parameters
$date : Date = null

setEndFromPeriod()

public setEndFromPeriod(array<string|int, mixed> $period) : mixed
Parameters
$period : array<string|int, mixed>

setExtraParam()

Set extra parameter value.

public setExtraParam(string $name, mixed $value) : void
Parameters
$name : string

Parameter name.

$value : mixed

Parameter value.

setExtras()

Setup extra parameters.

public setExtras(array<string|int, mixed> $extras) : void
Parameters
$extras : array<string|int, mixed>

Parameters.

setMonth()

public setMonth(mixed $month) : void
Parameters
$month : mixed

setPeriodTypeID()

public setPeriodTypeID(mixed $periodTypeID) : mixed
Parameters
$periodTypeID : mixed

setQuarter()

public setQuarter(mixed $quarter) : void
Parameters
$quarter : mixed

setResponsibleIDs()

public setResponsibleIDs(array<string|int, mixed> $responsibleIDs) : void
Parameters
$responsibleIDs : array<string|int, mixed>

setStart()

public setStart([Date $date = null ]) : mixed
Parameters
$date : Date = null

setStartFromPeriod()

public setStartFromPeriod(array<string|int, mixed> $period) : mixed
Parameters
$period : array<string|int, mixed>

setYear()

public setYear(mixed $year) : void
Parameters
$year : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results