Class lispa\amos\core\forms\ActiveField

All Classes | Properties | Methods

Inheritance	lispa\amos\core\forms\ActiveField » yii\bootstrap\ActiveField » yii\widgets\ActiveField » yii\base\Component » yii\base\Object
Implements	yii\base\Configurable

Class ActiveField

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$addAriaAttributes	boolean	Adds aria HTML attributes `aria-required` and `aria-invalid` for inputs	yii\widgets\ActiveField
$attribute	string	The model attribute that this field is associated with.	yii\widgets\ActiveField
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component	yii\base\Component
$checkboxTemplate	string	The template for checkboxes in default layout	yii\bootstrap\ActiveField
$enableAjaxValidation	boolean	Whether to enable AJAX-based data validation.	yii\widgets\ActiveField
$enableClientValidation	boolean	Whether to enable client-side data validation.	yii\widgets\ActiveField
$enableError	boolean	Whether to render the error.	yii\bootstrap\ActiveField
$enableLabel	boolean	Whether to render the label.	yii\bootstrap\ActiveField
$errorOptions	array	The default options for the error tags.	yii\widgets\ActiveField
$form	yii\widgets\ActiveForm	The form that this field is associated with.	yii\widgets\ActiveField
$hintOptions	array	The default options for the hint tags.	yii\widgets\ActiveField
$horizontalCheckboxTemplate	string	The template for checkboxes in horizontal layout	yii\bootstrap\ActiveField
$horizontalCssClasses	null\|array	CSS grid classes for horizontal layout.	yii\bootstrap\ActiveField
$horizontalRadioTemplate	string	The template for radio buttons in horizontal layout	yii\bootstrap\ActiveField
$inline	boolean	Whether to render checkboxList() and radioList() inline.	yii\bootstrap\ActiveField
$inlineCheckboxListTemplate	string	The template for inline checkboxLists	yii\bootstrap\ActiveField
$inlineRadioListTemplate	string	The template for inline radioLists	yii\bootstrap\ActiveField
$inputOptions	array	The default options for the input tags.	yii\widgets\ActiveField
$inputTemplate	string\|null	Optional template to render the `{input}` placeholder content	yii\bootstrap\ActiveField
$labelOptions	array	The default options for the label tags.	yii\widgets\ActiveField
$model	yii\base\Model	The data model that this field is associated with.	yii\widgets\ActiveField
$options	array	The HTML attributes (name-value pairs) for the field container tag.	yii\widgets\ActiveField
$parts	array	Different parts of the field (e.g. input, label).	yii\widgets\ActiveField
$radioTemplate	string	The template for radios in default layout	yii\bootstrap\ActiveField
$selectors	array	The jQuery selectors for selecting the container, input and error tags.	yii\widgets\ActiveField
$template	string	The template that is used to arrange the label, the input field, the error message and the hint text.	yii\widgets\ActiveField
$validateOnBlur	boolean	Whether to perform validation when the input field loses focus.	yii\widgets\ActiveField
$validateOnChange	boolean	Whether to perform validation when the value of the input field is changed.	yii\widgets\ActiveField
$validateOnType	boolean	Whether to perform validation while the user is typing in the input field.	yii\widgets\ActiveField
$validationDelay	integer	Number of milliseconds that the validation should be delayed when the user types in the field and $validateOnType is set `true`.	yii\widgets\ActiveField
$wrapperOptions	array	Options for the wrapper tag, used in the `{beginWrapper}` placeholder	yii\bootstrap\ActiveField

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()	{@inheritdoc}	yii\bootstrap\ActiveField
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__toString()	PHP magic method that returns the string representation of this object.	yii\widgets\ActiveField
__unset()	Sets a component property to be null.	yii\base\Component
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
begin()	Renders the opening tag of the field container.	lispa\amos\core\forms\ActiveField
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
checkbox()	{@inheritdoc}	yii\bootstrap\ActiveField
checkboxList()	{@inheritdoc}	lispa\amos\core\forms\ActiveField
checkboxListAccessible()		lispa\amos\core\forms\ActiveField
className()	Returns the fully qualified name of this class.	yii\base\Object
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
dropDownList()	Renders a drop-down list.	yii\widgets\ActiveField
end()	Renders the closing tag of the field container.	yii\widgets\ActiveField
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
error()	Generates a tag that contains the first validation error of $attribute.	yii\widgets\ActiveField
fileInput()	Renders a file input.	yii\widgets\ActiveField
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
hiddenInput()	Renders a hidden input.	yii\widgets\ActiveField
hint()	Renders the hint tag.	yii\widgets\ActiveField
init()	Initializes the object.	lispa\amos\core\forms\ActiveField
inline()		yii\bootstrap\ActiveField
input()	Renders an input tag.	yii\widgets\ActiveField
label()	{@inheritdoc}	lispa\amos\core\forms\ActiveField
limitedCharsTextarea()	An extended textarea from base function that includes a counter of inserted characters in the generated textarea. The max number of characters is gotten dinamically from the maxchars attr of the generated textarea.	lispa\amos\core\forms\ActiveField
listBox()	Renders a list box.	yii\widgets\ActiveField
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
passwordInput()	Renders a password input.	yii\widgets\ActiveField
radio()	{@inheritdoc}	yii\bootstrap\ActiveField
radioList()	{@inheritdoc}	lispa\amos\core\forms\ActiveField
render()	{@inheritdoc}	yii\bootstrap\ActiveField
staticControl()	Renders Bootstrap static form control.	yii\bootstrap\ActiveField
textInput()	Renders a text input.	yii\widgets\ActiveField
textarea()	Renders a text area.	yii\widgets\ActiveField
trigger()	Triggers an event.	yii\base\Component
widget()	Renders a widget as the input of the field.	yii\widgets\ActiveField

Protected Methods

Hide inherited methods

Method	Description	Defined By
addAriaAttributes()	Adds aria attributes to the input options	yii\widgets\ActiveField
adjustLabelFor()	Adjusts the `for` attribute for the label based on the input options.	yii\widgets\ActiveField
createLayoutConfig()		yii\bootstrap\ActiveField
getClientOptions()	Returns the JS options for the field.	yii\widgets\ActiveField
getInputId()	Returns the HTML `id` of the input element of this form field.	yii\widgets\ActiveField
isAjaxValidationEnabled()	Checks if ajax validation enabled for the field	yii\widgets\ActiveField
isClientValidationEnabled()	Checks if client validation enabled for the field	yii\widgets\ActiveField
renderLabelParts()		yii\bootstrap\ActiveField

Method Details

begin() public method

Renders the opening tag of the field container.

public string begin ( )
return	string	The rendering result.

checkboxList() public method

{@inheritdoc}

public void checkboxList ( $items, $options = [] )
$items
$options

checkboxListAccessible() public method

public $this checkboxListAccessible ( $items, $options = [] )
$items	array
$options	array

init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

label() public method

{@inheritdoc}

public void label ( $label = null, $options = [] )
$label
$options

limitedCharsTextarea() public method

An extended textarea from base function that includes a counter of inserted characters in the generated textarea. The max number of characters is gotten dinamically from the maxchars attr of the generated textarea.

If maxlength is not defined from a rule in the model, it will be set from the column size from the schema. If maxlength defined from the options is greater than column size of the schema, the maxlength will be set with the schema column size.

public $this limitedCharsTextarea ( $options = [] )
$options	array

radioList() public method

{@inheritdoc}

public void radioList ( $items, $options = [] )
$items
$options