Class yii\bootstrap\ActiveField

All Classes | Properties | Methods

Inheritance	yii\bootstrap\ActiveField » yii\widgets\ActiveField
Available since version	2.0

A Bootstrap 3 enhanced version of \yii\widgets\ActiveField.

This class adds some useful features to \yii\widgets\ActiveField to render all sorts of Bootstrap 3 form fields in different form layouts:

$inputTemplate is an optional template to render complex inputs, for example input groups
$horizontalCssClasses defines the CSS grid classes to add to label, wrapper, error and hint in horizontal forms
inline()/inline() is used to render inline checkboxList() and radioList()
$enableError can be set to false to disable to the error
$enableLabel can be set to false to disable to the label
label() can be used with a bool argument to enable/disable the label

There are also some new placeholders that you can use in the \yii\bootstrap\template configuration:

{beginLabel}: the opening label tag
{labelTitle}: the label title for use with {beginLabel}/{endLabel}
{endLabel}: the closing label tag
{beginWrapper}: the opening wrapper tag
{endWrapper}: the closing wrapper tag

The wrapper tag is only used for some layouts and form elements.

Note that some elements use slightly different defaults for \yii\bootstrap\template and other options. You may want to override those predefined templates for checkboxes, radio buttons, checkboxLists and radioLists in the \yii\widgets\ActiveForm::fieldConfig of the \yii\widgets\ActiveForm:

$checkboxTemplate the template for checkboxes in default layout
$radioTemplate the template for radio buttons in default layout
$horizontalCheckboxTemplate the template for checkboxes in horizontal layout
$horizontalRadioTemplate the template for radio buttons in horizontal layout
$inlineCheckboxListTemplate the template for inline checkboxLists
$inlineRadioListTemplate the template for inline radioLists

Example:

use yii\bootstrap\ActiveForm;

$form = ActiveForm::begin(['layout' => 'horizontal']);

// Form field without label
echo $form->field($model, 'demo', [
    'inputOptions' => [
        'placeholder' => $model->getAttributeLabel('demo'),
    ],
])->label(false);

// Inline radio list
echo $form->field($model, 'demo')->inline()->radioList($items);

// Control sizing in horizontal mode
echo $form->field($model, 'demo', [
    'horizontalCssClasses' => [
        'wrapper' => 'col-sm-2',
    ]
]);

// With 'default' layout you would use 'template' to size a specific field:
echo $form->field($model, 'demo', [
    'template' => '{label} <div class="row"><div class="col-sm-4">{input}{error}{hint}</div></div>'
]);

// Input group
echo $form->field($model, 'demo', [
    'inputTemplate' => '<div class="input-group"><span class="input-group-addon">@</span>{input}</div>',
]);

ActiveForm::end();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$checkboxTemplate	string	The template for checkboxes in default layout	yii\bootstrap\ActiveField
$enableError	boolean	Whether to render the error.	yii\bootstrap\ActiveField
$enableLabel	boolean	Whether to render the label.	yii\bootstrap\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
$inputTemplate	string\|null	Optional template to render the `{input}` placeholder content	yii\bootstrap\ActiveField
$radioTemplate	string	The template for radios in default layout	yii\bootstrap\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
__construct()		yii\bootstrap\ActiveField
checkbox()		yii\bootstrap\ActiveField
checkboxList()		yii\bootstrap\ActiveField
inline()		yii\bootstrap\ActiveField
label()		yii\bootstrap\ActiveField
radio()		yii\bootstrap\ActiveField
radioList()		yii\bootstrap\ActiveField
render()		yii\bootstrap\ActiveField
staticControl()	Renders Bootstrap static form control.	yii\bootstrap\ActiveField

Protected Methods

Hide inherited methods

Method	Description	Defined By
createLayoutConfig()		yii\bootstrap\ActiveField
renderLabelParts()		yii\bootstrap\ActiveField

Property Details

$checkboxTemplate public property

The template for checkboxes in default layout

public string $checkboxTemplate = "<div class=\"checkbox\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n</div>"

$enableError public property

Whether to render the error. Default is true except for layout inline.

public boolean $enableError = true

$enableLabel public property

Whether to render the label. Default is true.

public boolean $enableLabel = true

$horizontalCheckboxTemplate public property

The template for checkboxes in horizontal layout

public string $horizontalCheckboxTemplate = "{beginWrapper}\n<div class=\"checkbox\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n</div>\n{error}\n{endWrapper}\n{hint}"

$horizontalCssClasses public property

CSS grid classes for horizontal layout. This must be an array with these keys:

'offset' the offset grid class to append to the wrapper if no label is rendered
'label' the label grid class
'wrapper' the wrapper grid class
'error' the error grid class
'hint' the hint grid class

public null|array $horizontalCssClasses = []

$horizontalRadioTemplate public property

The template for radio buttons in horizontal layout

public string $horizontalRadioTemplate = "{beginWrapper}\n<div class=\"radio\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n</div>\n{error}\n{endWrapper}\n{hint}"

$inline public property

Whether to render checkboxList() and radioList() inline.

public boolean $inline = false

$inlineCheckboxListTemplate public property

The template for inline checkboxLists

public string $inlineCheckboxListTemplate = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}"

$inlineRadioListTemplate public property

The template for inline radioLists

public string $inlineRadioListTemplate = "{label}\n{beginWrapper}\n{input}\n{error}\n{endWrapper}\n{hint}"

$inputTemplate public property

Optional template to render the {input} placeholder content

public string|null $inputTemplate = null

$radioTemplate public property

The template for radios in default layout

public string $radioTemplate = "<div class=\"radio\">\n{beginLabel}\n{input}\n{labelTitle}\n{endLabel}\n{error}\n{hint}\n</div>"

$wrapperOptions public property

Options for the wrapper tag, used in the {beginWrapper} placeholder

public array $wrapperOptions = []

Method Details

__construct() public method

public void __construct ( $config = [] )
$config

checkbox() public method

public void checkbox ( $options = [], $enclosedByLabel = true )
$options
$enclosedByLabel

checkboxList() public method

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

createLayoutConfig() protected method

protected array createLayoutConfig ( $instanceConfig )
$instanceConfig	array	The configuration passed to this instance's constructor
return	array	The layout specific default configuration for this instance

inline() public method

public $this inline ( $value = true )
$value	boolean	Whether to render a inline list
return	$this	The field object itself Make sure you call this method before checkboxList() or radioList() to have any effect.

label() public method

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

radio() public method

public void radio ( $options = [], $enclosedByLabel = true )
$options
$enclosedByLabel

radioList() public method

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

render() public method

public void render ( $content = null )
$content

renderLabelParts() protected method

protected void renderLabelParts ( $label = null, $options = [] )
$label	string\|null	The label or null to use model label
$options	array	The tag options

staticControl() public method (available since version 2.0.5)

Renders Bootstrap static form control.

public $this staticControl ( $options = [] )
$options	array	The tag options in terms of name-value pairs. These will be rendered as the attributes of the resulting tag. There are also a special options: encode: bool, whether value should be HTML-encoded or not.
return	$this	The field object itself