Class kartik\builder\Form

All Classes | Properties | Methods | Events | Constants
Inheritancekartik\builder\Form » 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

Form is a builder widget for rendering the form attributes using kartik\form\ActiveForm. The widget uses Bootstrap 5.x, 4.x, or 3.x styling (depending on $bsVersion) for generating form styles and multiple field columns.

For example,

use kartik\form\ActiveForm;
use kartik\builder\Form;

$options = []; // $options is your ActiveForm configuration
$form = ActiveForm::begin($options);
echo Form::widget([
    'model' => $model, // your model
    'form' => $form,
    'columns' => 2,
    'attributes' => [
        'username' => ['type' => Form::INPUT_TEXT, 'options'=> ['placeholder'=>'Enter username...']],
        'password' => ['type' => Form::INPUT_PASSWORD],
        'rememberMe' => ['type' => Form::INPUT_CHECKBOX, 'enclosedByLabel' => true],
    ]
]);
ActiveForm::end();

Public Properties

Hide inherited properties

PropertyTypeDescriptionDefined By
$attributeDefaults array The default settings that will be applied for all attributes. kartik\builder\BaseForm
$attributes array The attribute settings. kartik\builder\BaseForm
$autoGenerateColumns boolean Calculate the number of columns automatically based on count of attributes configured in the kartik\builder\Form widget. kartik\builder\Form
$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\Form
$columnSize string The bootstrap device size for rendering each grid column. kartik\builder\Form
$columns integer The number of columns in which to split the fields horizontally. kartik\builder\Form
$compactGrid boolean Whether to use a compact row/column grid layout as supported by Bootstrap 4. kartik\builder\Form
$contentAfter string Content to display after the generated form fields. kartik\builder\Form
$contentBefore string Content to display before the generated form fields. kartik\builder\Form
$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
$encloseFieldSet boolean Whether to enclose and render the fieldset container kartik\builder\Form
$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
$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\base\Model The data model used for the form. kartik\builder\Form
$moduleId string The module identifier if this widget is part of a module. kartik\base\WidgetTrait
$options array The HTML attributes for the field / attributes container. kartik\builder\Form
$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\Form
$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
$_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\Form
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\Form
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
beginTag() Begins a tag markup based on orientation. kartik\builder\Form
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
configureBsVersion() Configures the bootstrap version settings kartik\base\BootstrapTrait
endTag() Ends a tag markup based on orientation. kartik\builder\Form
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
getInput() Generates the active field input by parsing the label and hint. kartik\builder\BaseForm
getPluginScript() Returns the plugin registration script. kartik\base\WidgetTrait
getSubAttributesContent() Gets sub attribute markup content. kartik\builder\Form
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
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
initOptions() Initializes the kartik\builder\Form widget options. kartik\builder\Form
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
parseInput() Parses the input markup based on type. kartik\builder\Form
parseVer() Parses and returns the major BS version kartik\base\BootstrapTrait
prepareAttributes() Prepares attributes based on visibility setting kartik\builder\BaseForm
raise() Triggers and raises an kartik\builder\ActiveFormEvent. kartik\builder\Form
registerAssets() Registers the client assets for the kartik\builder\Form widget. kartik\builder\Form
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
renderFieldSet() Renders each field set within the form. kartik\builder\Form
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\BaseForm
renderRawInput() Renders raw form input based on the attribute settings. kartik\builder\BaseForm
renderSubAttributes() Render sub attributes. kartik\builder\Form
setDataVar() Sets a HTML5 data variable. kartik\base\WidgetTrait

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
EVENT_AFTER_PARSE_INPUT 'eAfterParseInput' kartik\builder\Form
EVENT_AFTER_RENDER_SUB_ATTR 'eAfterRenderSubAttr' kartik\builder\Form
EVENT_BEFORE_PARSE_INPUT 'eBeforeParseInput' kartik\builder\Form
EVENT_BEFORE_RENDER_SUB_ATTR 'eBeforeRenderSubAttr' kartik\builder\Form
GRID_WIDTH 12 kartik\builder\Form
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

$autoGenerateColumns public property

Calculate the number of columns automatically based on count of attributes configured in the kartik\builder\Form widget. Columns will be created maximum upto the GRID_WIDTH.

public boolean $autoGenerateColumns = false
$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.

public string $columnSize = self::SIZE_SMALL
$columns public property

The number of columns in which to split the fields horizontally. If not set, defaults to 1 column.

public integer $columns = 1
$compactGrid public property

Whether to use a compact row/column grid layout as supported by Bootstrap 4.x via form-row class. Supported only when $bsVersion = '4.x' or $bsVersion = '5.x'

See also:

public boolean $compactGrid = false
$contentAfter public property

Content to display after the generated form fields. This is not HTML encoded.

public string $contentAfter = ''
$contentBefore public property

Content to display before the generated form fields. This is not HTML encoded.

public string $contentBefore = ''
$encloseFieldSet public property

Whether to enclose and render the fieldset container

public boolean $encloseFieldSet = false
$model public property

The data model used for the form.

public yii\base\Model $model = null
$options 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.
public array $options = []
$rowOptions public property

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

public array $rowOptions = []

Method Details

beginTag() protected method

Begins a tag markup based on orientation.

protected string beginTag ( $tag, $options = [], $skip = false )
$tag string

The HTML tag
$options array

The HTML attributes for the tag
$skip boolean

Whether to skip the tag generation
endTag() protected method

Ends a tag markup based on orientation.

protected string endTag ( $tag, $skip = false )
$tag string

The HTML tag
$skip boolean

Whether to skip the tag generation
getSubAttributesContent() protected method

Gets sub attribute markup content.

protected string getSubAttributesContent ( $settings, $index )
$settings array

The attribute settings
$index string

The zero-based index of the attribute
throws yii\base\InvalidConfigException
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
initOptions() protected method

Initializes the kartik\builder\Form widget options.

protected void initOptions ( )
parseInput() protected method

Parses the input markup based on type.

protected string parseInput ( $attribute, $settings, $index )
$attribute string

The model attribute.
$settings array

The column settings.
$index integer

The row index.
return string

The generated input.
throws yii\base\InvalidConfigException
raise() protected method

Triggers and raises an kartik\builder\ActiveFormEvent.

protected void raise ( $event = '', $attribute = '', $index = '', $data = [] )
$event string

The event name.
$attribute string

The attribute name.
$index integer|string

The row index.
$data array

The event data to pass to the event.
registerAssets() protected method

Registers the client assets for the kartik\builder\Form widget.

protected void registerAssets ( )
renderFieldSet() protected method

Renders each field set within the form.

protected string renderFieldSet ( )
throws yii\base\InvalidConfigException
renderSubAttributes() protected method

Render sub attributes.

protected string renderSubAttributes ( $settings, $index )
$settings array

The attribute settings
$index string

The zero-based index of the attribute
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