All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Protected Attributes
MergeTagsReportRelationsAndAttributesToTreeAdapter Class Reference
Inheritance diagram for MergeTagsReportRelationsAndAttributesToTreeAdapter:
ReportRelationsAndAttributesToTreeAdapter WizardModelRelationsAndAttributesToTreeAdapter

Public Member Functions

 __construct (Report $report, $treeType, $uniqueId=null)
 
 getData ($nodeId)
 
- Public Member Functions inherited from ReportRelationsAndAttributesToTreeAdapter
 __construct (Report $report, $treeType)
 
 getData ($nodeId)
 
- Public Member Functions inherited from WizardModelRelationsAndAttributesToTreeAdapter
 getTreeType ()
 

Protected Member Functions

 resolveTreeTypeForMakingOrExplodingNodeId ()
 
 resolveSpecialTagNodes ()
 
 makeModelRelationsAndAttributesToReportAdapter ($moduleClassName, $modelClassName)
 
 resolveChildNodeDataValueForAttributeNode (&$attributeNode, $attribute, $nodeIdPrefix)
 
 getSpecialTagsData ()
 
 resolveMergeTagsRulesByModuleClassName ($moduleClassName)
 
- Protected Member Functions inherited from ReportRelationsAndAttributesToTreeAdapter
 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 Member Functions inherited from WizardModelRelationsAndAttributesToTreeAdapter
 makeNodeId ($relation, $nodeIdPrefix=null)
 
 resolveTreeTypeForMakingOrExplodingNodeId ()
 
 resolveNodeIdPrefixByNodeId ($nodeId)
 
 resolveNodeIdByRemovingTreeType ($nodeId)
 

Protected Attributes

 $uniqueId
 
- Protected Attributes inherited from ReportRelationsAndAttributesToTreeAdapter
 $report
 
- Protected Attributes inherited from WizardModelRelationsAndAttributesToTreeAdapter
 $treeType
 

Additional Inherited Members

- Static Public Member Functions inherited from WizardModelRelationsAndAttributesToTreeAdapter
static removeTreeTypeFromNodeId ($nodeId, $treeType)
 
static resolveInputPrefixData ($formModelClassName, $treeType, $rowNumber)
 
static resolveAttributeByNodeId ($nodeIdWithoutTreeType)
 

Detailed Description

Helper class for adapting relation and attribute data into tree data for showing a list of selectable merge tags

Definition at line 40 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

Constructor & Destructor Documentation

__construct ( Report  $report,
  $treeType,
  $uniqueId = null 
)
Parameters
Report$report
string$treeType
null$uniqueId

Definition at line 49 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

Member Function Documentation

getData (   $nodeId)

Override to support adding special tags

Parameters
string$nodeId
Returns
array

Definition at line 61 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

makeModelRelationsAndAttributesToReportAdapter (   $moduleClassName,
  $modelClassName 
)
protected

Override to call a different report adapter class for merge tags. This will allow special tags to be added as well as blocking hasMany variations.

Parameters
string$moduleClassName
string$modelClassName
Returns
ModelRelationsAndAttributesToReportAdapter based object

Definition at line 102 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

resolveChildNodeDataValueForAttributeNode ( $attributeNode,
  $attribute,
  $nodeIdPrefix 
)
protected

Override as needed

Parameters
$attributeNode
$attribute
$nodeIdPrefix

Definition at line 120 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

getSpecialTagsData ( )
protected

[[MODEL^URL]] : prints absolute url to the current model attached to template. [[BASE^URL]] : prints absolute url to the current install without trailing slash. [[APPLICATION^NAME]] : prints application name as set in global settings > application name. [[CURRENT^YEAR]] : prints current year. [[LAST^YEAR]] : prints last year. [[OWNERS^AVATAR^SMALL]] : prints the owner's small avatar image (32x32). [[OWNERS^AVATAR^MEDIUM ]] : prints the owner's medium avatar image (32x32). [[OWNERS^AVATAR^LARGE]] : prints the owner's large avatar image (32x32). [[OWNERS^EMAIL^SIGNATURE]] : prints the owner's email signature. [[UNSUBSCRIBE^URL]] : prints unsubscribe url. [[MANAGE^SUBSCRIPTIONS^URL]] : prints manage subscriptions url.

Returns
array

Definition at line 139 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.

resolveMergeTagsRulesByModuleClassName (   $moduleClassName)
protected
Parameters
$moduleClassName
Returns
Rules based object

Definition at line 191 of file MergeTagsReportRelationsAndAttributesToTreeAdapter.php.


The documentation for this class was generated from the following file:
Generated on Tue Jun 2 2020 07:10:52