PHP Class kartik\grid\SerialColumn

To add a SerialColumn to the gridview, add it to the [[GridView::columns|columns]] configuration as follows: php 'columns' => [ ... [ 'class' => SerialColumn::className(), you may configure additional properties here ], ]
Since: 1.0
Author: Kartik Visweswaran ([email protected])
Inheritance: extends yii\grid\SerialColumn, use trait ColumnTrait
Mostrar archivo Open project: kartik-v/yii2-grid Class Usage Examples

Public Properties

Property Type Description
$format in which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date', 'php:Y-m-d']). Supported formats are determined by the [[GridView::formatter|formatter]] used by the GridView. Default format is "text" which will format the value as an HTML-encoded plain text when Formatter is used as the [[GridView::$formatter|formatter]] of the GridView.
$hAlign the horizontal alignment of each column. Should be one of [[GridView::ALIGN_LEFT]], [[GridView::ALIGN_RIGHT]], or [[GridView::ALIGN_CENTER]].
$hidden whether the column is hidden from display. This is different than the visible property, in the sense, that the column is rendered, but hidden from display. This will allow you to still export the column using the export function.
$hiddenFromExport whether the column is hidden in export output. If set to boolean true, it will hide the column for all export formats. If set as an array, it will accept the list of GridView export formats and hide output only for them.
$hidePageSummary whether to just hide the page summary display but still calculate the summary based on [[pageSummary]] settings
$mergeHeader whether to merge the header title row and the filter row This will not render the filter for the column and can be used when filter is set to false. Defaults to false. This is only applicable when [[GridView::filterPosition]] for the grid is set to [[GridView::FILTER_POS_BODY]].
$noWrap whether to force no wrapping on all table cells in the column
$pageSummary the page summary that is displayed above the footer. You can set it to one of the following: - false: the summary will not be displayed. - true: the page summary for the column will be calculated and displayed using the [[pageSummaryFunc]] setting. - string: will be displayed as is. - Closure: you can set it to an anonymous function with the following signature: php example 1 function ($summary, $data, $widget) { return 'Count is ' . $summary; } example 2 function ($summary, $data, $widget) { return 'Range ' . min($data) . ' to ' . max($data); } where: - the $summary variable will be replaced with the calculated summary using the summaryFunc setting. - the $data variable will contain array of the selected page rows for the column.
$pageSummaryFunc the summary function that will be used to calculate the page summary for the column.
$pageSummaryOptions HTML attributes for the page summary cell. The following special attributes are available: - prepend: _string_, a prefix string that will be prepended before the pageSummary content - append: _string_, a suffix string that will be appended after the pageSummary content
$vAlign the vertical alignment of each column. Should be one of [[GridView::ALIGN_TOP]], [[GridView::ALIGN_BOTTOM]], or [[GridView::ALIGN_MIDDLE]].
$width the width of each column (matches the CSS width property).
$xlFormat the cell format for EXCEL exported content.

Protected Properties

Property Type Description
$_rows collection of row data for the column for the current page

Public Methods

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

Method Details

init() public method

public init ( )

renderDataCell() public method

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

Property Details

$_rows protected_oe property

collection of row data for the column for the current page
protected $_rows

$format public_oe property

in which format should the value of each data model be displayed as (e.g. "raw", "text", "html", ['date', 'php:Y-m-d']). Supported formats are determined by the [[GridView::formatter|formatter]] used by the GridView. Default format is "text" which will format the value as an HTML-encoded plain text when Formatter is used as the [[GridView::$formatter|formatter]] of the GridView.
public $format

$hAlign public_oe property

the horizontal alignment of each column. Should be one of [[GridView::ALIGN_LEFT]], [[GridView::ALIGN_RIGHT]], or [[GridView::ALIGN_CENTER]].
public $hAlign

$hidden public_oe property

whether the column is hidden from display. This is different than the visible property, in the sense, that the column is rendered, but hidden from display. This will allow you to still export the column using the export function.
public $hidden

$hiddenFromExport public_oe property

whether the column is hidden in export output. If set to boolean true, it will hide the column for all export formats. If set as an array, it will accept the list of GridView export formats and hide output only for them.
public $hiddenFromExport

$hidePageSummary public_oe property

whether to just hide the page summary display but still calculate the summary based on [[pageSummary]] settings
public $hidePageSummary

$mergeHeader public_oe property

whether to merge the header title row and the filter row This will not render the filter for the column and can be used when filter is set to false. Defaults to false. This is only applicable when [[GridView::filterPosition]] for the grid is set to [[GridView::FILTER_POS_BODY]].
public $mergeHeader

$noWrap public_oe property

whether to force no wrapping on all table cells in the column
See also: http://www.w3schools.com/cssref/pr_text_white-space.asp
public $noWrap

$pageSummary public_oe property

the page summary that is displayed above the footer. You can set it to one of the following: - false: the summary will not be displayed. - true: the page summary for the column will be calculated and displayed using the [[pageSummaryFunc]] setting. - string: will be displayed as is. - Closure: you can set it to an anonymous function with the following signature: php example 1 function ($summary, $data, $widget) { return 'Count is ' . $summary; } example 2 function ($summary, $data, $widget) { return 'Range ' . min($data) . ' to ' . max($data); } where: - the $summary variable will be replaced with the calculated summary using the summaryFunc setting. - the $data variable will contain array of the selected page rows for the column.
public $pageSummary

$pageSummaryFunc public_oe property

the summary function that will be used to calculate the page summary for the column.
public $pageSummaryFunc

$pageSummaryOptions public_oe property

HTML attributes for the page summary cell. The following special attributes are available: - prepend: _string_, a prefix string that will be prepended before the pageSummary content - append: _string_, a suffix string that will be appended after the pageSummary content
public $pageSummaryOptions

$vAlign public_oe property

the vertical alignment of each column. Should be one of [[GridView::ALIGN_TOP]], [[GridView::ALIGN_BOTTOM]], or [[GridView::ALIGN_MIDDLE]].
public $vAlign

$width public_oe property

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

$xlFormat public_oe property

the cell format for EXCEL exported content.
See also: http://cosicimiento.blogspot.in/2008/11/styling-excel-cells-with-mso-number.html
public $xlFormat