All Data Structures Functions Variables Pages
Public Member Functions
ModelRelationsAndAttributesToSummationReportAdapter Class Reference
Inheritance diagram for ModelRelationsAndAttributesToSummationReportAdapter:
ModelRelationsAndAttributesToSummableReportAdapter ModelRelationsAndAttributesToReportAdapter

Public Member Functions

 getAttributesForOrderBys ($existingGroupBys=array(), $existingDisplayAttributes=array(), RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 getForDrillDownAttributes ()
 
 getAttributesForChartSeries ($existingGroupBys=array(), $existingDisplayAttributes=array())
 
 getAttributesForChartRange ($existingDisplayAttributes=array())
 
- Public Member Functions inherited from ModelRelationsAndAttributesToSummableReportAdapter
 getAttributesForFilters ()
 
 getAttributeLabel ($attribute)
 
 getAttributesForDisplayAttributes ($existingGroupBys=array(), RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 resolveDisplayAttributeTypeAndAddSelectClause (RedBeanModelSelectQueryAdapter $selectQueryAdapter, $attribute, $tableName, $columnName, $columnAliasName, $queryStringExtraPart=null)
 
 resolveOrderByStringForCalculationOrModifier ($attribute, $tableName, $columnName, $queryStringExtraPart=null)
 
 relationIsReportedAsAttribute ($relation)
 
 isAttributeACalculationOrModifier ($attribute)
 
 isAttributeACalculatedGroupByModifier ($attribute)
 
 getCalculationOrModifierType ($attribute)
 
 getAttributesForGroupBys ()
 
 isAttributeIndexOrDerivedTypeADisplayCalculation ($attributeIndexOrDerivedType)
 
 isDisplayAttributeMadeViaSelect ($attribute)
 
 getDisplayElementType ($attribute)
 
- Public Member Functions inherited from ModelRelationsAndAttributesToReportAdapter
 getModel ()
 
 getModelClassName ()
 
 getModuleClassName ()
 
 getRules ()
 
 __construct (RedBeanModel $model, ReportRules $rules, $reportType, $moduleClassName=null)
 
 getAttributeLabel ($attribute)
 
 getRelationLabel ($relation)
 
 isReportedOnAsARelation ($relationOrAttribute)
 
 getRelationModuleClassName ($relation)
 
 getRelationModelClassName ($relation)
 
 getAttributesForFilters ()
 
 getAttributesForDisplayAttributes ()
 
 getAttributesForOrderBys ()
 
 getAttributesForGroupBys ()
 
 getAvailableOperatorsType ($attribute)
 
 getFilterValueElementType ($attribute)
 
 getDisplayElementType ($attribute)
 
 getRealModelAttributeType ($attribute)
 
 getAllRelationsData ()
 
 getSelectableRelationsDataResolvedForUserAccess (User $user, Array $relations)
 
 getSelectableRelationsData (RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 getAttributesIncludingDerivedAttributesData ()
 
 isRelationASingularRelation ($relation)
 
 isOwnedRelation ($relation)
 
 getInferredRelationsData (RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 getFilterRulesByAttribute ($attribute, $ruleAttributeName)
 
 relationIsReportedAsAttribute ($relation)
 
 isDerivedRelationsViaCastedUpModelRelation ($relation)
 
 isInferredRelation ($relation)
 
 isDynamicallyDerivedAttribute ($attribute)
 
 getRawValueRelatedAttribute ($attribute)
 
 isAttributeReadOptimization ($attribute)
 
 isDerivedAttribute ($attribute)
 
 isDisplayAttributeMadeViaSelect ($attribute)
 

Additional Inherited Members

- Static Public Member Functions inherited from ModelRelationsAndAttributesToSummableReportAdapter
static forgetAll ()
 
static resolveRealAttributeName ($attribute)
 
- Static Public Member Functions inherited from ModelRelationsAndAttributesToReportAdapter
static forgetAll ()
 
static make ($moduleClassName, $modelClassName, $reportType)
 
static resolveRealAttributeName ($attribute)
 
- Data Fields inherited from ModelRelationsAndAttributesToSummableReportAdapter
const DISPLAY_CALCULATION_COUNT = 'Count'
 
const DISPLAY_CALCULATION_SUMMMATION = 'Summation'
 
const DISPLAY_CALCULATION_AVERAGE = 'Average'
 
const DISPLAY_CALCULATION_MINIMUM = 'Minimum'
 
const DISPLAY_CALCULATION_MAXIMUM = 'Maximum'
 
const GROUP_BY_CALCULATION_DAY = 'Day'
 
const GROUP_BY_CALCULATION_WEEK = 'Week'
 
const GROUP_BY_CALCULATION_MONTH = 'Month'
 
const GROUP_BY_CALCULATION_QUARTER = 'Quarter'
 
const GROUP_BY_CALCULATION_YEAR = 'Year'
 
- Data Fields inherited from ModelRelationsAndAttributesToReportAdapter
const DYNAMIC_ATTRIBUTE_USER = 'User'
 
const DYNAMIC_RELATION_INFERRED = 'Inferred'
 
- Protected Member Functions inherited from ModelRelationsAndAttributesToSummableReportAdapter
 getDisplayCalculationAttributes ()
 
 getDisplayCalculationAttribute (&$attributes, $attribute)
 
 resolveGroupByAttributesForDisplayAttributes (RedBeanModel $precedingModel=null, $precedingRelation=null, &$attributes, $existingGroupBys)
 
 resolveDisplayCalculationAttributeData (&$attributes, $attribute, $type)
 
 resolveDisplayCalculationLabel ($attribute, $type)
 
 getGroupByModifierAttributes ()
 
 getGroupByCalculatedModifierAttributes ()
 
 resolveGroupByCalculationAttributeData (&$attributes, $attribute, $type)
 
 getGroupByCalculationTypeByAttribute ($attribute)
 
 resolveGroupByCalculationLabel ($attribute, $type)
 
 getDisplayAttributeForMakingViaSelectType ($attribute)
 
- Protected Member Functions inherited from ModelRelationsAndAttributesToReportAdapter
 getAttributesNotIncludingDerivedAttributesData ()
 
 derivedRelationLinksToPrecedingRelation ($relationModelClassName, $opposingRelation, RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 inferredRelationLinksToPrecedingRelation ($inferredModelClassName, $relation, RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 relationLinksToPrecedingRelation ($relation, RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 getDerivedRelationsViaCastedUpModelData (RedBeanModel $precedingModel=null, $precedingRelation=null)
 
 getDerivedAttributesData ()
 
 getDynamicallyDerivedAttributesData ()
 
 getInferredRelationModelClassNamesForRelation ($relation)
 
 resolveRelationToSelectableRelationData (&$attributes, $attribute)
 
 getDerivedAttributesDataByReportRules ()
 
- Static Protected Member Functions inherited from ModelRelationsAndAttributesToSummableReportAdapter
static getTranslatedDisplayCalculationShortLabel ($type)
 
static getDisplayCalculationTypes ()
 
static translatedDisplayCalculationShortLabels ()
 
static getTranslatedGroupByCalculationShortLabel ($type)
 
static translatedGroupByCalculationShortLabels ()
 
static getAttributeTypesToExcludeAsGroupByModifiers ()
 
- Protected Attributes inherited from ModelRelationsAndAttributesToSummableReportAdapter
 $shouldIncludeIdAsGroupByAttribute = true
 
- Protected Attributes inherited from ModelRelationsAndAttributesToReportAdapter
 $model
 
 $rules
 
 $reportType
 
 $moduleClassName
 

Detailed Description

Helper class for managing adapting model relations and attributes into a summation report

Definition at line 40 of file ModelRelationsAndAttributesToSummationReportAdapter.php.

Member Function Documentation

getAttributesForOrderBys (   $existingGroupBys = array(),
  $existingDisplayAttributes = array(),
RedBeanModel  $precedingModel = null,
  $precedingRelation = null 
)

Expected to be called from

See Also
ReportRelationsAndAttributesToTreeAdapter. This means the returned attributes should not carry any previous relation information. For example, hasOne___phone as an existing groupBy should return as 'phone' since it would be expected that it would be called on during just the ReportModelTestItem2 branch of the tree.
Parameters
array$existingGroupBys
array$existingDisplayAttributes
null | RedBeanModel$precedingModel
null | string$precedingRelation
Returns
array
Exceptions
NotSupportedExceptionif there the preceding model and relation are not either both defined or both null

Definition at line 55 of file ModelRelationsAndAttributesToSummationReportAdapter.php.

getForDrillDownAttributes ( )
Returns
array

Definition at line 136 of file ModelRelationsAndAttributesToSummationReportAdapter.php.

getAttributesForChartSeries (   $existingGroupBys = array(),
  $existingDisplayAttributes = array() 
)
Parameters
array$existingGroupBys
array$existingDisplayAttributes
Returns
array

Definition at line 149 of file ModelRelationsAndAttributesToSummationReportAdapter.php.

getAttributesForChartRange (   $existingDisplayAttributes = array())
Parameters
array$existingDisplayAttributes
Returns
array

Definition at line 170 of file ModelRelationsAndAttributesToSummationReportAdapter.php.


The documentation for this class was generated from the following file:
Generated on Fri Jan 24 2020 07:10:38