Bitrix API

Configuration

Table of Contents

Methods

__construct()  : mixed
Configuration constructor.
addOption()  : void
Add option.
checkOptions()  : Result
Check options.
convertToArray()  : array<string|int, mixed>
Convert to array.
get()  : mixed
Get.
getArrayOptions()  : array<string|int, mixed>
Get Array options.
getId()  : int|string|null
Get ID.
getOption()  : ConfigurationOption|null
Get option.
getOptionByType()  : ConfigurationOption|null
Get options of type.
getOptions()  : array<string|int, ConfigurationOption>
Get options.
getOptionsByGroup()  : array<string|int, ConfigurationOption>
Get options by group.
getOptionsByType()  : array<string|int, ConfigurationOption>
Get options by type.
getReadonlyView()  : mixed
Get value.
getTemplatedOption()  : ConfigurationOption
Get templated option.
getView()  : string|null
Get view.
hasOptions()  : bool
Has options.
hasOptionsOfType()  : bool
Has options of type.
hasTemplatedOption()  : bool
Has templated option.
set()  : mixed
Set.
setArrayOptions()  : void
Set array options.
setId()  : mixed
Set ID.
setView()  : mixed
Set view.

Methods

__construct()

Configuration constructor.

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

Data.

addOption()

Add option.

public addOption(ConfigurationOption $option[, string $targetOptionCode = null ][, bool $isInsertAfter = true ]) : void
Parameters
$option : ConfigurationOption

Option.

$targetOptionCode : string = null

Target option code.

$isInsertAfter : bool = true

Is insert after.

Tags
throws
ArgumentException

checkOptions()

Check options.

public checkOptions() : Result
Return values
Result

convertToArray()

Convert to array.

public static convertToArray(array<string|int, ConfigurationOption> $options) : array<string|int, mixed>
Parameters
$options : array<string|int, ConfigurationOption>

Options.

Return values
array<string|int, mixed>

get()

Get.

public get(string $key[, mixed $defaultValue = null ]) : mixed
Parameters
$key : string

Key

$defaultValue : mixed = null

Default value.

getArrayOptions()

Get Array options.

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

getId()

Get ID.

public getId() : int|string|null
Return values
int|string|null

getReadonlyView()

Get value.

public getReadonlyView(string $key[, mixed $defaultValue = null ]) : mixed
Parameters
$key : string

Key.

$defaultValue : mixed = null

Default value.

getView()

Get view.

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

hasOptions()

Has options.

public hasOptions() : bool
Return values
bool

hasOptionsOfType()

Has options of type.

public hasOptionsOfType(string $type) : bool
Parameters
$type : string

Type.

Return values
bool

hasTemplatedOption()

Has templated option.

public hasTemplatedOption() : bool
Return values
bool

set()

Set.

public set(mixed $key, mixed $value) : mixed
Parameters
$key : mixed
$value : mixed

setArrayOptions()

Set array options.

public setArrayOptions(array<string|int, mixed> $options) : void
Parameters
$options : array<string|int, mixed>

Options.

setId()

Set ID.

public setId(int|string|null $id) : mixed
Parameters
$id : int|string|null

ID.

setView()

Set view.

public setView(callable $view) : mixed
Parameters
$view : callable

View.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results