Class kartik\builder\TabularForm

Inheritancekartik\builder\TabularForm » kartik\builder\BaseForm » kartik\base\Widget » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implementskartik\base\BootstrapInterface, yii\base\Configurable, yii\base\ViewContextInterface
Uses Traitskartik\base\BootstrapTrait, kartik\base\TranslationTrait, kartik\base\WidgetTrait, kartik\builder\FormTrait

TabularForm builder widget allows easy way to configure tabular form layouts with ability to implement various input types and input widgets. It works with and is complemented by kartik\form\ActiveForm and kartik\grid\GridView functionality .

For example,

use kartik\form\ActiveForm;
use kartik\builder\TabularForm;

$options = []; // $options is your ActiveForm configuration
$form = ActiveForm::begin($options);
echo TabularForm::widget([
    'model' => $model, // your model
    'form' => $form,
    'gridSettings' => [
        'toolbar' => \yii\helpers\Html::submitButton('Submit')
    ],
    'attributes' => [
        'id' => ['type' => TabularForm::INPUT_STATIC],
        'name' => ['type' => TabularForm::INPUT_TEXT],
        'description' => ['type' => TabularForm::INPUT_TEXT],
        'status' => ['type' => TabularForm::INPUT_CHECKBOX, 'enclosedByLabel' => true],
    ]
]);
ActiveForm::end();

Most of each of the properties in the attribute settings array (except label & columnOptions) can also be setup as a Closure callback i.e. function ($model, $key, $index, $widget).

For example,

echo TabularForm::widget([
    'model' => $model, // your model
    'form' => $form,
    'attributes' => [
        'id' => [
            'type' => function($model, $key, $index, $widget) {
                return (!$model->active) ? TabularForm::INPUT_HIDDEN : TabularForm::INPUT_STATIC]
            }
        ],
    ]
]);

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$actionColumn array The settings for the action column. kartik\builder\TabularForm
$attributeDefaults array The default settings that will be applied for all attributes. kartik\builder\BaseForm
$attributes array The attribute settings. kartik\builder\BaseForm
$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
$checkboxColumn array|boolean The settings for the checkbox column. kartik\builder\TabularForm
$compositeKeySeparator string The separator for the composite keys available as an array. kartik\builder\TabularForm
$counter integer A counter used to generate $id for widgets. yii\base\Widget
$dataProvider yii\data\ActiveDataProvider|yii\data\ArrayDataProvider The data provider for the tabular form. kartik\builder\TabularForm
$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
$form kartik\form\ActiveForm The form instance. kartik\builder\BaseForm
$formName string The form name to be provided if not using with model and kartik\form\ActiveForm. kartik\builder\BaseForm
$gridClass string The namespaced GridView class name. kartik\builder\TabularForm
$gridSettings array The settings for kartik\grid\GridView widget which will display the tabular form content. kartik\builder\TabularForm
$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
$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
$rowHighlight boolean Highlight current row if checkbox is checked. kartik\builder\TabularForm
$rowSelectedClass string The CSS class to apply to a row when the row is selected. kartik\builder\TabularForm
$serialColumn array|boolean The settings for the serial column. kartik\builder\TabularForm
$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
$staticOnly boolean Whether all inputs in the form are to be static only kartik\builder\BaseForm
$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

PropertyTypeDescriptionDefined By
$_basicInputs array The basic inputs kartik\builder\BaseForm
$_bsVer integer Current bootstrap version number kartik\base\BootstrapTrait
$_columns array The grid columns kartik\builder\TabularForm
$_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
$_dropdownInputs array The dropdown inputs kartik\builder\BaseForm
$_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
$_validInputs array The allowed valid list of input types kartik\builder\BaseForm

Public Methods

Hide inherited methods

MethodDescriptionDefined 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\TabularForm
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\TabularForm
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

