• Home
• kartik
• builder
• TabularForm

PHP Class kartik\builder\TabularForm

Usage: use kartik\form\ActiveForm; use kartik\builder\TabularForm; $form = ActiveForm::begin($options); // $options is array for your form config 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(); Show file Open project: kartik-v/yii2-builder Class Usage Examples

Public Properties

Property	Type	Description
$actionColumn		the settings for the action column. If set to false, the action column will not be displayed.
$checkboxColumn		the settings for the checkbox column. If set to false, the checkbox column will not be displayed.
$compositeKeySeparator		the separator for the composite keys available as an array.
$dataProvider		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		the namespaced GridView class name. Defaults to '\kartik\grid\GridView'. Any other class set here must extend from '\kartik\grid\GridView'.
$gridSettings		the settings for [[GridView]] widget which will display the tabular form content.
$rowHighlight		highlight current row if checkbox is checked.
$rowSelectedClass		the CSS class to apply to a row when the row is selected.
$serialColumn		the settings for the serial column. If set to false, the serial column will not be displayed.

Protected Properties

Property	Type	Description
$_columns		the grid columns

Public Methods

Method	Description
init ( )
run ( )

Protected Methods

Method	Description
checkValidSetting ( string $attr, array $settings, string $key, string $type )	Checks if a setting is of valid type and throws exception if not.
getCellValue ( string $attribute, mixed $settings ) : string	Generates a cell value.
getStaticInput ( string $type, Model $model, integer $index, array $settings, string $attribute, Formatter $formatter ) : string	Generates the static input
initActionColumn ( )	Initializes the action column.
initCheckboxColumn ( )	Initializes the checkbox column.
initColumn ( string $type )	Initializes special columns
initDataColumns ( )	Initializes the data columns.
initOptions ( )	Initializes the widget options
initSerialColumn ( )	Initializes the serial column.
isColumnSet ( string $type ) : boolean	Checks if a grid column is set correctly.
registerAssets ( )	Registers the TabularForm widget assets.
renderGrid ( ) : string	Render the grid content.
slash ( string $str = '' ) : string	Prepends with a back slash if necessary for full namespace validation.

Method Details

Property Details