Public Member Functions | |
getRowKey () | |
attributeNames () | |
__set ($name, $value) | |
rules () | |
attributeLabels () | |
__construct ($moduleClassName, $modelClassName, $reportType, $rowKey=0) | |
getModelClassName () | |
getModuleClassName () | |
getReportType () | |
getAttributeIndexOrDerivedType () | |
getAttributeAndRelationData () | |
hasRelatedData () | |
getResolvedAttribute () | |
getResolvedAttributeModuleClassName () | |
getResolvedAttributeModelClassName () | |
getResolvedAttributeRealAttributeName () | |
getPenultimateModelClassName () | |
getPenultimateRelation () | |
getDisplayLabel () | |
makeResolvedAttributeModelRelationsAndAttributesToReportAdapter () | |
getDisplayElementType () | |
isATypeOfCurrencyValue () | |
![]() | |
isAttribute ($attributeName) | |
Static Public Member Functions | |
static | getType () |
Data Fields | |
const | DISPLAY_LABEL_RELATION_DIVIDER = '>>' |
const | TYPE_FILTERS = 'Filters' |
const | TYPE_DISPLAY_ATTRIBUTES = 'DisplayAttributes' |
const | TYPE_ORDER_BYS = 'OrderBys' |
const | TYPE_GROUP_BYS = 'GroupBys' |
const | TYPE_DRILL_DOWN_DISPLAY_ATTRIBUTES = 'DrillDownDisplayAttributes' |
Protected Member Functions | |
resolveAttributeOrRelationAndAttributeDataByIndexType ($indexType) | |
resolveAttributeFromData (Array $attributeAndRelationData) | |
resolveAttributeModuleClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName) | |
resolveAttributeModelClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName) | |
resolvePenultimateModelClassNameFromData (Array $attributeAndRelationData, $modelClassName) | |
resolvePenultimateRelationFromData (Array $attributeAndRelationData) | |
Protected Attributes | |
$moduleClassName | |
$modelClassName | |
$attributeAndRelationData | |
$reportType | |
Base class for managing report components. Filters, group bys, order bys, display attributes, Drill down display attributes all extend this class
Definition at line 41 of file ComponentForReportForm.php.
__construct | ( | $moduleClassName, | |
$modelClassName, | |||
$reportType, | |||
$rowKey = 0 |
|||
) |
string | $moduleClassName | |
string | $modelClassName | |
string | $reportType |
Definition at line 170 of file ComponentForReportForm.php.
|
static |
Override in children class to
NotImplementedException |
Definition at line 112 of file ComponentForReportForm.php.
attributeNames | ( | ) |
Definition at line 125 of file ComponentForReportForm.php.
__set | ( | $name, | |
$value | |||
) |
Special override to handle setting attributeIndexOrDerivedType
string | $name | |
mixed | $value |
Definition at line 136 of file ComponentForReportForm.php.
rules | ( | ) |
Definition at line 152 of file ComponentForReportForm.php.
attributeLabels | ( | ) |
Definition at line 160 of file ComponentForReportForm.php.
getModelClassName | ( | ) |
Definition at line 185 of file ComponentForReportForm.php.
getModuleClassName | ( | ) |
Definition at line 193 of file ComponentForReportForm.php.
getReportType | ( | ) |
Definition at line 201 of file ComponentForReportForm.php.
getAttributeIndexOrDerivedType | ( | ) |
Definition at line 209 of file ComponentForReportForm.php.
getAttributeAndRelationData | ( | ) |
If the attribute is on a relation then attributeAndRelationData should be populated otherwise it will return the $this->attribute
Definition at line 219 of file ComponentForReportForm.php.
hasRelatedData | ( | ) |
An attribute on a relation such as from an Account, opportunities name would return true. whereas just from an Account, name would return false.
Definition at line 233 of file ComponentForReportForm.php.
getResolvedAttribute | ( | ) |
Resolves the attribute name for the relation. Both account name and account's opportunities name would resolve as just 'name'
Definition at line 247 of file ComponentForReportForm.php.
getResolvedAttributeModuleClassName | ( | ) |
In the case of account's opportunities name, the returned ModuleClassName would be OpportunitiesModule
Definition at line 260 of file ComponentForReportForm.php.
getResolvedAttributeModelClassName | ( | ) |
In the case of account's opportunities name, the returned ModelClassName would be Opportunity
Definition at line 274 of file ComponentForReportForm.php.
getResolvedAttributeRealAttributeName | ( | ) |
An example where the attribute is not the real attribute would be for a summation report with 'Count' defined as the attribute which corresponds to ModelRelationsAndAttributesToSummableReportAdapter::DISPLAY_CALCULATION_COUNT In this case the real attribute returned would be 'id'
Definition at line 289 of file ComponentForReportForm.php.
getPenultimateModelClassName | ( | ) |
An example of coming from Account -> opportunities name, the penultimate model would be Account
NotSupportedException |
Definition at line 303 of file ComponentForReportForm.php.
getPenultimateRelation | ( | ) |
An example of coming from Account -> opportunities name, the penultimate relation would be opportunities
NotSupportedException |
Definition at line 317 of file ComponentForReportForm.php.
getDisplayLabel | ( | ) |
Builds the display label based on either the attribute or attributeAndRelationData and returns the string content.
Definition at line 331 of file ComponentForReportForm.php.
makeResolvedAttributeModelRelationsAndAttributesToReportAdapter | ( | ) |
Definition at line 390 of file ComponentForReportForm.php.
getDisplayElementType | ( | ) |
Based on the attribute, what kind of display element should be utilized to render the attribute's value.
NotSupportedException |
Definition at line 402 of file ComponentForReportForm.php.
isATypeOfCurrencyValue | ( | ) |
Based on the attribute's displayElementType, is the displayElementType a currency type of display
Definition at line 416 of file ComponentForReportForm.php.
|
protected |
Passing in attributeIndexOrDerivedType, return an array representing the attribute and relation data or if there is just a single attribute, then return a string representing the attribute
string | $indexType |
Definition at line 433 of file ComponentForReportForm.php.
|
protected |
array | $attributeAndRelationData |
Definition at line 447 of file ComponentForReportForm.php.
|
protected |
array | $attributeAndRelationData | |
$moduleClassName | ||
$modelClassName |
Definition at line 459 of file ComponentForReportForm.php.
|
protected |
array | $attributeAndRelationData | |
$moduleClassName | ||
$modelClassName |
Definition at line 482 of file ComponentForReportForm.php.
|
protected |
array | $attributeAndRelationData | |
$modelClassName |
Definition at line 504 of file ComponentForReportForm.php.
|
protected |
array | $attributeAndRelationData |
Definition at line 525 of file ComponentForReportForm.php.
const DISPLAY_LABEL_RELATION_DIVIDER = '>>' |
Divider used for displaying labels that cross relations. An example is Account's >> Opportunities
Definition at line 46 of file ComponentForReportForm.php.
const TYPE_FILTERS = 'Filters' |
Component type for filters
Definition at line 51 of file ComponentForReportForm.php.
const TYPE_DISPLAY_ATTRIBUTES = 'DisplayAttributes' |
Component type for display attributes
Definition at line 56 of file ComponentForReportForm.php.
const TYPE_ORDER_BYS = 'OrderBys' |
Component type for order bys
Definition at line 61 of file ComponentForReportForm.php.
const TYPE_GROUP_BYS = 'GroupBys' |
Component type for group bys
Definition at line 66 of file ComponentForReportForm.php.
const TYPE_DRILL_DOWN_DISPLAY_ATTRIBUTES = 'DrillDownDisplayAttributes' |
Component type for drill down display attributes
Definition at line 71 of file ComponentForReportForm.php.