Class kartik\builder\FormGrid

All Classes | Properties | Methods | Events

Inheritance	kartik\builder\FormGrid » kartik\base\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements	kartik\base\BootstrapInterface, yii\base\Configurable, yii\base\ViewContextInterface
Uses Traits	kartik\base\BootstrapTrait, kartik\base\TranslationTrait, kartik\base\WidgetTrait

FormGrid allows you to build and generate multi columnar bootstrap form layouts using a single simple array configuration. It utilizes multiple instances of the kartik\builder\Form widget to generate the layout.

For example,

use kartik\form\ActiveForm;
use kartik\builder\FormGrid;

$options = []; // $options is your ActiveForm configuration
$form = ActiveForm::begin($options);
echo FormGrid::widget([
    'model' => $model, // your model
    'form' => $form,
    'autoGenerateColumns' => true,
    'rows' => [
       [
           'attributes' => [
               'username' => ['type' => Form::INPUT_TEXT, 'options'=> ['placeholder'=>'Enter username...']],
               'password' => ['type' => Form::INPUT_PASSWORD],
            ]
       ],
       [
           'attributes' => [
               'first_name' => ['type' => Form::INPUT_TEXT],
               'last_name' => ['type' => Form::INPUT_PASSWORD],
            ]
       ]
    ]
]);
ActiveForm::end();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$attributeDefaults	array	The default settings that will be applied for all attributes.	kartik\builder\FormGrid
$autoGenerateColumns	boolean	Calculate the number of columns automatically based on count of attributes configured in the Form widget.	kartik\builder\FormGrid
$autoIdPrefix	string	The prefix to the automatically generated widget IDs.	yii\base\Widget
$baseSourcePath	string\|false	Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class.	kartik\base\WidgetTrait
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$bsColCssPrefixes	array	The bootstrap grid column css prefixes mapping, the key is the bootstrap versions, and the value is an array containing the sizes and their corresponding grid column css prefixes.	kartik\base\BootstrapTrait
$bsCssMap	array	CSS conversion mappings across bootstrap library versions.	kartik\base\BootstrapTrait
$bsExtBasename	integer	The yii2 bootstrap extension base name (readonly property available via getter method getBsExtBasename())	kartik\base\BootstrapTrait
$bsVer	integer	Bootstrap version number currently set (readonly property available via getter method getBsVer())	kartik\base\BootstrapTrait
$bsVersion	integer\|string	The bootstrap library version that you wish to use for this specific extension / widget.	kartik\base\BootstrapTrait
$columnOptions	array	The HTML attributes for the grid columns.	kartik\builder\FormGrid
$columnSize	string	The bootstrap device size for rendering each grid column.	kartik\builder\FormGrid
$columns	boolean	The number of columns for each row.	kartik\builder\FormGrid
$counter	integer	A counter used to generate $id for widgets.	yii\base\Widget
$defaultBtnCss	string	Default bootstrap button CSS (readonly property available via getter method getDefaultBtnCss())	kartik\base\BootstrapTrait
$defaultIconPrefix	string	Default icon prefix (readonly property available via getter method getDefaultIconPrefix())	kartik\base\BootstrapTrait
$defaultOptions	array	Default HTML attributes or other settings for widgets.	kartik\base\WidgetTrait
$defaultPluginOptions	array	Default plugin options for the widget	kartik\base\WidgetTrait
$dropdownClass	string	Bootstrap dropdown class name based on currently configured bootstrap version (readonly property available via getter method getDropdownClass())	kartik\base\BootstrapTrait
$fieldSetOptions	array	The HTML attributes for the field/attributes container.	kartik\builder\FormGrid
$form	kartik\form\ActiveForm	The active form object instance used.	kartik\builder\FormGrid
$formName	string	The form name to be provided if not using with model and ActiveForm.	kartik\builder\FormGrid
$hashVarLoadPosition	integer	The position where the client JS hash variables for the input widget will be loaded.	kartik\base\WidgetTrait
$i18n	array	The the internalization configuration for this widget.	kartik\base\TranslationTrait
$id	string\|null	ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details.	yii\base\Widget
$model	yii\db\ActiveRecord\|yii\base\Model	The model used for the form.	kartik\builder\FormGrid
$moduleId	string	The module identifier if this widget is part of a module.	kartik\base\WidgetTrait
$options	array	HTML attributes or other settings for widgets.	kartik\base\Widget
$pjaxContainerId	string	The identifier for the PJAX widget container if the widget is to be rendered inside a PJAX container.	kartik\base\WidgetTrait
$pjaxDuplicationFix	boolean	Prevent duplication of pjax containers when browser back & forward buttons are pressed.	kartik\base\WidgetTrait
$pluginDestroyJs	string	The javascript that will be used to destroy the jQuery plugin	kartik\base\WidgetTrait
$pluginEvents	array	Widget JQuery events.	kartik\base\WidgetTrait
$pluginName	string	The plugin name	kartik\base\WidgetTrait
$pluginOptions	array	Widget plugin options.	kartik\base\WidgetTrait
$rowOptions	array	The HTML attributes for the rows.	kartik\builder\FormGrid
$rows	array	The grid rows containing form configuration elements.	kartik\builder\FormGrid
$sourcePath	string	Directory path to the original widget source.	kartik\base\WidgetTrait
$stack	yii\base\Widget[]	The widgets that are currently being rendered (not ended).	yii\base\Widget
$view	yii\web\View	The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details.	yii\base\Widget
$viewPath	string	The directory containing the view files for this widget.	yii\base\Widget

