TbExtendedGridView Class Reference

Inheritance diagram for TbExtendedGridView:

Collaboration diagram for TbExtendedGridView:

Public Member Functions
	init ()
	renderContent ()
	renderKeys ()
	renderTableHeader ()
	renderBulkActions ()
	renderChart ()
	renderTableRow ($row)
	renderExtendedSummary ()

Public Attributes
	$fixedHeader = false
	$headerOffset = 0
	$template = "{summary}\n{items}\n{pager}\n{extendedSummary}"
	$extendedSummary = array()
	$extendedSummaryCssClass = 'extended-summary'
	$extendedSummaryOptions = array()
	$componentsAfterAjaxUpdate = array()
	$componentsReadyScripts = array()
	$chartOptions = array()
	$sortableRows = false
	$sortableAttribute = 'sort_order'
	$sortableAjaxSave = false
	$sortableAction
	$afterSortableUpdate
	$selectableCells = false
	$selectableCellsFilter = 'td'
	$afterSelectableCells
	$bulkActions = array()
	$bulkActionAlign = 'right'
Public Attributes inherited from TbGridView
const	TYPE_STRIPED = 'striped'
const	TYPE_BORDERED = 'bordered'
const	TYPE_CONDENSED = 'condensed'
const	TYPE_HOVER = 'hover'
	$type
	$pagerCssClass = 'no-class'
	$pager = array('class' => 'booster.widgets.TbPager')
	$cssFile = false
	$responsiveTable = false
	$extraParams = array()

Protected Member Functions
	getAttribute ($data, $attribute)
	getPrimaryKey ($data)
	parseColumnValue ($column, $row)
	getSummaryOperationInstance ($name, $config)
	getColumnByName ($name)
Protected Member Functions inherited from TbGridView
	initColumns ()
	createDataColumn ($text)

Protected Attributes
	$bulk
	$displayExtendedSummary
	$displayChart
	$extendedSummaryTypes = array()
	$extendedSummaryOperations

Detailed Description

Definition at line 27 of file TbExtendedGridView.php.

Member Function Documentation

TbExtendedGridView::getAttribute (   $data,   $attribute  )

protected

.getAttribute()

Helper function to get an attribute from the data

Parameters

CActiveRecord	$data
string	$attribute	the attribute to get

Returns

mixed the attribute value null if none found

Definition at line 290 of file TbExtendedGridView.php.

Here is the caller graph for this function:

TbExtendedGridView::getColumnByName (   $name )

protected

.getColumnByName()

Helper function to get a column by its name

Parameters

string

$name

Returns

CDataColumn|null

Definition at line 863 of file TbExtendedGridView.php.

TbExtendedGridView::getPrimaryKey (   $data )

protected

.getPrimaryKey()

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

Parameters

CActiveRecord

$data

Returns

null|string

Definition at line 317 of file TbExtendedGridView.php.

Here is the caller graph for this function:

TbExtendedGridView::getSummaryOperationInstance (   $name,   $config  )

protected

.getSummaryOperationInstance()

Each type of 'extended' summary

Parameters

string	$name	the name of the column
array	$config	the configuration of the column at the extendedSummary

Returns

mixed

Exceptions

CException

Definition at line 829 of file TbExtendedGridView.php.

TbExtendedGridView::init

(

)

.init()

Widget initialization

Reimplemented from TbGridView.

Definition at line 208 of file TbExtendedGridView.php.

TbExtendedGridView::parseColumnValue (   $column,   $row  )

protected

.parseColumnValue()

Parameters

CDataColumn	$column
integer	$row	the current row number

Returns

string

Definition at line 799 of file TbExtendedGridView.php.

TbExtendedGridView::renderBulkActions

(

)

.renderBulkActions()

Definition at line 376 of file TbExtendedGridView.php.

Here is the call graph for this function:

TbExtendedGridView::renderChart

(

)

.renderChart()

Renders chart

Exceptions

CException

Definition at line 392 of file TbExtendedGridView.php.

TbExtendedGridView::renderContent

