Class common\db\fields\Field

Inheritancecommon\db\fields\Field » Yii\base\Object
Subclassesapp\modules\shop\db\fields\GoodAttrsField, common\db\fields\AutoCompleteField, common\db\fields\CheckBoxField, common\db\fields\CodeField, common\db\fields\DateField, common\db\fields\EmailField, common\db\fields\HasOneField, common\db\fields\HasOneRadioField, common\db\fields\HiddenField, common\db\fields\Html5FileField, common\db\fields\Html5ImageField, common\db\fields\HtmlField, common\db\fields\ListField, common\db\fields\ManyManyField, common\db\fields\ManyManySortField, common\db\fields\MarkItUpField, common\db\fields\NumberField, common\db\fields\ParentListField, common\db\fields\PasswordField, common\db\fields\PkField, common\db\fields\RadioListField, common\db\fields\TextAreaField, common\db\fields\TextField, common\db\fields\TimestampField, common\db\fields\YaMapField

Class TextField Базовый класс полей.

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attr string атрибут модели common\db\fields\Field
$data callable функция возвращающая данные ассоциированные с полем common\db\fields\Field
$defaultValue mixed значение поля присваевоемое модели перед сохранением, в случае если текущий атрибут не задан common\db\fields\Field
$editInGrid bool возможность редактирования значения поля в гриде common\db\fields\Field
$editableAction string действие для редактирования модели из грида common\db\fields\Field
$filterInputClass string|array имя класса, либо конфигурация компонента который рендерит поле ввода расширенного фильтра common\db\fields\Field
$formTemplate string шаблон для поля common\db\fields\Field
$gridOptions array опции по умолчанию при отображении в гриде common\db\fields\Field
$initValue mixed значение присваевоемое полю при создании модели с сценарием \common\db\ActiveRecord::SCENARIO_SEARCH common\db\fields\Field
$inputClass string|array имя класс, либо конфигурация компонента который рендерит поле ввыода формы common\db\fields\Field
$isRequired bool обязательно ли поле к заполнению common\db\fields\Field
$isSafe bool использоваь ли валидатор safe common\db\fields\Field
$model common\db\ActiveRecord модель common\db\fields\Field
$options array массив html атрибут поля формы common\db\fields\Field
$queryModifier callable функция для применения ограничений при поиске по полю. common\db\fields\Field
$search bool участвует ли поле при поиске common\db\fields\Field
$showInExtendedFilter bool отображать в расширенном фильре common\db\fields\Field
$showInFilter bool отображать в фильтре грида common\db\fields\Field
$showInForm bool отображать в форме common\db\fields\Field
$showInGrid bool отображать в гриде common\db\fields\Field
$showInTableInput bool отображать поле при табличном вводе common\db\fields\Field
$showInView bool отображать при детальном просмотре common\db\fields\Field
$tab string вкладка формы на которой должно быть расположено поле common\db\fields\Field
$title string подпись атрибута common\db\fields\Field
$viewOptions array опции по умолчанию при детальном просмотре common\db\fields\Field
$widgetOptions array параметры виджета поля ввода common\db\fields\Field

Protected Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$_dataValue array данные ассоциированные с полем (key=>value) common\db\fields\Field
$_gridFilter mixed значение фильтра грида установленное common\db\fields\Field

Public Methods

Hide inherited methods

MethodDescriptionDefined By
__construct() Конструктор common\db\fields\Field
applySearch() Накладывает ограничение на поиск common\db\fields\Field
behaviors() Поведения common\db\fields\Field
extendedFilterForm() Формирование Html кода поля для вывода в расширенном фильтре common\db\fields\Field
getDataValue() Возвращает массив данных ассоциированных с полем common\db\fields\Field
getEditableUrl() Создает url для x-editable common\db\fields\Field
getForm() Формирование Html кода поля для вывода в форме common\db\fields\Field
getGrid() Результурующая конфигурация поля грида (GridView) common\db\fields\Field
getGridFilter() Возвращает значение фильтра для грида common\db\fields\Field
getView() Результирующая конфигурация поля для детального просмотра common\db\fields\Field
getWrappedForm() Формирует html код поля формы обернутый в шаблон common\db\fields\Field
rules() Правила валидации common\db\fields\Field
search() Поиск common\db\fields\Field
setGridFilter() common\db\fields\Field
xEditable() common\db\fields\Field

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
defaultGrid() Конфигурация грида по умолчанию common\db\fields\Field
defaultGridFilter() Возвращает значение фильтра для по умолчанию common\db\fields\Field
defaultView() Конфигурация детального просмотра по умолчанию common\db\fields\Field
getFormAttrName() Возвращает имя атрибута для поля формы common\db\fields\Field
grid() Конфигурация поля для грида (GridView) common\db\fields\Field
view() Конфигурация поля для детального просмотра common\db\fields\Field

Property Details

$_dataValue protected property
array $_dataValue = null

данные ассоциированные с полем (key=>value)

$_gridFilter protected property
mixed $_gridFilter = null

