ReportResultsGridView Class Reference

Inheritance diagram for ReportResultsGridView:
View ListViewInterface MatrixReportResultsGridView RowsAndColumnsReportResultsGridView SummationDrillDownReportResultsGridView SummationReportResultsGridView

Public Member Functions

 __construct ($controllerId, $moduleId, ReportDataProvider $dataProvider, $gridIdSuffix=null, $gridViewPagerParams=array())
 getGridViewId ()
 getLinkString ($attributeString, $attribute)
 getSummaryCloneId ()

Protected Member Functions

 getShouldRenderMultipleLinksByReportDataProvider (ReportDataProvider $dataProvider)
 renderContent ()
 renderResultsGridContent ()
 getGridViewWidgetPath ()
 getCGridViewParams ()
 getCGridViewPagerParams ()
 resolveDefaultGridViewPagerParams ($defaultGridViewPagerParams)
 getShowTableOnEmpty ()
 getEmptyText ()
 getCGridViewColumns ()
 resolveColumnClassNameForListViewColumnAdapter (DisplayAttributeForReportForm $displayAttribute)
 resolveParamsForColumnElement (DisplayAttributeForReportForm $displayAttribute)
 getCGridViewBeforeAjaxUpdate ()
 getCGridViewAfterAjaxUpdate ()
 renderScripts ()
 rowsAreExpandable ()
 getLeadingHeaders ()

Static Protected Member Functions

static getGridTemplate ()
static getPagerCssClass ()
static getSummaryText ()
static getSummaryCssClass ()

Protected Attributes

 $controllerId
 $moduleId
 $dataProvider
 $rowsAreExpandable = false
 $gridId
 $gridIdSuffix
 $gridViewPagerParams = array()
 $emptyText = null

Detailed Description

Base class for working with report results in a grid

Definition at line 40 of file ReportResultsGridView.php.


Constructor & Destructor Documentation

__construct ( controllerId,
moduleId,
ReportDataProvider dataProvider,
gridIdSuffix = null,
gridViewPagerParams = array() 
)
Parameters:
string $controllerId
string $moduleId
ReportDataProvider $dataProvider
null|string $gridIdSuffix
array $gridViewPagerParams

Definition at line 92 of file ReportResultsGridView.php.


Member Function Documentation

getGridViewId (  ) 
Returns:
string

Definition at line 112 of file ReportResultsGridView.php.

getLinkString ( attributeString,
attribute 
)
Parameters:
string $attributeString
string $attribute
Returns:
string

Implements ListViewInterface.

Definition at line 122 of file ReportResultsGridView.php.

static getGridTemplate (  )  [static, protected]
Returns:
string

Definition at line 142 of file ReportResultsGridView.php.

static getPagerCssClass (  )  [static, protected]
Returns:
string

Reimplemented in SummationDrillDownReportResultsGridView.

Definition at line 151 of file ReportResultsGridView.php.

static getSummaryText (  )  [static, protected]
Returns:
string

Definition at line 159 of file ReportResultsGridView.php.

static getSummaryCssClass (  )  [static, protected]
Returns:
string

Definition at line 167 of file ReportResultsGridView.php.

renderContent (  )  [protected]
Returns:
string
Exceptions:
NotSupportedException if the data provider is not valid

Reimplemented from View.

Definition at line 176 of file ReportResultsGridView.php.

renderResultsGridContent (  )  [protected]
Returns:
string

Reimplemented in MatrixReportResultsGridView.

Definition at line 188 of file ReportResultsGridView.php.

getGridViewWidgetPath (  )  [protected]
Returns:
string

Definition at line 202 of file ReportResultsGridView.php.

getCGridViewParams (  )  [protected]
Returns:
array

Definition at line 210 of file ReportResultsGridView.php.

getCGridViewPagerParams (  )  [protected]
Returns:
array

Reimplemented in SummationDrillDownReportResultsGridView.

Definition at line 242 of file ReportResultsGridView.php.

resolveDefaultGridViewPagerParams ( defaultGridViewPagerParams  )  [protected]
Parameters:
$defaultGridViewPagerParams 
Returns:
array

Definition at line 260 of file ReportResultsGridView.php.

getShowTableOnEmpty (  )  [protected]
Returns:
bool

Definition at line 275 of file ReportResultsGridView.php.

getEmptyText (  )  [protected]
Returns:
null|string

Definition at line 283 of file ReportResultsGridView.php.

getCGridViewColumns (  )  [protected]

Get the meta data and merge with standard CGridView column elements to create a column array that fits the CGridView columns API

Returns:
array

Reimplemented in MatrixReportResultsGridView.

Definition at line 293 of file ReportResultsGridView.php.

resolveColumnClassNameForListViewColumnAdapter ( DisplayAttributeForReportForm displayAttribute  )  [protected]
Parameters:
DisplayAttributeForReportForm $displayAttribute
Returns:
string

Definition at line 342 of file ReportResultsGridView.php.

resolveParamsForColumnElement ( DisplayAttributeForReportForm displayAttribute  )  [protected]
Parameters:
DisplayAttributeForReportForm $displayAttribute
Returns:
array

Definition at line 359 of file ReportResultsGridView.php.

getCGridViewBeforeAjaxUpdate (  )  [protected]
Returns:
string

Definition at line 378 of file ReportResultsGridView.php.

getCGridViewAfterAjaxUpdate (  )  [protected]

Do not run global eval, since it causes doubling up of ajax requests on the pager. (non-PHPdoc)

See also:
ListView::getCGridViewAfterAjaxUpdate()

Definition at line 388 of file ReportResultsGridView.php.

rowsAreExpandable (  )  [protected]
Returns:
bool

Reimplemented in SummationDrillDownReportResultsGridView.

Definition at line 407 of file ReportResultsGridView.php.

getLeadingHeaders (  )  [protected]

Override in child as needed

Reimplemented in MatrixReportResultsGridView.

Definition at line 419 of file ReportResultsGridView.php.


Field Documentation

$gridIdSuffix [protected]

Additional unique identifier.

See also:
$gridId

Definition at line 73 of file ReportResultsGridView.php.

$gridViewPagerParams = array() [protected]

Array containing CGridViewPagerParams

Definition at line 78 of file ReportResultsGridView.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Oct 21 07:10:29 2017