Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Класс Configuration

Открытые члены

 __construct (array $data=[])
 
 getId ()
 
 setId ($id)
 
 getView ()
 
 setView ($view)
 
 set ($key, $value)
 
 get ($key, $defaultValue=null)
 
 getReadonlyView ($key, $defaultValue=null)
 
 getOption ($key)
 
 hasOptions ()
 
 getOptions ()
 
 getArrayOptions ()
 
 addOption (ConfigurationOption $option, $targetOptionCode=null, $isInsertAfter=true)
 
 setArrayOptions (array $options)
 
 getTemplatedOption ()
 
 hasTemplatedOption ()
 
 getOptionsByGroup ($group)
 
 getOptionsByType ($type)
 
 getOptionByType ($type)
 
 hasOptionsOfType ($type)
 
 checkOptions ()
 

Открытые статические члены

static convertToArray (array $options)
 

Защищенные члены

 checkRequiredOptions (Result $result=null)
 

Защищенные данные

 $id
 
 $data = []
 
 $view
 
 $options = []
 

Подробное описание

См. определение в файле configuration.php строка 18

Конструктор(ы)

◆ __construct()

__construct ( array $data = [])

Configuration constructor.

Аргументы
array$dataData.

См. определение в файле configuration.php строка 37

Методы

◆ addOption()

addOption ( ConfigurationOption $option,
$targetOptionCode = null,
$isInsertAfter = true )

Add option.

Аргументы
ConfigurationOption$optionOption.
string$targetOptionCodeTarget option code.
bool$isInsertAfterIs insert after.
Возвращает
void
Исключения
ArgumentException

См. определение в файле configuration.php строка 246

◆ checkOptions()

checkOptions ( )

Check options.

Возвращает
Result

См. определение в файле configuration.php строка 390

◆ checkRequiredOptions()

checkRequiredOptions ( Result $result = null)
protected

Check required options.

Аргументы
Result$resultResult.
Возвращает
Result

См. определение в файле configuration.php строка 404

◆ convertToArray()

static convertToArray ( array $options)
static

Convert to array.

Аргументы
ConfigurationOption[]$optionsOptions.
Возвращает
array

См. определение в файле configuration.php строка 226

◆ get()

get ( $key,
$defaultValue = null )

Get.

Аргументы
string$keyKey
mixed$defaultValueDefault value.
Возвращает
mixed

См. определение в файле configuration.php строка 116

◆ getArrayOptions()

getArrayOptions ( )

Get Array options.

Возвращает
array

См. определение в файле configuration.php строка 215

◆ getId()

getId ( )

Get ID.

Возвращает
int|string|null

См. определение в файле configuration.php строка 50

◆ getOption()

getOption ( $key)

Get option.

Аргументы
$key
Возвращает
ConfigurationOption|null

См. определение в файле configuration.php строка 177

◆ getOptionByType()

getOptionByType ( $type)

Get options of type.

Аргументы
string$typeType.
Возвращает
ConfigurationOption|null

См. определение в файле configuration.php строка 369

◆ getOptions()

getOptions ( )

Get options.

Возвращает
ConfigurationOption[]

См. определение в файле configuration.php строка 205

◆ getOptionsByGroup()

getOptionsByGroup ( $group)

Get options by group.

Аргументы
integer$groupGroup.
Возвращает
ConfigurationOption[]

См. определение в файле configuration.php строка 329

◆ getOptionsByType()

getOptionsByType ( $type)

Get options by type.

Аргументы
string$typeType.
Возвращает
ConfigurationOption[]

См. определение в файле configuration.php строка 349

◆ getReadonlyView()

getReadonlyView ( $key,
$defaultValue = null )

Get value.

Аргументы
string$keyKey.
mixed$defaultValueDefault value.
Возвращает
mixed

this decision was made after analysing ConfigurationOption class

См. определение в файле configuration.php строка 144

◆ getTemplatedOption()

getTemplatedOption ( )

Get templated option.

Возвращает
ConfigurationOption

См. определение в файле configuration.php строка 300

◆ getView()

getView ( )

Get view.

Возвращает
string|null

См. определение в файле configuration.php строка 70

◆ hasOptions()

hasOptions ( )

Has options.

Возвращает
boolean

См. определение в файле configuration.php строка 195

◆ hasOptionsOfType()

hasOptionsOfType ( $type)

Has options of type.

Аргументы
string$typeType.
Возвращает
bool

См. определение в файле configuration.php строка 380

◆ hasTemplatedOption()

hasTemplatedOption ( )

Has templated option.

Возвращает
bool

См. определение в файле configuration.php строка 318

◆ set()

set ( $key,
$value )

Set.

Аргументы
$key
$value
Возвращает
mixed

См. определение в файле configuration.php строка 97

◆ setArrayOptions()

setArrayOptions ( array $options)

Set array options.

Аргументы
array$optionsOptions.
Возвращает
void

См. определение в файле configuration.php строка 287

◆ setId()

setId ( $id)

Set ID.

Аргументы
int | string | null$idID.

См. определение в файле configuration.php строка 60

◆ setView()

setView ( $view)

Set view.

Аргументы
callable$viewView.

См. определение в файле configuration.php строка 85

Данные класса

◆ $data

$data = []
protected

См. определение в файле configuration.php строка 24

◆ $id

$id
protected

См. определение в файле configuration.php строка 21

◆ $options

$options = []
protected

См. определение в файле configuration.php строка 30

◆ $view

$view
protected

См. определение в файле configuration.php строка 27