All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions
ReportRules Class Reference
Inheritance diagram for ReportRules:
ModelToComponentRules AccountAccountAffiliationsReportRules AccountContactAffiliationsReportRules AutorespondersReportRules PermitableReportRules SecuredReportRules UsersMergeTagsRules UsersReportRules AccountsReportRules ActivitiesReportRules CalendarsReportRules CampaignsReportRules ContactsReportRules EmailMessagesReportRules MarketingListMembersReportRules MarketingListsReportRules OpportunitiesReportRules ProductsReportRules ProductTemplatesReportRules ProjectsReportRules ReportsTest2ReportRules ReportsTestReportRules ZurmoReportRules

Public Member Functions

 relationIsReportedAsAttribute (RedBeanModel $model, $relation)
 
 attributeIsReportable (RedBeanModel $model, $attribute)
 
 getFilterValueElementType (RedBeanModel $model, $attribute)
 
 getSortAttributeForRelationReportedAsAttribute (RedBeanModel $model, $relation)
 
 getGroupByRelatedAttributeForRelationReportedAsAttribute (RedBeanModel $model, $relation)
 
 getRawValueRelatedAttributeForRelationReportedAsAttribute (RedBeanModel $model, $relation)
 
 getDerivedAttributeTypesData (RedBeanModel $model)
 
- Public Member Functions inherited from ModelToComponentRules
 getDerivedAttributeTypesData (RedBeanModel $model)
 
 getAvailableOperatorsTypes (RedBeanModel $model, $attribute)
 

Static Public Member Functions

static getRulesName ()
 
- Static Public Member Functions inherited from ModelToComponentRules
static getRulesName ()
 
static makeByModuleClassName ($moduleClassName)
 
static getMetadata ()
 
static setMetadata (array $metadata)
 
static getDefaultMetadata ()
 
static getVariableStateModuleLabel (User $user)
 
static canUserAccessModuleInAVariableState (User $user)
 
static resolveStateAdapterUserHasAccessTo (User $user)
 
static getVariableStateValuesForUser ($modelClassName, User $user)
 

Additional Inherited Members

- Static Protected Member Functions inherited from ModelToComponentRules
static assertMetadataIsValid (array $metadata)
 
- Protected Attributes inherited from ModelToComponentRules
 $modelClassName
 

Detailed Description

Base class of report rules that assist with reporting data. Extend this class to make a set of ReportRules that is for a specific module or a combiniation of modules and/or models.

Definition at line 41 of file ReportRules.php.

Member Function Documentation

relationIsReportedAsAttribute ( RedBeanModel  $model,
  $relation 
)

Some relations such as a CustomField are shown as non-related nodes in the report wizard. For a custom field this method would return true for example. Whereas account -> opportunities would return false.

Parameters
RedBeanModel$model
$relation
Returns
bool

Definition at line 55 of file ReportRules.php.

attributeIsReportable ( RedBeanModel  $model,
  $attribute 
)
Parameters
RedBeanModel$model
$attribute
Returns
bool

Definition at line 83 of file ReportRules.php.

getFilterValueElementType ( RedBeanModel  $model,
  $attribute 
)
Parameters
RedBeanModel$model
string$attribute
Returns
null | string

Definition at line 101 of file ReportRules.php.

getSortAttributeForRelationReportedAsAttribute ( RedBeanModel  $model,
  $relation 
)
Parameters
RedBeanModel$model
string$relation
Returns
string
Exceptions
NotSupportedExceptionif the relation is not really reported as an attribute

Definition at line 127 of file ReportRules.php.

getGroupByRelatedAttributeForRelationReportedAsAttribute ( RedBeanModel  $model,
  $relation 
)
Parameters
RedBeanModel$model
string$relation
Returns
null|string
Exceptions
NotSupportedExceptionif the relation is not really reported as an attribute

Definition at line 162 of file ReportRules.php.

getRawValueRelatedAttributeForRelationReportedAsAttribute ( RedBeanModel  $model,
  $relation 
)
Parameters
RedBeanModel$model
$relation
Returns
null | string

Definition at line 196 of file ReportRules.php.

getDerivedAttributeTypesData ( RedBeanModel  $model)

Override to add unique identifier thing.

Parameters
RedBeanModel$model
Returns
array

Definition at line 216 of file ReportRules.php.


The documentation for this class was generated from the following file:
Generated on Mon Jun 1 2020 07:11:00