Версия: 5.x
Класс UserFieldsManager

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

Класс работает с формами, в которых есть дополнительные(установленные в конфигурации) поля.

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

 __construct ($structure, $values=null, $field=null)
 
 setField ($field)
 
 getField ()
 
 notEmpty ()
 
 getStructure ()
 
 setDefaults ()
 
 setValues ($values)
 
 getValues ()
 
 check ($data=null)
 
 setArrayWrapper ($name)
 
 getArrayWrapper ()
 
 setErrorPrefix ($prefix)
 
 getErrors ()
 
 getFieldName ($key)
 
 getForm ($key, $template=null)
 
 textView ($key)
 
 getErrorForm ($key)
 
 parseValueList ($str)
 
 getAdminForm ($before_phrase= '')
 

Поля данных

const TYPE_LIST = 'list'
 
const TYPE_BOOL = 'bool'
 
const TYPE_STRING = 'string'
 
const TYPE_TEXT = 'text'
 
 $list_delimiter = ','
 
 $admin_tpl = '%SYSTEM%/admin/userfields.tpl'
 
 $tpl = '%SYSTEM%/coreobject/userform.tpl'
 
 $arr_wrap
 
 $structure
 
 $error_prefix = ''
 
 $errors = array()
 
 $values = array()
 

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

__construct (   $structure,
  $values = null,
  $field = null 
)

Конструктор менеджера дополнительных полей

Аргументы
mixed$structureструктура дополнительных полей
mixed$valuesзначенния дополнительных полей
Возвращает
UserFieldsManager

Методы

check (   $data = null)

Возвращает true, если значения не соответствуют требованиям структуры

Аргументы
array$data- массив ключ => значение для проверки
Возвращает
boolean
getAdminForm (   $before_phrase = '')

Возвращает HTML для администрирования дополнительных полей

Возвращает
string
getArrayWrapper ( )

Возвращает установленное имя массива, в котором будут передаваться значения полей

Возвращает
mixed
getErrorForm (   $key)

Возвращает имя ключа в массиве ошибок для заданного поля

Аргументы
string$key- ключ поля
Возвращает
string
getErrors ( )

Возвращает ошибки, которые произошли при заполнении доолнительных полей

Возвращает
array
getField ( )

Возвращает поле, в котором у объекта хранятся сведения о доп. полях

Возвращает
string
getFieldName (   $key)

Возвращает имя формы для поля с ключем $key

Аргументы
$key- идентификатор поля
Возвращает
string
getForm (   $key,
  $template = null 
)

Возвращает HTML формы одного дополнительного поля

Аргументы
string$key- ключ поля
Возвращает
string
getStructure ( )

Возвращает структуру дополнительных полей

Возвращает
array
getValues ( )

Возвращает установленные значения полей

Возвращает
array
notEmpty ( )

Возвращает true, если заданы дополнительные поля

Возвращает
boolean
parseValueList (   $str)

Возвращает массив со списком значений для поля с типом: список

Аргументы
string$str
Возвращает
array
setArrayWrapper (   $name)

Устанавливает имя массива, в котором будут передаваться значения полей

Аргументы
string$name
Возвращает
UserFieldsManager
setDefaults ( )

Устанавливает значения по умолчанию, заданные в структуре

Возвращает
UserFieldsManager
setErrorPrefix (   $prefix)

Устанавливает префикс перед ключом поля с ошибкой

Аргументы
string$prefix
Возвращает
UserFieldsManager
setField (   $field)

Устанавливает поле в котором у объекта хранятся сведения о доп. полях

Аргументы
string$fieldимя поля
Возвращает
UserFieldsManager
setValues (   $values)

Устанавливает значения.

Аргументы
array$values
Возвращает
UserFieldsManager
textView (   $key)

Возвращает текстовое отображение дополнительного поля

Аргументы
string$key- ключ поля
Возвращает
string

Поля

$admin_tpl = '%SYSTEM%/admin/userfields.tpl'
$arr_wrap
$error_prefix = ''
$errors = array()
$list_delimiter = ','
$structure
$tpl = '%SYSTEM%/coreobject/userform.tpl'
$values = array()
const TYPE_BOOL = 'bool'
const TYPE_LIST = 'list'
const TYPE_STRING = 'string'
const TYPE_TEXT = 'text'