PHP Class skeeks\cms\grid\BooleanColumn

Inheritance: extends yii\grid\DataColumn
Show file Open project: skeeks-cms/cms Class Usage Examples

Public Properties

Property Type Description
$falseIcon icon/indicator for the false value. If this is null, it will use the value from falseLabel. If GridView bootstrap property is set to true - it will default to [[GridView::ICON_INACTIVE]]
$falseLabel label for the false value. Defaults to Inactive.
$falseValue null
$format in which format should the value of each data model be displayed Defaults to raw. [[\yii\base\Formatter::format()]] or [[\yii\i18n\Formatter::format()]] is used.
$hAlign the horizontal alignment of each column. Should be one of 'left', 'right', or 'center'. Defaults to center.
$pageSummary the page summary that is displayed above the footer. Defaults to false.
$showNullAsFalse whether to show null value as a false icon.
$trueIcon icon/indicator for the true value. If this is not set, it will use the value from trueLabel. If GridView bootstrap property is set to true - it will default to [[GridView::ICON_ACTIVE]]
$trueLabel label for the true value. Defaults to Active.
$trueValue
$width the width of each column (matches the CSS width property). Defaults to 90px.

Public Methods

Method Description
getDataCellValue ( $model, $key, $index )
init ( )

Method Details

getDataCellValue() public method

public getDataCellValue ( $model, $key, $index )

init() public method

public init ( )

Property Details

$falseIcon public property

icon/indicator for the false value. If this is null, it will use the value from falseLabel. If GridView bootstrap property is set to true - it will default to [[GridView::ICON_INACTIVE]]
public $falseIcon

$falseLabel public property

label for the false value. Defaults to Inactive.
public $falseLabel

$falseValue public property

public null $falseValue
return null

$format public property

in which format should the value of each data model be displayed Defaults to raw. [[\yii\base\Formatter::format()]] or [[\yii\i18n\Formatter::format()]] is used.
public $format

$hAlign public property

the horizontal alignment of each column. Should be one of 'left', 'right', or 'center'. Defaults to center.
public $hAlign

$pageSummary public property

the page summary that is displayed above the footer. Defaults to false.
public $pageSummary

$showNullAsFalse public property

whether to show null value as a false icon.
public $showNullAsFalse

$trueIcon public property

icon/indicator for the true value. If this is not set, it will use the value from trueLabel. If GridView bootstrap property is set to true - it will default to [[GridView::ICON_ACTIVE]]
public $trueIcon

$trueLabel public property

label for the true value. Defaults to Active.
public $trueLabel

$trueValue public property

public $trueValue

$width public property

the width of each column (matches the CSS width property). Defaults to 90px.
See also: http://www.w3schools.com/cssref/pr_dim_width.asp
public $width