MethodDescriptionDefined By
addAsset() Adds an asset to the view. kartik\base\WidgetTrait
checkBaseConfig() Checks base configuration and throws a configuration exception if invalid. kartik\builder\FormTrait
checkFormConfig() Checks the form configuration and throws a configuration exception if invalid. kartik\builder\FormTrait
checkValidSetting() Checks if a setting is of valid type and throws exception if not. kartik\builder\TabularForm
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
getCellValue() Generates a cell value. kartik\builder\TabularForm
getInput() Generates the active field input by parsing the label and hint. kartik\builder\BaseForm
getPluginScript() Returns the plugin registration script. kartik\base\WidgetTrait
getStaticInput() Generates the static input kartik\builder\TabularForm
hasModel() Check if a valid model is set for the object instance. kartik\builder\FormTrait
hashPluginOptions() Generates a hashed variable to store the pluginOptions. kartik\base\WidgetTrait
initActionColumn() Initializes the action column. kartik\builder\TabularForm
initBsVersion() Initializes bootstrap versions for the widgets and asset bundles. kartik\base\BootstrapTrait
initCheckboxColumn() Initializes the checkbox column. kartik\builder\TabularForm
initColumn() Initializes special columns for the kartik\builder\TabularForm grid view. kartik\builder\TabularForm
initDataColumns() Initializes the data columns. kartik\builder\TabularForm
initDestroyJs() Generates the pluginDestroyJs script if it is not set. kartik\base\WidgetTrait
initOptions() Initializes the kartik\builder\TabularForm widget options kartik\builder\TabularForm
initSerialColumn() Initializes the serial column. kartik\builder\TabularForm
isColumnSet() Checks if a grid column is set correctly. kartik\builder\TabularForm
isEmpty() Checks if model attribute configuration is empty or invalid kartik\builder\TabularForm
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
prepareAttributes() Prepares attributes based on visibility setting kartik\builder\BaseForm
registerAssets() Registers the kartik\builder\TabularForm widget assets. kartik\builder\TabularForm
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
renderActiveInput() Renders active input based on the attribute settings. This includes additional markup like rendering content before and after input, and wrapping input in a container if set. kartik\builder\BaseForm
renderGrid() Render the grid content. kartik\builder\TabularForm
renderInput() Renders normal form input based on the attribute settings. This includes additional markup like rendering content before and after input, and wrapping input in a container if set. kartik\builder\BaseForm
renderRawActiveInput() Renders raw active input based on the attribute settings. kartik\builder\TabularForm
renderRawInput() Renders raw form input based on the attribute settings. kartik\builder\BaseForm
setDataVar() Sets a HTML5 data variable. kartik\base\WidgetTrait
slash() Prepends with a back slash if necessary for full namespace validation. kartik\builder\TabularForm

Events

Hide inherited events

EventTypeDescriptionDefined 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

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
INPUT_CHECKBOX 'checkbox' kartik\builder\BaseForm
INPUT_CHECKBOX_BUTTON_GROUP 'checkboxButtonGroup' kartik\builder\BaseForm
INPUT_CHECKBOX_LIST 'checkboxList' kartik\builder\BaseForm
INPUT_DROPDOWN_LIST 'dropdownList' kartik\builder\BaseForm
INPUT_FILE 'fileInput' kartik\builder\BaseForm
INPUT_HIDDEN 'hiddenInput' kartik\builder\BaseForm
INPUT_HIDDEN_STATIC 'hiddenStaticInput' kartik\builder\BaseForm
INPUT_HTML5 'input' kartik\builder\BaseForm
INPUT_LIST_BOX 'listBox' kartik\builder\BaseForm
INPUT_MULTISELECT 'multiselect' kartik\builder\BaseForm
INPUT_PASSWORD 'passwordInput' kartik\builder\BaseForm
INPUT_RADIO 'radio' kartik\builder\BaseForm
INPUT_RADIO_BUTTON_GROUP 'radioButtonGroup' kartik\builder\BaseForm
INPUT_RADIO_LIST 'radioList' kartik\builder\BaseForm
INPUT_RAW 'raw' kartik\builder\BaseForm
INPUT_STATIC 'staticInput' kartik\builder\BaseForm
INPUT_TEXT 'textInput' kartik\builder\BaseForm
INPUT_TEXTAREA 'textarea' kartik\builder\BaseForm
INPUT_WIDGET 'widget' kartik\builder\BaseForm

