Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Protected Attributes
ComponentForReportForm Class Reference
Inheritance diagram for ComponentForReportForm:
ConfigurableMetadataModel RowKeyInterface DisplayAttributeForReportForm FilterForReportForm GroupByForReportForm OrderByForReportForm DrillDownDisplayAttributeForReportForm

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 ()
 

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
 

Detailed Description

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.

Constructor & Destructor Documentation

__construct (   $moduleClassName,
  $modelClassName,
  $reportType,
  $rowKey = 0 
)
Parameters
string$moduleClassName
string$modelClassName
string$reportType

Definition at line 170 of file ComponentForReportForm.php.

Member Function Documentation

static getType ( )
static

Override in children class to

Returns
the correct component type
Exceptions
NotImplementedException

Definition at line 112 of file ComponentForReportForm.php.

attributeNames ( )
Returns
array

Definition at line 125 of file ComponentForReportForm.php.

__set (   $name,
  $value 
)

Special override to handle setting attributeIndexOrDerivedType

Parameters
string$name
mixed$value
Returns
mixed|void

Definition at line 136 of file ComponentForReportForm.php.

rules ( )
Returns
array

Definition at line 152 of file ComponentForReportForm.php.

attributeLabels ( )
Returns
array

Definition at line 160 of file ComponentForReportForm.php.

getModelClassName ( )
Returns
string

Definition at line 185 of file ComponentForReportForm.php.

getModuleClassName ( )
Returns
string

Definition at line 193 of file ComponentForReportForm.php.

getReportType ( )
Returns
string

Definition at line 201 of file ComponentForReportForm.php.

getAttributeIndexOrDerivedType ( )
Returns
string

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

Returns
array|string

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.

Returns
bool

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'

Returns
mixed|string

Definition at line 247 of file ComponentForReportForm.php.

getResolvedAttributeModuleClassName ( )

In the case of account's opportunities name, the returned ModuleClassName would be OpportunitiesModule

Returns
string

Definition at line 260 of file ComponentForReportForm.php.

getResolvedAttributeModelClassName ( )

In the case of account's opportunities name, the returned ModelClassName would be Opportunity

Returns
string

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'

Returns
string

Definition at line 289 of file ComponentForReportForm.php.

getPenultimateModelClassName ( )

An example of coming from Account -> opportunities name, the penultimate model would be Account

Returns
mixed
Exceptions
NotSupportedException

Definition at line 303 of file ComponentForReportForm.php.

getPenultimateRelation ( )

An example of coming from Account -> opportunities name, the penultimate relation would be opportunities

Returns
mixed
Exceptions
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.

Returns
string.

Definition at line 331 of file ComponentForReportForm.php.

makeResolvedAttributeModelRelationsAndAttributesToReportAdapter ( )
Returns
ModelRelationsAndAttributesToReportAdapter based object

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.

Returns
string
Exceptions
NotSupportedException

Definition at line 402 of file ComponentForReportForm.php.

isATypeOfCurrencyValue ( )

Based on the attribute's displayElementType, is the displayElementType a currency type of display

Returns
bool

Definition at line 416 of file ComponentForReportForm.php.

resolveAttributeOrRelationAndAttributeDataByIndexType (   $indexType)
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

Parameters
string$indexType
Returns
string or array

Definition at line 433 of file ComponentForReportForm.php.

resolveAttributeFromData ( Array  $attributeAndRelationData)
protected
Parameters
array$attributeAndRelationData
Returns
string

Definition at line 447 of file ComponentForReportForm.php.

resolveAttributeModuleClassNameFromData ( Array  $attributeAndRelationData,
  $moduleClassName,
  $modelClassName 
)
protected
Parameters
array$attributeAndRelationData
$moduleClassName
$modelClassName
Returns
string $moduleClassName

Definition at line 459 of file ComponentForReportForm.php.

resolveAttributeModelClassNameFromData ( Array  $attributeAndRelationData,
  $moduleClassName,
  $modelClassName 
)
protected
Parameters
array$attributeAndRelationData
$moduleClassName
$modelClassName
Returns
string $modelClassName

Definition at line 482 of file ComponentForReportForm.php.

resolvePenultimateModelClassNameFromData ( Array  $attributeAndRelationData,
  $modelClassName 
)
protected
Parameters
array$attributeAndRelationData
$modelClassName
Returns
string $lastModelClassName

Definition at line 504 of file ComponentForReportForm.php.

resolvePenultimateRelationFromData ( Array  $attributeAndRelationData)
protected
Parameters
array$attributeAndRelationData
Returns
string

Definition at line 525 of file ComponentForReportForm.php.

Field Documentation

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.


The documentation for this class was generated from the following file:
Generated on Sat Aug 8 2020 07:10:42
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.