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

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

 __construct (DataProvider $dataProvider, $id, array $params=null)
 
 getDataProvider ()
 
 setDataProvider (DataProvider $dataProvider)
 
 prepareHtml ()
 
 getId ()
 
 setID ($id)
 
 getName ()
 
 setName ($name)
 
 getType ()
 
 setType ($type)
 
 isDefault ()
 
 markAsDefault ($isDefault)
 
 isPartial ()
 
 getData ()
 
 getDataItem ($key)
 
 getSectionId ()
 
 setSectionId (string $sectionId)
 
 getIconParams ()
 
 setIconParams (array $iconParams)
 
 assemble ()
 
 toArray (array $options=null)
 

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

 prepareData ()
 

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

 $dataProvider = null
 
 $id = ''
 
 $name = ''
 
 $type = ''
 
 $isDefault = false
 
 $data = null
 
 $isPartial = false
 
 $sectionId = ''
 
 $iconParams = []
 

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

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

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

◆ __construct()

__construct ( DataProvider $dataProvider,
$id,
array $params = null )

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

Методы

◆ assemble()

assemble ( )

Assemble field data. This method will complete initialization of partially initialized field.

Возвращает
void

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

◆ getData()

getData ( )

Get Field Data.

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

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

◆ getDataItem()

getDataItem ( $key)

Get Data Item by key.

Аргументы
string$keyData Item Key.
Возвращает
mixed|null

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

◆ getDataProvider()

getDataProvider ( )

Get Data Provider.

Возвращает
DataProvider

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

◆ getIconParams()

getIconParams ( )

Get field icon url and title

Возвращает
array

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

◆ getId()

getId ( )

Get Field ID.

Возвращает
string

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

◆ getName()

getName ( )

Get localized name.

Возвращает
string

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

◆ getSectionId()

getSectionId ( )

Get field section id

Возвращает
string

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

◆ getType()

getType ( )

Get Field Type.

Возвращает
string

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

◆ isDefault()

isDefault ( )

Check if default field.

Возвращает
bool

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

◆ isPartial()

isPartial ( )

Check if partial field. Partial Field does not have data. Field is not completely initialized. You may call "assemble" to load required data in it.

Возвращает
bool

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

◆ markAsDefault()

markAsDefault ( $isDefault)

Mark Field as default.

Аргументы
bool$isDefaultDefault Field Flag.

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

◆ prepareData()

prepareData ( )
protected

Prepare complete field data for field.

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

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

◆ prepareHtml()

prepareHtml ( )

Prepare Field additional HTML.

Возвращает
string

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

◆ setDataProvider()

setDataProvider ( DataProvider $dataProvider)

Set Data Provider.

Аргументы
DataProvider$dataProviderData Provider.

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

◆ setIconParams()

setIconParams ( array $iconParams)

Set field icon url and title

Аргументы
array$iconParams

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

◆ setID()

setID ( $id)

Set Field ID.

Аргументы
string$idField ID.

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

◆ setName()

setName ( $name)

Set localized name.

Аргументы
string$nameField Name.

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

◆ setSectionId()

setSectionId ( string $sectionId)

Set field section id

Аргументы
string$sectionId

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

◆ setType()

setType ( $type)

Set Field Type.

Аргументы
string$typeField Type Name.

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

◆ toArray()

toArray ( array $options = null)

Put Field Parameters in array.

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

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

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

◆ $data

$data = null
protected

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

◆ $dataProvider

$dataProvider = null
protected

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

◆ $iconParams

$iconParams = []
protected

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

◆ $id

$id = ''
protected

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

◆ $isDefault

$isDefault = false
protected

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

◆ $isPartial

$isPartial = false
protected

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

◆ $name

$name = ''
protected

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

◆ $sectionId

$sectionId = ''
protected

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

◆ $type

$type = ''
protected

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