Bitrix API

DateField extends DatasetField

Table of Contents

Methods

__construct()  : mixed
getCode()  : string
Return field code
getFormatted()  : array<string|int, mixed>
Return prepared fields
setCallback()  : $this
Set separator for concatenation field values. It`s comma by default
setDataset()  : $this
setDescription()  : $this
Set field description
setDescriptionFull()  : $this
Set field description
setJoin()  : $this
setMetric()  : $this
Mark field as metric. It`s false by default
setMultiple()  : $this
Mark field as multiple for concatenation field values. It`s false by default
setName()  : $this
Add custom selection name
setPrimary()  : $this
Mark field as primary. It`s false by default.
setSeparator()  : $this
Set separator for concatenation field values. It`s comma by default
setSystem()  : $this
Mark field as `system` to differentiate from user fields. It`s true by default.

Methods

__construct()

public __construct(string $code[, string|null $name = null ][, Dataset|null $dataset = null ]) : mixed
Parameters
$code : string
$name : string|null = null
$dataset : Dataset|null = null

getCode()

Return field code

public getCode() : string
Return values
string

getFormatted()

Return prepared fields

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

setCallback()

Set separator for concatenation field values. It`s comma by default

public setCallback(callable $callback) : $this
Parameters
$callback : callable
Return values
$this

setDescription()

Set field description

public setDescription(string $description) : $this
Parameters
$description : string
Return values
$this

setDescriptionFull()

Set field description

public setDescriptionFull(string $descriptionFull) : $this
Parameters
$descriptionFull : string
Return values
$this

setMetric()

Mark field as metric. It`s false by default

public setMetric([bool $metric = true ]) : $this
Parameters
$metric : bool = true
Return values
$this

setMultiple()

Mark field as multiple for concatenation field values. It`s false by default

public setMultiple([bool $multiple = true ]) : $this
Parameters
$multiple : bool = true
Return values
$this

setName()

Add custom selection name

public setName(string $name) : $this
Parameters
$name : string
Return values
$this

setPrimary()

Mark field as primary. It`s false by default.

public setPrimary([bool $isPrimary = true ]) : $this
Parameters
$isPrimary : bool = true
Return values
$this

setSeparator()

Set separator for concatenation field values. It`s comma by default

public setSeparator(string $separator) : $this
Parameters
$separator : string
Return values
$this

setSystem()

Mark field as `system` to differentiate from user fields. It`s true by default.

public setSystem([bool $isSystem = true ]) : $this
Parameters
$isSystem : bool = true
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results