Bitrix API

ConfigurationOption

Table of Contents

Constants

GROUP_ADDITIONAL  = 1
GROUP_DEFAULT  = 0
TYPE_AUDIO  = 'audio'
TYPE_CHECKBOX  = 'checkbox'
TYPE_CONSENT  = 'user-consent'
TYPE_CONSENT_CONTENT  = 'user-consent-content'
TYPE_CUSTOM  = 'custom'
TYPE_DATE_TIME  = 'datetime'
TYPE_EMAIL  = 'email'
TYPE_FILE  = 'file'
TYPE_HTML  = 'html'
TYPE_LIST  = 'list'
TYPE_MAIL_EDITOR  = 'mail-editor'
TYPE_NUMBER  = 'number'
TYPE_PRESET_STRING  = 'preset-string'
TYPE_SMS_EDITOR  = 'sms-editor'
TYPE_STRING  = 'string'
TYPE_TEMPLATE_ID  = 'template-id'
TYPE_TEMPLATE_TYPE  = 'template-type'
TYPE_TEXT  = 'text'
TYPE_TIME  = 'time'
TYPE_TITLE  = 'title'
TYPE_USER_LIST  = 'user-list'

Methods

__construct()  : mixed
Configuration constructor.
getArray()  : array<string|int, mixed>
Get as array.
getCode()  : string
Get code.
getGroup()  : int
Get group.
getHint()  : null|string|array<string|int, mixed>
Get hint.
getItems()  : array<string|int, mixed>
Get items.
getMaxLength()  : int
getMaxValue()  : int
getMinValue()  : int
getName()  : string
Get name.
getReadonlyView()  : mixed
Get readonly view.
getShowHelper()  : bool
getShowInFilter()  : bool
Get show in filter or not.
getShowInList()  : bool
Get show in list or not.
getShowPreview()  : bool
getType()  : string
Get type.
getValue()  : string|array<string|int, mixed>
Get value.
getView()  : string|callable
Get view.
hasValue()  : bool
Has value.
isRequired()  : bool
Is required.
isTemplated()  : bool
Is templated.
setCode()  : void
Set code.
setGroup()  : void
Set value.
setHint()  : void
Set required.
setItems()  : void
Set items.
setMaxLength()  : mixed
setMaxValue()  : ConfigurationOption
setMinValue()  : ConfigurationOption
setName()  : void
Set name.
setReadonlyView()  : void
Set readonly view callback.
setRequired()  : void
Set required.
setShowHelper()  : ConfigurationOption
setShowInFilter()  : void
Set show in list or not.
setShowInList()  : void
Set show in list or not.
setShowPreview()  : ConfigurationOption
setTemplated()  : void
Set required.
setType()  : void
Set type.
setValue()  : void
Set value.
setView()  : void
Set view.

Constants

Methods

__construct()

Configuration constructor.

public __construct([array<string|int, mixed> $data = [] ]) : mixed
Parameters
$data : array<string|int, mixed> = []

Data.

getArray()

Get as array.

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

getHint()

Get hint.

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

getItems()

Get items.

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

getReadonlyView()

Get readonly view.

public getReadonlyView(mixed $value) : mixed
Parameters
$value : mixed

Option value

getShowInFilter()

Get show in filter or not.

public getShowInFilter() : bool
Return values
bool

getShowInList()

Get show in list or not.

public getShowInList() : bool
Return values
bool

getValue()

Get value.

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

getView()

Get view.

public getView() : string|callable
Return values
string|callable

setCode()

Set code.

public setCode(string $code) : void
Parameters
$code : string

Code.

setGroup()

Set value.

public setGroup(int $group) : void
Parameters
$group : int

Group.

setHint()

Set required.

public setHint(null|string|array<string|int, mixed> $hint) : void
Parameters
$hint : null|string|array<string|int, mixed>

Hint.

setItems()

Set items.

public setItems(array<string|int, mixed> $items) : void
Parameters
$items : array<string|int, mixed>

Items.

setMaxLength()

public setMaxLength(int $maxLength) : mixed
Parameters
$maxLength : int

setName()

Set name.

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

Name.

setReadonlyView()

Set readonly view callback.

public setReadonlyView(callable|null $readonlyView) : void
Parameters
$readonlyView : callable|null

Readonly view callback.

setRequired()

Set required.

public setRequired(bool $required) : void
Parameters
$required : bool

Required.

setShowInFilter()

Set show in list or not.

public setShowInFilter(bool $showInFilter) : void
Parameters
$showInFilter : bool

Show in filter.

setShowInList()

Set show in list or not.

public setShowInList(bool $showInList) : void
Parameters
$showInList : bool

Show in items list.

setTemplated()

Set required.

public setTemplated(bool $templated) : void
Parameters
$templated : bool

Templated.

setType()

Set type.

public setType(string $type) : void
Parameters
$type : string

Type.

setValue()

Set value.

public setValue(string|array<string|int, mixed> $value) : void
Parameters
$value : string|array<string|int, mixed>

Value.

setView()

Set view.

public setView(string|callable $view) : void
Parameters
$view : string|callable

View.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results