PHP Class TbExtendedGridView

Features are: - Display an extended summary of the records shown. The extended summary can be configured to any of the {@link TbOperation} type of widgets. - Automatic chart display (using TbHighCharts widget), where user can 'switch' between views. - Selectable cells - Sortable rows

Inheritance: extends TbGridView

Mostrar archivo Open project: yinhe/yincart Class Usage Examples

Public Properties

Property	Type	Description
$afterSelectableCells		a javascript function that will be invoked after a selection is done. The function signature is `function(selected)` where 'selected' refers to the selected columns.
$afterSortableUpdate		a javascript function that will be invoked after a successful sorting is done. The function signature is `function(id, position)` where 'id' refers to the ID of the model id key, 'position' the new position in the list.
$bulkActionAlign		the aligment of the bulk actions. It can be 'left' or 'right'.
$bulkActions		the configuration options to display a TbBulkActions widget
$chartOptions	array	if configured, the extended view will display a highcharts chart.
$componentsAfterAjaxUpdate	array	has scripts that will be executed after components have updated. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array.
$componentsReadyScripts	array	hold scripts that will be executed on document ready. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array.
$extendedSummary	array	displays an extended summary version. There are different types of summary types, please, see {@link TbSumOperation}, {@link TbSumOfTypeOperation},{@link TbPercentOfTypeGooglePieOperation} {@link TbPercentOfTypeOperation} and {@link TbPercentOfTypeEasyPieOperation}. The following is an example, please review the different types of TbOperation classes to find out more about its configuration parameters. 'extendedSummary' => array( 'title' => '', // the extended summary title 'columns' => array( // the 'columns' that will be displayed at the extended summary 'id' => array( // column name "id" 'class' => 'TbSumOperation', // what is the type of TbOperation we are going to display 'label' => 'Sum of Ids' // label is name of label of the resulted value (ie Sum of Ids:) ), 'results' => array( // column name "results" 'class' => 'TbPercentOfTypeGooglePieOperation', // the type of TbOperation 'label' => 'How Many Of Each? ', // the label of the operation 'types' => array( // TbPercentOfTypeGooglePieOperation "types" attributes '0' => array('label' => 'zeros'), // a value of "0" will be labelled "zeros" '1' => array('label' => 'ones'), // a value of "1" will be labelled "ones" '2' => array('label' => 'twos')) // a value of "2" will be labelled "twos" ) ) ),
$extendedSummaryCssClass	string	is the class name of the layer containing the extended summary
$extendedSummaryOptions	array	the HTML attributes of the layer containing the extended summary
$fixedHeader	boolean	if set to true will keep the header fixed position
$headerOffset	integer
$selectableCells		whether to allow selecting of cells
$selectableCellsFilter		the filter to use to allow selection. For example, if you set the "htmlOptions" property of a column to have a "class" of "tobeselected", you could set this property as: "td.tobeselected" in order to allow selection to those columns with that class only.
$sortableAction		Name of the action to call and sort values
$sortableAjaxSave		Save sort order by ajax defaults to false
$sortableAttribute		Database field name for row sorting
$sortableRows	boolean
$template		the template to be used to control the layout of various sections in the view. These tokens are recognized: {extendedSummary}, {summary}, {items} and {pager}. They will be replaced with the extended summary, summary text, the items, and the pager.

Protected Properties

Property	Type	Description
$bulk		component that will display the bulk actions to the grid
$displayChart	boolean	a helper property that is set to true if we have to render a chart.
$displayExtendedSummary	boolean	a helper property that is set to true if we have to render the extended summary
$extendedSummaryOperations	array	hold the supported operation types
$extendedSummaryTypes	TbOperation[]	hold the current configured TbOperation that will process column values.

Public Methods

Method	Description
init ( )	### .init()
registerCustomClientScript ( )	### .registerCustomClientScript()
renderBulkActions ( )	### .renderBulkActions()
renderChart ( )	### .renderChart()
renderContent ( )	### .renderContent()
renderExtendedSummary ( )	### .renderExtendedSummary()
renderExtendedSummaryContent ( )	### .renderExtendedSummaryContent()
renderKeys ( )	### .renderKeys()
renderTableFooter ( )	### .renderTableFooter()
renderTableHeader ( )	### .renderTableHeader()
renderTableRow ( integer $row )	### .renderTableRow()

Protected Methods

Method	Description
getAttribute ( CActiveRecord $data, string $attribute ) : mixed	### .getAttribute()
getColumnByName ( string $name ) : CDataColumn \| null	### .getColumnByName()
getPrimaryKey ( CActiveRecord $data ) : null \| string	### .getPrimaryKey()
getSummaryOperationInstance ( string $name, array $config ) : mixed	### .getSummaryOperationInstance()
parseColumnValue ( CDataColumn $column, integer $row ) : string	### .parseColumnValue()

Method Details

getAttribute() protected method

Helper function to get an attribute from the data

protected getAttribute ( CActiveRecord $data, string $attribute ) : mixed
$data	CActiveRecord
$attribute	string	the attribute to get
return	mixed	the attribute value null if none found

getColumnByName() protected method

Helper function to get a column by its name

protected getColumnByName ( string $name ) : CDataColumn \| null
$name	string
return	CDataColumn \| null

getPrimaryKey() protected method

Helper function to return the primary key of the $data IMPORTANT: composite keys on CActiveDataProviders will return the keys joined by comma

protected getPrimaryKey ( CActiveRecord $data ) : null \| string
$data	CActiveRecord
return	null \| string

getSummaryOperationInstance() protected method

Each type of 'extended' summary

protected getSummaryOperationInstance ( string $name, array $config ) : mixed
$name	string	the name of the column
$config	array	the configuration of the column at the extendedSummary
return	mixed

init() public method

Widget initialization

public init ( )

parseColumnValue() protected method

### .parseColumnValue()

protected parseColumnValue ( CDataColumn $column, integer $row ) : string
$column	CDataColumn
$row	integer	the current row number
return	string

registerCustomClientScript() public method

This script must be run at the end of content rendering not at the beginning as it is common with normal CGridViews

public registerCustomClientScript ( )

renderBulkActions() public method

### .renderBulkActions()

public renderBulkActions ( )

renderChart() public method

Renders chart

public renderChart ( )

renderContent() public method

Renders grid content

public renderContent ( )

renderExtendedSummary() public method

Renders summary

public renderExtendedSummary ( )

renderExtendedSummaryContent() public method

Renders summary content. Will be appended to

public renderExtendedSummaryContent ( )

renderKeys() public method

Renders the key values of the data in a hidden tag.

public renderKeys ( )

renderTableFooter() public method

Renders the table footer.

public renderTableFooter ( )

renderTableHeader() public method

Renders grid header

public renderTableHeader ( )

renderTableRow() public method

Renders a table body row.

public renderTableRow ( integer $row )
$row	integer	the row number (zero-based).

Property Details

$afterSelectableCells public_oe property

a javascript function that will be invoked after a selection is done. The function signature is function(selected) where 'selected' refers to the selected columns.

public $afterSelectableCells

$afterSortableUpdate public_oe property

a javascript function that will be invoked after a successful sorting is done. The function signature is function(id, position) where 'id' refers to the ID of the model id key, 'position' the new position in the list.

public $afterSortableUpdate

$bulk protected_oe property

component that will display the bulk actions to the grid

protected $bulk

$bulkActionAlign public_oe property

the aligment of the bulk actions. It can be 'left' or 'right'.

public $bulkActionAlign

$bulkActions public_oe property

the configuration options to display a TbBulkActions widget

See also: TbBulkActions widget for its configuration

public $bulkActions

$chartOptions public_oe property

if configured, the extended view will display a highcharts chart.

public array $chartOptions
return	array

$componentsAfterAjaxUpdate public_oe property

has scripts that will be executed after components have updated. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array.

public array $componentsAfterAjaxUpdate
return	array

$componentsReadyScripts public_oe property

hold scripts that will be executed on document ready. It is used internally to render scripts required for components to work correctly. You may use it for your own scripts, just make sure it is of type array.

public array $componentsReadyScripts
return	array

$displayChart protected_oe property

a helper property that is set to true if we have to render a chart.

protected bool $displayChart
return	boolean

$displayExtendedSummary protected_oe property

a helper property that is set to true if we have to render the extended summary

protected bool $displayExtendedSummary
return	boolean

$extendedSummary public_oe property

displays an extended summary version. There are different types of summary types, please, see {@link TbSumOperation}, {@link TbSumOfTypeOperation},{@link TbPercentOfTypeGooglePieOperation} {@link TbPercentOfTypeOperation} and {@link TbPercentOfTypeEasyPieOperation}. The following is an example, please review the different types of TbOperation classes to find out more about its configuration parameters.

 'extendedSummary' => array(
     'title' => '',      // the extended summary title
     'columns' => array( // the 'columns' that will be displayed at the extended summary
         'id' => array(  // column name "id"
             'class' => 'TbSumOperation', // what is the type of TbOperation we are going to display
             'label' => 'Sum of Ids'     // label is name of label of the resulted value (ie Sum of Ids:)
         ),
         'results' => array(   // column name "results"
             'class' => 'TbPercentOfTypeGooglePieOperation', // the type of TbOperation
             'label' => 'How Many Of Each? ', // the label of the operation
             'types' => array(               // TbPercentOfTypeGooglePieOperation "types" attributes
                 '0' => array('label' => 'zeros'),   // a value of "0" will be labelled "zeros"
                 '1' => array('label' => 'ones'),    // a value of "1" will be labelled "ones"
                 '2' => array('label' => 'twos'))    // a value of "2" will be labelled "twos"
         )
     )
),

public array $extendedSummary
return	array

$extendedSummaryCssClass public_oe property

is the class name of the layer containing the extended summary

public string $extendedSummaryCssClass
return	string

$extendedSummaryOperations protected_oe property

hold the supported operation types

protected array $extendedSummaryOperations
return	array

$extendedSummaryOptions public_oe property

the HTML attributes of the layer containing the extended summary

public array $extendedSummaryOptions
return	array

$extendedSummaryTypes protected_oe property

hold the current configured TbOperation that will process column values.

protected TbOperation[] $extendedSummaryTypes
return	TbOperation[]

$fixedHeader public_oe property

if set to true will keep the header fixed position

public bool $fixedHeader
return	boolean

$headerOffset public_oe property

public int $headerOffset
return	integer

$selectableCells public_oe property

whether to allow selecting of cells

public $selectableCells

$selectableCellsFilter public_oe property

the filter to use to allow selection. For example, if you set the "htmlOptions" property of a column to have a "class" of "tobeselected", you could set this property as: "td.tobeselected" in order to allow selection to those columns with that class only.

public $selectableCellsFilter

$sortableAction public_oe property

Name of the action to call and sort values

public $sortableAction

$sortableAjaxSave public_oe property

Save sort order by ajax defaults to false

public $sortableAjaxSave

$sortableAttribute public_oe property

Database field name for row sorting

public $sortableAttribute

$sortableRows public_oe property

public bool $sortableRows
return	boolean

$template public_oe property

the template to be used to control the layout of various sections in the view. These tokens are recognized: {extendedSummary}, {summary}, {items} and {pager}. They will be replaced with the extended summary, summary text, the items, and the pager.

public $template