ReportRelationsAndAttributesToTreeAdapter Class Reference

Inheritance diagram for ReportRelationsAndAttributesToTreeAdapter:
WizardModelRelationsAndAttributesToTreeAdapter CalendarReportRelationsAndAttributesToTreeAdapter MergeTagsReportRelationsAndAttributesToTreeAdapter

Public Member Functions

 __construct (Report $report, $treeType)
 getData ($nodeId)

Protected Member Functions

 getChildrenNodeData (ModelRelationsAndAttributesToReportAdapter $modelToReportAdapter, RedBeanModel $precedingModel=null, $precedingRelation=null, $nodeIdPrefix=null)
 resolveChildNodeDataValueForAttributeNode (&$attributeNode, $attribute, $nodeIdPrefix)
 getAttributesData (ModelRelationsAndAttributesToReportAdapter $modelToReportAdapter, RedBeanModel $precedingModel=null, $precedingRelation=null)
 makeModelRelationsAndAttributesToReportAdapter ($moduleClassName, $modelClassName)
 resolvePrecedingModelRelationAndAdapterByNodeId ($nodeId, &$modelToReportAdapter, &$precedingModel, &$precedingRelation)

Protected Attributes

 $report

Detailed Description

Helper class for adapting relation and attribute data into tree data

Definition at line 40 of file ReportRelationsAndAttributesToTreeAdapter.php.


Constructor & Destructor Documentation

__construct ( Report report,
treeType 
)
Parameters:
Report $report
string $treeType

Definition at line 51 of file ReportRelationsAndAttributesToTreeAdapter.php.


Member Function Documentation

getData ( nodeId  ) 
Parameters:
string $nodeId
Returns:
array

Reimplemented in MergeTagsReportRelationsAndAttributesToTreeAdapter.

Definition at line 62 of file ReportRelationsAndAttributesToTreeAdapter.php.

getChildrenNodeData ( ModelRelationsAndAttributesToReportAdapter modelToReportAdapter,
RedBeanModel precedingModel = null,
precedingRelation = null,
nodeIdPrefix = null 
) [protected]
Parameters:
ModelRelationsAndAttributesToReportAdapter $modelToReportAdapter
RedBeanModel $precedingModel
null|string $precedingRelation
null|string $nodeIdPrefix
Returns:
array
Exceptions:
NotSupportedException if one of the relations for the selectable data does not have a module class name defined

Definition at line 109 of file ReportRelationsAndAttributesToTreeAdapter.php.

resolveChildNodeDataValueForAttributeNode ( &$  attributeNode,
attribute,
nodeIdPrefix 
) [protected]

Override as needed

Parameters:
$attributeNode 
$attribute 
$nodeIdPrefix 

Reimplemented in MergeTagsReportRelationsAndAttributesToTreeAdapter.

Definition at line 153 of file ReportRelationsAndAttributesToTreeAdapter.php.

getAttributesData ( ModelRelationsAndAttributesToReportAdapter modelToReportAdapter,
RedBeanModel precedingModel = null,
precedingRelation = null 
) [protected]
Parameters:
ModelRelationsAndAttributesToReportAdapter $modelToReportAdapter
RedBeanModel $precedingModel
null|string $precedingRelation
Exceptions:
NotSupportedException if the treeType is invalid or null

Definition at line 163 of file ReportRelationsAndAttributesToTreeAdapter.php.

makeModelRelationsAndAttributesToReportAdapter ( moduleClassName,
modelClassName 
) [protected]
Parameters:
string $moduleClassName
string $modelClassName
Returns:
ModelRelationsAndAttributesToReportAdapter based object

Reimplemented in CalendarReportRelationsAndAttributesToTreeAdapter, and MergeTagsReportRelationsAndAttributesToTreeAdapter.

Definition at line 200 of file ReportRelationsAndAttributesToTreeAdapter.php.

resolvePrecedingModelRelationAndAdapterByNodeId ( nodeId,
&$  modelToReportAdapter,
&$  precedingModel,
&$  precedingRelation 
) [protected]
Parameters:
string $nodeId
ModelRelationsAndAttributesToReportAdapter $modelToReportAdapter
RedBeanModel $precedingModel
string $precedingRelation

Definition at line 214 of file ReportRelationsAndAttributesToTreeAdapter.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Aug 19 07:10:29 2017