Property Details

$_columns protected property

The grid columns

protected array $_columns = []
$actionColumn public property

The settings for the action column. If set to false, the action column will not be displayed.

public array $actionColumn = [
    'updateOptions' => ['style' => 'display:none'], 'width' => '60px'
]
$checkboxColumn public property

The settings for the checkbox column. If set to false, the checkbox column will not be displayed.

$compositeKeySeparator public property

The separator for the composite keys available as an array.

$dataProvider public property

The data provider for the tabular form. This property is required. It must return a valid list of models for rendering the tabular form inputs.

$gridClass public property

The namespaced GridView class name. Defaults to '\kartik\grid\GridView'. Any other class set here must extend from kartik\grid\GridView class.

public string $gridClass null
$gridSettings public property

The settings for kartik\grid\GridView widget which will display the tabular form content.

public array $gridSettings = []
$rowHighlight public property

Highlight current row if checkbox is checked.

public boolean $rowHighlight true
$rowSelectedClass public property

The CSS class to apply to a row when the row is selected.

public string $rowSelectedClass null
$serialColumn public property

The settings for the serial column. If set to false, the serial column will not be displayed.

Method Details

checkValidSetting() protected static method

Checks if a setting is of valid type and throws exception if not.

protected static void checkValidSetting ( $attr, $settings, $key, $type )
$attr string

The attribute to check

$settings array

The attribute settings

$key string

The model key

$type string

The attribute input type

throws yii\base\InvalidConfigException
getCellValue() protected method

Generates a cell value.

protected Closure getCellValue ( $attribute, $settings )
$attribute string

The model attribute.

$settings mixed

The configuration for the attribute.

return Closure

The parsed cell value.

throws Exception
getStaticInput() protected method

Generates the static input

protected string getStaticInput ( $type, $model, $index, $settings, $attribute, $formatter )
$type string

The static input type.

$model yii\base\Model

The data model.

$index integer

The zero based index of the item in dataProvider.

$settings array

The attribute settings.

$attribute string

The attribute.

$formatter yii\i18n\Formatter

The formatter instance.

return string

The generated static input.

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
initActionColumn() protected method

Initializes the action column.

protected void initActionColumn ( )
initCheckboxColumn() protected method

Initializes the checkbox column.

protected void initCheckboxColumn ( )
initColumn() protected method

Initializes special columns for the kartik\builder\TabularForm grid view.

protected void initColumn ( $type )
$type string

The grid column type (one of 'serial', 'action', 'checkbox')

initDataColumns() protected method

Initializes the data columns.

protected void initDataColumns ( )
throws yii\base\InvalidConfigException
initOptions() protected method

Initializes the kartik\builder\TabularForm widget options

protected void initOptions ( )
initSerialColumn() protected method

Initializes the serial column.

protected void initSerialColumn ( )
isColumnSet() protected method

Checks if a grid column is set correctly.

protected boolean isColumnSet ( $type )
$type string

The grid column type (one of 'serial', 'action', 'checkbox').

return boolean

Whether the column is set.

throws Exception
isEmpty() protected static method

Checks if model attribute configuration is empty or invalid

protected static boolean isEmpty ( $models, $index, $attribute )
$models array

The list of models in the tabular layout

$index integer

The index for each tabular row

$attribute string

The attribute name

registerAssets() protected method

Registers the kartik\builder\TabularForm widget assets.

protected void registerAssets ( )
renderGrid() protected method

Render the grid content.

protected string renderGrid ( )
return string

The rendered gridview

throws Exception
renderRawActiveInput() protected method

Renders raw active input based on the attribute settings.

protected string renderRawActiveInput ( $form, $model, $attribute, $settings )
$form kartik\form\ActiveForm

The form instance.

$model yii\base\Model

The data model.

$attribute string

The name of the attribute.

$settings array

The attribute settings.

return string

The generated active input.

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

slash() protected static method

Prepends with a back slash if necessary for full namespace validation.

protected static string slash ( $str '' )
$str string

The input string

return string

The modified namespace