Базовый класс для работы всех полей форм CMS. Файл /system/core/formfield.php

FIELD_CACHE_POSTFIX

Префикс названия ячейки БД поля для кэширования

$name : string

Имя поля, как было задано в форме.

Тип

string

$element_name : string

Имя поля, как должно быть в HTML теге.

Тип

string

$filter_type : string

Тип фильтрации для поля true, false, int, str или date.

Тип

string или boolean

$filter_hint : string

Краткое описания поля фильтрации для простых фильтров в админке.

Тип

string

$title : string

Название поля.

Тип

string

$element_title : string

Тип

string

$is_public : boolean

Флаг, указывающий, что поле может быть использовано для создания в полях типов контента, конструкторе форм и т.п.

Тип

boolean

$sql : string

Последняя часть строки SQL запроса для создания поля в базе данных.

Тип

string

$cache_sql : string

Последняя часть строки SQL запроса для создания поля в базе данных, в котором будет храниться кэшированное значение.

Тип

string

$allow_index : boolean

Флаг, указывающий, что при создании поля в базе данных (например, при добавлении поля в типах контента) необходимо также добавить SQL индекс к этому полю.

Тип

boolean

$is_denormalization : boolean

Флаг, указывающий, что нам нужна денормализация данных, полученных из поля формы.

Тип

boolean

$item : array

Массив записи, в которой это поле используется.

Тип

array

$field_id : integer

ID поля, если запись о нём есть в таблице.

Тип

integer

$is_virtual : boolean

Флаг, что поле виртуальное.

Тип

boolean

$is_hidden : boolean

Флаг скрытого поля.

Тип

boolean

$rules : array

Массив правил валидации.

Тип

array

$options : array

Массив опций поля.

Тип

array

$var_type : string

Тип переменной поля boolean | integer | double | string | array | object | resource если получаемые значения от поля типизированы (всегда одного типа) указывайте это свойство в своем классе поля.

Тип

string

$data : array

Массив для данных в шаблоне.

Тип

array

__construct(string  $name, array  $options = false) 

Параметры

__set_state(array  $data) : \field_class

Магия для var_export. Статичный метод.

Параметры

getProperty(string  $key) : mixed

Возвращает свойство поля по названию.

Параметры

setProperty(string  $key, mixed  $value) : $this

Устанавливает свойство поля.

Параметры

getOptions() : array

Возвращает опции поля. Опции - это объекты полей опций.

getOption(string  $key) : mixed

Возвращает значение опции поля.

Параметры

setOptions(array  $options) 

Устанавливает все параметры для поля: опции и свойства.

Параметры

setOption(string  $key, mixed $value) : $this

Устанавливает значение опции.

Параметры

getTitle() : string

Возвращает название поля.

getName() : string

Возвращает имя поля.

getDenormalName() : string

Возвращает имя поля в случае денормализации при сохранении значения от поля.

setName(string  $name) : $this

Устанавливает имя поля и имя HTML элемента поля.

Параметры

getElementName() : string

Возвращает имя HTML элемента поля.

setItem(array  $item) : $this

Устанавливает данные текущей записи поля.

Параметры

getCacheSQL() : string

Возвращает последнюю часть строки SQL запроса для создания поля в базе данных, в котором будет храниться кэшированное значение.

getSQL() : string

Возвращает последнюю часть строки SQL запроса для создания поля в базе данных.

getRules() : array

Возвращает массив правил валидации поля.

hasDefaultValue() : boolean

Возвращает булево значение наличия умолчания у поля.

getDefaultValue() : mixed

Возвращает значение по умолчанию у поля.

getDefaultVarType(boolean  $is_filter = false) : string|null

Возвращает тип переменной для поля.

Параметры

getInput(mixed  $value) : string

Возвращает HTML код поля в форме.

Параметры

getFilterInput(mixed  $value) : string

Возвращает HTML код поля в форме фильтра.

Параметры

parse(mixed  $value) : string

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

Параметры

parseTeaser(mixed  $value) : string

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

Параметры

getStringValue(mixed  $value) : string

Если значение вашего поля предполагает тип, отличный от типа «string» или же значение поля формируется как некий HTML код, то этот метод должен вернуть как минимум строковое представление значения.

Метод используется при автоматическом формировании SEO параметров по шаблонам: slug (URL страницы), title, keywords, description.

Параметры

applyFilter(object  $model, mixed  $value) : boolean|$model

Метод, который вызывается при применении фильтра списка записей, например, при работе фильтра списка записей типов контента, списка пользователей, групп.

В методе необходимо реализовать нужную фильтрацию для этого поля, пользуясь объектом модели и значением из формы. Вернуть метод должен объект $model.

Параметры

store(mixed  $value, boolean  $is_submitted, mixed  $old_value = null) : string|array

Метод, который подготавливает входную переменную из поля для записи в базу данных.

Параметры

storeCachedValue(mixed  $value) : string

Метод, аналогичный store, но должен вернуть строку, которая будет использоваться для денормализации значения.

Параметры

afterStore(array  $item, object  $model, string  $action) : void

Метод вызывается после сохранения записей типов контента, профилей и групп.

Параметры

delete(mixed  $value) : boolean

Метод, который вызывается при удалении записи.

Параметры

hookAfterAdd(string  $content_table_name, array  $field, object  $model) : $this

Метод вызывается после создания поля в админке, например в типах контента, профилях или группах.

Параметры

hookAfterUpdate(string  $content_table_name, array  $field, array  $field_old, object  $model) : $this

Метод вызывается после редактирования поля в админке, например в типах контента, профилях или группах.

Параметры

hookAfterRemove(string  $content_table_name, array  $field, object  $model) : $this

Метод вызывается после удаления поля в админке, например в типах контента, профилях или группах.

Параметры

Назад к списку классов ядра