DisplayAttributeForReportForm Class Reference

Inheritance diagram for DisplayAttributeForReportForm:
ComponentForReportForm ConfigurableMetadataModel RowKeyInterface DrillDownDisplayAttributeForReportForm

Public Member Functions

 __construct ($moduleClassName, $modelClassName, $reportType, $rowKey=0)
 attributeNames ()
 rules ()
 __set ($name, $value)
 setModelAliasUsingTableAliasName ($modelAliasUsingTableAliasName)
 getModelAliasUsingTableAliasName ()
 resolveAttributeNameForGridViewColumn ($key)
 isALinkableAttribute ()
 getRawValueRelatedAttribute ()
 resolveValueAsLabelForHeaderCell ($value, $forExport=false)
 getHeaderSortableType ()

Static Public Member Functions

static getType ()
static resetCount ()

Data Fields

const COLUMN_ALIAS_PREFIX = 'col'
const HEADER_SORTABLE_TYPE_ASORT = 'asort'
 $label
 $columnAliasName
 $queryOnly = false
 $valueUsedAsDrillDownFilter = false
 $madeViaSelectInsteadOfViaModel = false

Protected Attributes

 $modelAliasUsingTableAliasName

Static Protected Attributes

static $count = 0

Detailed Description

Component form for display attribute definitions

Definition at line 40 of file DisplayAttributeForReportForm.php.


Constructor & Destructor Documentation

__construct ( moduleClassName,
modelClassName,
reportType,
rowKey = 0 
)

Sets the columnAliasName as unique across all instances of DisplayAttributeReportForms

Parameters:
string $moduleClassName
string $modelClassName
string $reportType
int $rowKey

Reimplemented from ComponentForReportForm.

Definition at line 107 of file DisplayAttributeForReportForm.php.


Member Function Documentation

static getType (  )  [static]
Returns:
string component type

Reimplemented from ComponentForReportForm.

Reimplemented in DrillDownDisplayAttributeForReportForm.

Definition at line 95 of file DisplayAttributeForReportForm.php.

attributeNames (  ) 

Makes sure the attributeIndexOrDerivedType always populates first before label otherwise any custom label gets wiped out. (non-PHPdoc)

See also:
ComponentForReportForm::attributeNames()

Reimplemented from ComponentForReportForm.

Definition at line 119 of file DisplayAttributeForReportForm.php.

rules (  ) 
Returns:
array

Reimplemented from ComponentForReportForm.

Definition at line 133 of file DisplayAttributeForReportForm.php.

__set ( name,
value 
)
Parameters:
string $name
mixed $value

Reimplemented from ComponentForReportForm.

Definition at line 145 of file DisplayAttributeForReportForm.php.

static resetCount (  )  [static]

Used primarily by testing to reset the count used to define the unique column alias names.

Definition at line 157 of file DisplayAttributeForReportForm.php.

setModelAliasUsingTableAliasName ( modelAliasUsingTableAliasName  ) 
Parameters:
$modelAliasUsingTableAliasName 

Definition at line 165 of file DisplayAttributeForReportForm.php.

getModelAliasUsingTableAliasName (  ) 
Returns:
string

Definition at line 174 of file DisplayAttributeForReportForm.php.

resolveAttributeNameForGridViewColumn ( key  ) 
Parameters:
$key 
Returns:
string

Definition at line 183 of file DisplayAttributeForReportForm.php.

isALinkableAttribute (  ) 

An example of a linkable attribute is if you run a report on contacts, and show a column of account names. The account name can be linkable to the account record.

Returns:
bool

Definition at line 199 of file DisplayAttributeForReportForm.php.

getRawValueRelatedAttribute (  ) 
Returns:
mixed

Definition at line 212 of file DisplayAttributeForReportForm.php.

resolveValueAsLabelForHeaderCell ( value,
forExport = false 
)

Raw values such as those used by the header x-axis or y-axis rows/columns need to be translated. An example is a dropdown where the value is the raw database value and needs to be properly translated for display. Another example is dynamic __User, where the value is the user id, and needs to be stringified to the User model.

Parameters:
$value 
Returns:
string

Definition at line 226 of file DisplayAttributeForReportForm.php.

getHeaderSortableType (  ) 

For matrix reports, months for example need to be sorted using asort so the columns or rows are sorted correctly. Eventually expand to support sorting by users and custom fields.

Returns:
string | null
Exceptions:
NotSupportedException 

Definition at line 298 of file DisplayAttributeForReportForm.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Sep 25 07:10:24 2017