Bitrix API

Field

Class Field

Table of Contents

Methods

custom()  : array<string|int, mixed>
Prepares data of custom field
customDate()  : mixed
customEntity()  : array<string|int, mixed>
Prepares data of custom_entity field
date()  : array<string|int, mixed>
Prepares data of date field
destSelector()  : array<string|int, mixed>
Prepares data of user field
entitySelector()  : mixed
multiSelect()  : array<string|int, mixed>
Prepares data of multiselect field
number()  : array<string|int, mixed>
Prepares data of number field
select()  : array<string|int, mixed>
Prepares data of select field
string()  : array<string|int, mixed>
Prepares data of string field
textarea()  : array<string|int, mixed>

Methods

custom()

Prepares data of custom field

public static custom(string $name, string $value[, string $label = "" ][, string $placeholder = "" ][, bool $style = false ]) : array<string|int, mixed>
Parameters
$name : string
$value : string
$label : string = ""
$placeholder : string = ""
$style : bool = false
Return values
array<string|int, mixed>

customDate()

public static customDate([mixed $options = array() ]) : mixed
Parameters
$options : mixed = array()

customEntity()

Prepares data of custom_entity field

public static customEntity(string $name[, string $label = "" ][, string $placeholder = "" ][, bool $multiple = false ]) : array<string|int, mixed>
Parameters
$name : string
$label : string = ""
$placeholder : string = ""
$multiple : bool = false
Return values
array<string|int, mixed>

date()

Prepares data of date field

public static date(string $name[, string $type = DateType::NONE ][, array<string|int, mixed> $values = [] ][, string $label = "" ][, string $placeholder = "" ][, bool $enableTime = false ][, array<string|int, mixed> $exclude = [] ][, array<string|int, mixed> $include = [] ][, bool $allowYearsSwithcer = false ][, array<string|int, mixed> $messages = [] ]) : array<string|int, mixed>
Parameters
$name : string
$type : string = DateType::NONE
$values : array<string|int, mixed> = []
$label : string = ""
$placeholder : string = ""
$enableTime : bool = false
$exclude : array<string|int, mixed> = []
$include : array<string|int, mixed> = []
$allowYearsSwithcer : bool = false
$messages : array<string|int, mixed> = []
Return values
array<string|int, mixed>

destSelector()

Prepares data of user field

public static destSelector(string $name[, string $label = "" ][, string $placeholder = "" ][, bool $multiple = false ][, array<string|int, mixed> $params = array() ][, bool $lightweight = false ][, mixed $filterName = '' ]) : array<string|int, mixed>
Parameters
$name : string
$label : string = ""
$placeholder : string = ""
$multiple : bool = false
$params : array<string|int, mixed> = array()
$lightweight : bool = false
$filterName : mixed = ''
Return values
array<string|int, mixed>

entitySelector()

public static entitySelector(string $name[, string $label = '' ][, string $placeholder = '' ][, array<string|int, mixed> $params = [] ][, string $filterName = '' ]) : mixed
Parameters
$name : string
$label : string = ''
$placeholder : string = ''
$params : array<string|int, mixed> = []
$filterName : string = ''

multiSelect()

Prepares data of multiselect field

public static multiSelect(string $name, array<string|int, mixed> $items[, array<string|int, mixed> $defaultValues = array() ][, string $label = "" ][, string $placeholder = "" ]) : array<string|int, mixed>
Parameters
$name : string
$items : array<string|int, mixed>
$defaultValues : array<string|int, mixed> = array()
$label : string = ""
$placeholder : string = ""
Return values
array<string|int, mixed>

number()

Prepares data of number field

public static number(string $name[, string $type = NumberType::SINGLE ][, array<string|int, mixed> $values = [] ][, string $label = "" ][, string $placeholder = "" ][, mixed $exclude = [] ][, mixed $include = [] ][, mixed $messages = [] ]) : array<string|int, mixed>
Parameters
$name : string
$type : string = NumberType::SINGLE
$values : array<string|int, mixed> = []
$label : string = ""
$placeholder : string = ""
$exclude : mixed = []
$include : mixed = []
$messages : mixed = []
Return values
array<string|int, mixed>

select()

Prepares data of select field

public static select(string $name, array<string|int, mixed> $items[, array<string|int, mixed> $defaultValue = array() ][, string $label = "" ][, string $placeholder = "" ]) : array<string|int, mixed>
Parameters
$name : string
$items : array<string|int, mixed>
$defaultValue : array<string|int, mixed> = array()
$label : string = ""
$placeholder : string = ""
Return values
array<string|int, mixed>

string()

Prepares data of string field

public static string(string $name[, string $defaultValue = "" ][, string $label = "" ][, string $placeholder = "" ]) : array<string|int, mixed>
Parameters
$name : string
$defaultValue : string = ""
$label : string = ""
$placeholder : string = ""
Return values
array<string|int, mixed>

textarea()

public static textarea(string $name[, string $defaultValue = "" ][, string $label = "" ][, string $placeholder = "" ]) : array<string|int, mixed>
Parameters
$name : string
$defaultValue : string = ""
$label : string = ""
$placeholder : string = ""
Return values
array<string|int, mixed>

        
On this page

Search results