значение фильтра грида установленное

$attr public property
string $attr = null

атрибут модели

$data public property
callable $data = null

функция возвращающая данные ассоциированные с полем

$defaultValue public property
mixed $defaultValue = null

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

$editInGrid public property
bool $editInGrid = false

возможность редактирования значения поля в гриде

$editableAction public property
string $editableAction = "editable"

действие для редактирования модели из грида

$filterInputClass public property
string|array $filterInputClass = null

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

$formTemplate public property
string $formTemplate = '<div class="row"><div class="co-xs-12 col-md-7 col-lg-5">{input}</div></div>'

шаблон для поля

$gridOptions public property
array $gridOptions = []

опции по умолчанию при отображении в гриде

$initValue public property
mixed $initValue = null

значение присваевоемое полю при создании модели с сценарием \common\db\ActiveRecord::SCENARIO_SEARCH

$inputClass public property
string|array $inputClass = "\\common\\inputs\\TextInput"

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

$isRequired public property
bool $isRequired = false

обязательно ли поле к заполнению

$isSafe public property
bool $isSafe = true

использоваь ли валидатор safe

$model public property
common\db\ActiveRecord $model = null

модель

$options public property
array $options = []

массив html атрибут поля формы

$queryModifier public property
callable $queryModifier = null

функция для применения ограничений при поиске по полю. Принимает два аргумента \yii\db\ActiveQuery и \common\db\fields\Field

$search public property
bool $search = true

участвует ли поле при поиске

$showInExtendedFilter public property
bool $showInExtendedFilter = true

отображать в расширенном фильре

$showInFilter public property
bool $showInFilter = true

отображать в фильтре грида

$showInForm public property
bool $showInForm = true

отображать в форме

$showInGrid public property
bool $showInGrid = true

отображать в гриде

$showInTableInput public property
bool $showInTableInput = true

отображать поле при табличном вводе

$showInView public property
bool $showInView = true

отображать при детальном просмотре

$tab public property
string $tab = \common\db\MetaFields::DEFAULT_TAB

вкладка формы на которой должно быть расположено поле

$title public property
string $title = null

подпись атрибута

$viewOptions public property
array $viewOptions = []

опции по умолчанию при детальном просмотре

$widgetOptions public property
array $widgetOptions = []

параметры виджета поля ввода

Method Details

__construct() public method

Конструктор

void __construct( \common\db\ActiveRecord $model, $attr, $config = [] )
$model common\db\ActiveRecord

модель
$attr string

атрибут
$config array

массив значений атрибутов
applySearch() public method

Накладывает ограничение на поиск

void applySearch( \common\db\ActiveQuery $query )
$query common\db\ActiveQuery
behaviors() public method

Поведения

array behaviors( )
defaultGrid() protected method

Конфигурация грида по умолчанию

array defaultGrid( )
defaultGridFilter() protected method

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

mixed defaultGridFilter( )
defaultView() protected method

Конфигурация детального просмотра по умолчанию

array defaultView( )
extendedFilterForm() public method

Формирование Html кода поля для вывода в расширенном фильтре

string extendedFilterForm( \Yii\widgets\ActiveForm $form, array $options = [] )
$form \Yii\widgets\ActiveForm

объект форма
$options array

массив html атрибутов поля
getDataValue() public method

Возвращает массив данных ассоциированных с полем

array getDataValue( )
getEditableUrl() public method

Создает url для x-editable

string getEditableUrl( )
getForm() public method

Формирование Html кода поля для вывода в форме

string getForm( \Yii\widgets\ActiveForm $form, array $options = [], $index = false, $cls = null )
$form \Yii\widgets\ActiveForm

объект форма
$options array

массив html атрибутов поля
$index bool|int

инднкс модели при табличном вводе
$cls string|array

класс поля, либо конфигурационный массив
getFormAttrName() protected method

Возвращает имя атрибута для поля формы

string getFormAttrName( $index )
$index bool|int

индекс модели при табличном вводе
getGrid() public method

Результурующая конфигурация поля грида (GridView)

array getGrid( )
getGridFilter() public method

Возвращает значение фильтра для грида

mixed getGridFilter( )
getView() public method

Результирующая конфигурация поля для детального просмотра

array getView( )
getWrappedForm() public method

Формирует html код поля формы обернутый в шаблон

string getWrappedForm( \Yii\widgets\ActiveForm $form, array $options = [], $index = false )
$form \Yii\widgets\ActiveForm

объект форма
$options array

массив html атрибутов поля
$index bool|int

инднкс модели при табличном вводе
grid() protected method

Конфигурация поля для грида (GridView)

array grid( )
rules() public method

Правила валидации

array rules( )
search() public method

Поиск

void search( \common\db\ActiveQuery $query )
$query common\db\ActiveQuery

запрос
setGridFilter() public method

void setGridFilter( $value )
$value

Mixed установка значения фильтра
view() protected method

Конфигурация поля для детального просмотра

array view( )
xEditable() public method

void xEditable( )