Protected Properties

Hide inherited properties

Property	Type	Description	Defined By
$_bsVer	integer	Current bootstrap version number	kartik\base\BootstrapTrait
$_dataVar	string	The HTML5 data variable name that will be used to store the Json encoded pluginOptions within the element on which the jQuery plugin will be initialized.	kartik\base\WidgetTrait
$_defaultBtnCss	string	Default bootstrap button CSS	kartik\base\BootstrapTrait
$_defaultIconPrefix	string	Default icon CSS prefix	kartik\base\BootstrapTrait
$_encOptions	string	The JSON encoded plugin options.	kartik\base\WidgetTrait
$_hashVar	string	The generated hashed variable name that will store the JSON encoded pluginOptions in yii\web\View::POS_HEAD.	kartik\base\WidgetTrait
$_isBs4	boolean	Flag to detect whether bootstrap 4.	kartik\base\BootstrapTrait
$_msgCat	string	Translation message file category name for i18n.	kartik\base\TranslationTrait

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()	Constructor.	yii\base\BaseObject
__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
__unset()	Sets a component property to be null.	yii\base\Component
addCssClass()	Adds bootstrap CSS class to options by parsing the bootstrap version for the specified Bootstrap CSS type.	kartik\base\BootstrapTrait
afterRun()	This method is invoked right after a widget is executed.	yii\base\Widget
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeRun()	This method is invoked right before the widget is executed.	yii\base\Widget
begin()	Begins a widget.	yii\base\Widget
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
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
end()	Ends a widget.	yii\base\Widget
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
getBSClass()	Gets the respective Bootstrap class based on currently configured bootstrap version.	kartik\base\BootstrapTrait
getBaseSourcePath()	Get parsed base source path based on $sourcePath setting. If $sourcePath is not set, it will return the current working directory of this widget class.	kartik\base\WidgetTrait
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getBsVer()	Gets the current set bootstrap version number.	kartik\base\BootstrapTrait
getCssClass()	Gets bootstrap css class by parsing the bootstrap version for the specified BS CSS type.	kartik\base\BootstrapTrait
getDefaultBtnCss()	Gets the default button CSS	kartik\base\BootstrapTrait
getDefaultIconPrefix()	Gets the default icon css prefix	kartik\base\BootstrapTrait
getDropdownClass()	Gets the respective bootstrap dropdown class name based on currently configured bootstrap version.	kartik\base\BootstrapTrait
getId()	Returns the ID of the widget.	yii\base\Widget
getView()		kartik\base\WidgetTrait
getViewPath()	Returns the directory containing the view files for this widget.	yii\base\Widget
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
init()	Initializes the object.	kartik\builder\FormGrid
initI18N()	Yii i18n messages configuration for generating translations	kartik\base\TranslationTrait
isBs()	Validate Bootstrap version	kartik\base\BootstrapTrait
isBs4()	Validate if Bootstrap 4.x version.	kartik\base\BootstrapTrait
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
registerWidgetJs()	Registers a JS code block for the widget.	kartik\base\WidgetTrait
removeCssClass()	Removes bootstrap CSS class from options by parsing the bootstrap version for the specified Bootstrap CSS type.	kartik\base\BootstrapTrait
render()	Renders a view.	yii\base\Widget
renderFile()	Renders a view file.	yii\base\Widget
run()	Executes the widget.	kartik\builder\FormGrid
setId()	Sets the ID of the widget.	yii\base\Widget
setView()	Sets the view object to be used by this widget.	yii\base\Widget
trigger()	Triggers an event.	yii\base\Component
widget()	Creates a widget instance and runs it.	yii\base\Widget