(

)

.renderContent()

Renders grid content

Definition at line 242 of file TbExtendedGridView.php.

TbExtendedGridView::renderExtendedSummary

(

)

.renderExtendedSummary()

Renders summary

Definition at line 643 of file TbExtendedGridView.php.

TbExtendedGridView::renderKeys

(

)

.renderKeys()

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

Definition at line 253 of file TbExtendedGridView.php.

Here is the call graph for this function:

TbExtendedGridView::renderTableHeader

(

)

.renderTableHeader()

Renders grid header

Definition at line 336 of file TbExtendedGridView.php.

TbExtendedGridView::renderTableRow

(

$row

)

.renderTableRow()

Renders a table body row.

Parameters

integer

$row

the row number (zero-based).

Definition at line 598 of file TbExtendedGridView.php.

Member Data Documentation

TbExtendedGridView::$afterSelectableCells

Definition at line 160 of file TbExtendedGridView.php.

TbExtendedGridView::$afterSortableUpdate

Definition at line 142 of file TbExtendedGridView.php.

TbExtendedGridView::$bulk

protected

Definition at line 175 of file TbExtendedGridView.php.

TbExtendedGridView::$bulkActionAlign = 'right'

Definition at line 170 of file TbExtendedGridView.php.

TbExtendedGridView::$bulkActions = array()

Definition at line 165 of file TbExtendedGridView.php.

TbExtendedGridView::$chartOptions = array()

Definition at line 106 of file TbExtendedGridView.php.

TbExtendedGridView::$componentsAfterAjaxUpdate = array()

Definition at line 94 of file TbExtendedGridView.php.

TbExtendedGridView::$componentsReadyScripts = array()

Definition at line 101 of file TbExtendedGridView.php.

TbExtendedGridView::$displayChart

protected

Definition at line 185 of file TbExtendedGridView.php.

TbExtendedGridView::$displayExtendedSummary

protected

Definition at line 181 of file TbExtendedGridView.php.

TbExtendedGridView::$extendedSummary = array()

Definition at line 77 of file TbExtendedGridView.php.

TbExtendedGridView::$extendedSummaryCssClass = 'extended-summary'

Definition at line 82 of file TbExtendedGridView.php.

TbExtendedGridView::$extendedSummaryOperations

protected

Initial value:

 array(
                'TbSumOperation',
                'TbCountOfTypeOperation',
                'TbPercentOfTypeOperation',
                'TbPercentOfTypeEasyPieOperation',
                'TbPercentOfTypeGooglePieOperation'
        )

Definition at line 195 of file TbExtendedGridView.php.

TbExtendedGridView::$extendedSummaryOptions = array()

Definition at line 87 of file TbExtendedGridView.php.

TbExtendedGridView::$extendedSummaryTypes = array()

protected

Definition at line 190 of file TbExtendedGridView.php.

TbExtendedGridView::$fixedHeader = false

Definition at line 32 of file TbExtendedGridView.php.

TbExtendedGridView::$headerOffset = 0

Definition at line 39 of file TbExtendedGridView.php.

TbExtendedGridView::$selectableCells = false

Definition at line 147 of file TbExtendedGridView.php.

TbExtendedGridView::$selectableCellsFilter = 'td'

Definition at line 154 of file TbExtendedGridView.php.

TbExtendedGridView::$sortableAction

Definition at line 135 of file TbExtendedGridView.php.

TbExtendedGridView::$sortableAjaxSave = false

Definition at line 122 of file TbExtendedGridView.php.

TbExtendedGridView::$sortableAttribute = 'sort_order'

Definition at line 116 of file TbExtendedGridView.php.

TbExtendedGridView::$sortableRows = false

Definition at line 111 of file TbExtendedGridView.php.

TbExtendedGridView::$template = "{summary}\n{items}\n{pager}\n{extendedSummary}"

Definition at line 46 of file TbExtendedGridView.php.

---

The documentation for this class was generated from the following file:

• app/protected/extensions/booster/widgets/TbExtendedGridView.php