Bitrix API

Field

Class Field.

Metadata of question field in form.

Table of Contents

Constants

TYPE_AGE  = 'AGE'
TYPE_BIRTHDAY  = 'BIRTHDAY'
TYPE_CC  = 'CC'
TYPE_CHECKBOX  = 'checkbox'
TYPE_CI  = 'CI'
TYPE_COMPANY_NAME  = 'COMPANY_NAME'
TYPE_CONDITION_QUESTION  = 'condition'
TYPE_CPF  = 'CPF'
TYPE_DATE_TIME  = 'date'
TYPE_DNI_ARGENTINA  = 'DNI_AR'
TYPE_DNI_PERU  = 'DNI_PE'
TYPE_EMAIL  = 'EMAIL'
TYPE_FULL_NAME  = 'FULL_NAME'
TYPE_GENDER  = 'GENDER'
TYPE_INPUT  = 'input'
TYPE_JOB_TITLE  = 'JOB_TITLE'
TYPE_LAST_NAME  = 'LAST_NAME'
TYPE_LOCATION_CITY  = 'CITY'
TYPE_LOCATION_COUNTRY  = 'COUNTRY'
TYPE_LOCATION_FULL  = 'LOCATION'
TYPE_LOCATION_STATE  = 'STATE'
TYPE_LOCATION_STREET_ADDRESS  = 'ADDRESS'
TYPE_LOCATION_ZIP  = 'ZIP'
TYPE_MARITIAL_STATUS  = 'MARITIAL_STATUS'
TYPE_MILITARY_STATUS  = 'MILITARY_STATUS'
TYPE_NAME  = 'NAME'
TYPE_PATRONYMIC_NAME  = 'PATRONYMIC_NAME'
TYPE_PHONE  = 'PHONE'
TYPE_RADIO  = 'radio'
TYPE_RELATIONSHIP_STATUS  = 'RELATIONSHIP_STATUS'
TYPE_RUT  = 'RUT'
TYPE_SELECT  = 'select'
TYPE_TEXT_AREA  = 'textarea'
TYPE_WORK_EMAIL  = 'WORK_EMAIL'
TYPE_WORK_PHONE  = 'WORK_PHONE'

Methods

__construct()  : mixed
Field constructor.
addOption()  : $this
Add option.
getKey()  : null|string
Get key.
getLabel()  : null|string
Get label.
getName()  : string|null
Get name.
getOptions()  : array<string|int, mixed>
Get options.
getType()  : string
Get type.
getTypes()  : array<string|int, string>
setOptions()  : $this
Set options.
toArray()  : array<string|int, mixed>
Convert to array.

Constants

TYPE_AGE

public mixed TYPE_AGE = 'AGE'

TYPE_BIRTHDAY

public mixed TYPE_BIRTHDAY = 'BIRTHDAY'

TYPE_CC

public mixed TYPE_CC = 'CC'

TYPE_CHECKBOX

public mixed TYPE_CHECKBOX = 'checkbox'

TYPE_CI

public mixed TYPE_CI = 'CI'

TYPE_COMPANY_NAME

public mixed TYPE_COMPANY_NAME = 'COMPANY_NAME'

TYPE_CONDITION_QUESTION

public mixed TYPE_CONDITION_QUESTION = 'condition'

TYPE_CPF

public mixed TYPE_CPF = 'CPF'

TYPE_DATE_TIME

public mixed TYPE_DATE_TIME = 'date'

TYPE_DNI_ARGENTINA

public mixed TYPE_DNI_ARGENTINA = 'DNI_AR'

TYPE_DNI_PERU

public mixed TYPE_DNI_PERU = 'DNI_PE'

TYPE_EMAIL

public mixed TYPE_EMAIL = 'EMAIL'

TYPE_FULL_NAME

public mixed TYPE_FULL_NAME = 'FULL_NAME'

TYPE_GENDER

public mixed TYPE_GENDER = 'GENDER'

TYPE_INPUT

public mixed TYPE_INPUT = 'input'

TYPE_JOB_TITLE

public mixed TYPE_JOB_TITLE = 'JOB_TITLE'

TYPE_LAST_NAME

public mixed TYPE_LAST_NAME = 'LAST_NAME'

TYPE_LOCATION_CITY

public mixed TYPE_LOCATION_CITY = 'CITY'

TYPE_LOCATION_COUNTRY

public mixed TYPE_LOCATION_COUNTRY = 'COUNTRY'

TYPE_LOCATION_FULL

public mixed TYPE_LOCATION_FULL = 'LOCATION'

TYPE_LOCATION_STATE

public mixed TYPE_LOCATION_STATE = 'STATE'

TYPE_LOCATION_STREET_ADDRESS

public mixed TYPE_LOCATION_STREET_ADDRESS = 'ADDRESS'

TYPE_LOCATION_ZIP

public mixed TYPE_LOCATION_ZIP = 'ZIP'

TYPE_MARITIAL_STATUS

public mixed TYPE_MARITIAL_STATUS = 'MARITIAL_STATUS'

TYPE_MILITARY_STATUS

public mixed TYPE_MILITARY_STATUS = 'MILITARY_STATUS'

TYPE_NAME

public mixed TYPE_NAME = 'NAME'

TYPE_PATRONYMIC_NAME

public mixed TYPE_PATRONYMIC_NAME = 'PATRONYMIC_NAME'

TYPE_PHONE

public mixed TYPE_PHONE = 'PHONE'

TYPE_RADIO

public mixed TYPE_RADIO = 'radio'

TYPE_RELATIONSHIP_STATUS

public mixed TYPE_RELATIONSHIP_STATUS = 'RELATIONSHIP_STATUS'

TYPE_RUT

public mixed TYPE_RUT = 'RUT'

TYPE_SELECT

public mixed TYPE_SELECT = 'select'

TYPE_TEXT_AREA

public mixed TYPE_TEXT_AREA = 'textarea'

TYPE_WORK_EMAIL

public mixed TYPE_WORK_EMAIL = 'WORK_EMAIL'

TYPE_WORK_PHONE

public mixed TYPE_WORK_PHONE = 'WORK_PHONE'

Methods

__construct()

Field constructor.

public __construct([string $type = self::TYPE_INPUT ][, string|null $name = null ][, string|null $label = null ][, string|null $key = null ][, array<string|int, array<string, string>> $options = [] ]) : mixed
Parameters
$type : string = self::TYPE_INPUT

Type.

$name : string|null = null
$label : string|null = null

Label.

$key : string|null = null

Key.

$options : array<string|int, array<string, string>> = []

addOption()

Add option.

public addOption(string $key, string $label) : $this
Parameters
$key : string

Key.

$label : string

Label.

Return values
$this

getKey()

Get key.

public getKey() : null|string
Return values
null|string

getLabel()

Get label.

public getLabel() : null|string
Return values
null|string

getName()

Get name.

public getName() : string|null
Return values
string|null

getOptions()

Get options.

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

getType()

Get type.

public getType() : string
Return values
string

getTypes()

public static getTypes() : array<string|int, string>
Return values
array<string|int, string>

setOptions()

Set options.

public setOptions(array<string|int, array<string, string>> $options) : $this
Parameters
$options : array<string|int, array<string, string>>

Options.

Return values
$this

toArray()

Convert to array.

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results