Protected Methods

Hide inherited methods

Method	Description	Defined By
addAsset()	Adds an asset to the view.	kartik\base\WidgetTrait
configureBsVersion()	Configures the bootstrap version settings	kartik\base\BootstrapTrait
fixPjaxDuplication()	Fix for weird PJAX container duplication behavior on pressing browser back and forward buttons.	kartik\base\WidgetTrait
getBsExtBasename()	The yii2-bootstrap extension base name.	kartik\base\BootstrapTrait
getGridOutput()	Generates the form grid layout.	kartik\builder\FormGrid
getPluginScript()	Returns the plugin registration script.	kartik\base\WidgetTrait
hashPluginOptions()	Generates a hashed variable to store the pluginOptions.	kartik\base\WidgetTrait
initBsVersion()	Initializes bootstrap versions for the widgets and asset bundles.	kartik\base\BootstrapTrait
initDestroyJs()	Generates the `pluginDestroyJs` script if it is not set.	kartik\base\WidgetTrait
isSameVersion()	Compares two versions and checks if they are of the same major BS version.	kartik\base\BootstrapTrait
mergeDefaultOptions()	Merge default options	kartik\base\WidgetTrait
parseVer()	Parses and returns the major BS version	kartik\base\BootstrapTrait
registerPlugin()	Registers a specific plugin and the related events	kartik\base\WidgetTrait
registerPluginOptions()	Registers plugin options by storing within a uniquely generated javascript variable.	kartik\base\WidgetTrait
setDataVar()	Sets a HTML5 data variable.	kartik\base\WidgetTrait

Events

Hide inherited events

Event	Type	Description	Defined By
EVENT_AFTER_RUN	yii\base\WidgetEvent	An event raised right after executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_BEFORE_RUN	yii\base\WidgetEvent	An event raised right before executing a widget. (available since version 2.0.11)	yii\base\Widget
EVENT_INIT	yii\base\Event	An event that is triggered when the widget is initialized via init(). (available since version 2.0.11)	yii\base\Widget

Property Details

$attributeDefaults public property

The default settings that will be applied for all attributes. The array will be configured similar to a single attribute setting value in the Form::$attributes array. One will typically default markup and styling like type, container, prepend, append etc. The settings at the kartik\builder\Form::$attributes level will override these default settings.

public array $attributeDefaults = []

$autoGenerateColumns public property

Calculate the number of columns automatically based on count of attributes configured in the Form widget. Columns will be created max upto the kartik\builder\Form::GRID_WIDTH. This can be overridden at the $rows level.

public boolean $autoGenerateColumns = true

$columnOptions public property

The HTML attributes for the grid columns. Applicable only if $columns is greater than 1.

public array $columnOptions = []

$columnSize public property

The bootstrap device size for rendering each grid column. Defaults to SIZE_SMALL. This property can be overridden at the $rows level.

public string $columnSize = \kartik\builder\Form::SIZE_SMALL

$columns public property

The number of columns for each row. This property can be overridden at the $rows level.

public boolean $columns = 1

$fieldSetOptions public property

The HTML attributes for the field/attributes container. The following options are additionally recognized:

tag: string, the HTML tag for the container. Defaults to fieldset.

This property can be overridden by options setting at the $rows level.

public array $fieldSetOptions = []

$form public property

The active form object instance used.

public kartik\form\ActiveForm $form = null

$formName public property

The form name to be provided if not using with model and ActiveForm.

public string $formName = null

$model public property

The model used for the form.

public yii\db\ActiveRecord|yii\base\Model $model = null

$rowOptions public property

The HTML attributes for the rows. Applicable only if $columns is greater than 1. This property can be overridden at the $rows level.

public array $rowOptions = []

$rows public property

The grid rows containing form configuration elements.

public array $rows = []

Method Details

getGridOutput() protected method

Generates the form grid layout.

protected string getGridOutput ( )
return	string	The generated form grid layout.
throws	Exception

init() public method

Initializes the object.

This method is called at the end of the constructor. The default implementation will trigger an EVENT_INIT event.

public void init ( )
throws	yii\base\InvalidConfigException

run() public method

Executes the widget.

public string\|void run ( )
return	string\|void	The rendering result may be directly "echoed" or returned as a string