Property | Type | Description | |
---|---|---|---|
$attributeOptions | client-side options of the attribute, e.g. enableAjaxValidation. You can use this property for custom configuration of the column (attribute). By default, the column will use options which are defined on widget level. | ||
$context | the context of using a column. It is an instance of widget(MultipleInput or TabularInput). | ||
$defaultValue | default value for input | ||
$enableError | whether to render inline error for the input. Default to false | ||
$errorOptions | the default options for the error tag | ||
$headerOptions | the HTML attributes for the header cell tag. | ||
$items | items which used for rendering input with multiple choice, e.g. dropDownList. It can be an array or anonymous function with following signature: 'columns' => [ ... [ 'name' => 'column', 'items' => function($data) { do your magic } .... ] ... | ||
$name | input name | ||
$options | array | ||
$renderer | the renderer instance | ||
$title | the header cell content. Note that it will not be HTML-encoded. | ||
$type | input type | ||
$value | string | Closure |
Method | Description | |
---|---|---|
getElementId ( null | integer $index = null ) : mixed | Returns element id. | |
getElementName ( integer | null $index, boolean $withPrefix = true ) : string | Returns element's name. | |
getFirstError ( $index ) : mixed | ||
getModel ( ) : |
||
init ( ) | ||
isHiddenInput ( ) : boolean | ||
renderError ( string $error ) : string | Renders an error. | |
renderInput ( string $name, array $options ) : string | Renders the input. | |
setModel ( |
Method | Description | |
---|---|---|
ensureModel ( $model ) | ||
isEmpty ( $value ) | ||
prepareValue ( ) : mixed | Prepares the value of column. | |
renderCheckbox ( string $name, mixed $value, array $options ) : string | Renders checkbox. | |
renderCheckboxList ( string $name, mixed $value, array $options ) : string | Renders checkbox list. | |
renderDefault ( $name, $value, $options ) : string | Renders an input. | |
renderDropDownList ( $name, $value, $options ) : string | Renders drop down list. | |
renderHiddenInput ( string $name, mixed $value, array $options ) : string | Renders hidden input. | |
renderListBox ( string $name, mixed $value, array $options ) : string | Renders list box. | |
renderRadio ( string $name, mixed $value, array $options ) : string | Renders radio button. | |
renderRadioList ( string $name, mixed $value, array $options ) : string | Renders radio button list. | |
renderStatic ( $name, $value, $options ) : string | ||
renderWidget ( $type, $name, $value, $options ) : mixed | Renders a widget. |
Method | Description | |
---|---|---|
normalize ( $name ) : mixed | Normalization name. | |
prepareItems ( mixed $items ) : array | Closur\Closure | mixed | Returns the items for list. |
abstract public getFirstError ( $index ) : mixed | ||
$index | ||
return | mixed |
public isHiddenInput ( ) : boolean | ||
return | boolean | whether the type of column is hidden input. |
protected prepareValue ( ) : mixed | ||
return | mixed |
protected renderDefault ( $name, $value, $options ) : string | ||
$name | ||
$value | ||
$options | ||
return | string |
protected renderDropDownList ( $name, $value, $options ) : string | ||
$name | ||
$value | ||
$options | ||
return | string |
public renderError ( string $error ) : string | ||
$error | string | |
return | string |
protected renderStatic ( $name, $value, $options ) : string | ||
$name | ||
$value | ||
$options | ||
return | string |
protected renderWidget ( $type, $name, $value, $options ) : mixed | ||
$type | ||
$name | ||
$value | ||
$options | ||
return | mixed |
public $attributeOptions |
public $context |
public $enableError |
public $headerOptions |
public $items |
public $title |