All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes | Static Protected Attributes
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 ()
 
- Public Member Functions inherited from ComponentForReportForm
 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 ()
 
static resetCount ()
 
- Static Public Member Functions inherited from ComponentForReportForm
static getType ()
 

Data Fields

const COLUMN_ALIAS_PREFIX = 'col'
 
const HEADER_SORTABLE_TYPE_ASORT = 'asort'
 
 $label
 
 $columnAliasName
 
 $queryOnly = false
 
 $valueUsedAsDrillDownFilter = false
 
 $madeViaSelectInsteadOfViaModel = false
 
- Data Fields inherited from ComponentForReportForm
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 Attributes

 $modelAliasUsingTableAliasName
 
- Protected Attributes inherited from ComponentForReportForm
 $moduleClassName
 
 $modelClassName
 
 $attributeAndRelationData
 
 $reportType
 

Static Protected Attributes

static $count = 0
 

Additional Inherited Members

- Protected Member Functions inherited from ComponentForReportForm
 resolveAttributeOrRelationAndAttributeDataByIndexType ($indexType)
 
 resolveAttributeFromData (Array $attributeAndRelationData)
 
 resolveAttributeModuleClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolveAttributeModelClassNameFromData (Array $attributeAndRelationData, $moduleClassName, $modelClassName)
 
 resolvePenultimateModelClassNameFromData (Array $attributeAndRelationData, $modelClassName)
 
 resolvePenultimateRelationFromData (Array $attributeAndRelationData)
 

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

Definition at line 107 of file DisplayAttributeForReportForm.php.

Member Function Documentation

static getType ( )
static
Returns
string component type

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

Definition at line 119 of file DisplayAttributeForReportForm.php.

rules ( )
Returns
array

Definition at line 133 of file DisplayAttributeForReportForm.php.

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

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:
Generated on Fri May 29 2020 07:10:44