Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes
ModelToComponentRules Class Reference
Inheritance diagram for ModelToComponentRules:
ReportRules WorkflowRules AccountAccountAffiliationsReportRules AccountContactAffiliationsReportRules AutorespondersReportRules PermitableReportRules SecuredReportRules AccountAccountAffiliationsWorkflowRules AccountContactAffiliationsWorkflowRules CommentsWorkflowRules PermitableWorkflowRules SecuredWorkflowRules

Public Member Functions

 getDerivedAttributeTypesData (RedBeanModel $model)
 
 getAvailableOperatorsTypes (RedBeanModel $model, $attribute)
 

Static Public Member Functions

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)
 

Static Protected Member Functions

static assertMetadataIsValid (array $metadata)
 

Protected Attributes

 $modelClassName
 

Detailed Description

Base class of rules that assist with reporting and workflow modules. Consider extending this class when there is a module that does operations across all or most other modules. Both workflow and reporting share similarities that make it logical to have this base class

Definition at line 42 of file ModelToComponentRules.php.

Member Function Documentation

static getRulesName ( )
static

Implement in children classes

Exceptions
NotImplementedException

Definition at line 53 of file ModelToComponentRules.php.

static makeByModuleClassName (   $moduleClassName)
static
Parameters
$moduleClassName
Returns
Rules based object

Definition at line 62 of file ModelToComponentRules.php.

static getMetadata ( )
static
Returns
array

Definition at line 72 of file ModelToComponentRules.php.

static setMetadata ( array  $metadata)
static
Parameters
array$metadata

Definition at line 95 of file ModelToComponentRules.php.

static getDefaultMetadata ( )
static

Returns default metadata for use in automatically generating the rules.

Definition at line 109 of file ModelToComponentRules.php.

getDerivedAttributeTypesData ( RedBeanModel  $model)
Parameters
RedBeanModel$model
Returns
array

Definition at line 118 of file ModelToComponentRules.php.

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

Definition at line 144 of file ModelToComponentRules.php.

static getVariableStateModuleLabel ( User  $user)
static

Override in children classes as necessary.

See Also
ContactReportRules for example
Parameters
User$user
Exceptions
NotImplementedException

Definition at line 162 of file ModelToComponentRules.php.

static canUserAccessModuleInAVariableState ( User  $user)
static

Override in children classes as necessary.

See Also
ContactReportRules for example
Parameters
User$user
Exceptions
NotImplementedException

Definition at line 173 of file ModelToComponentRules.php.

static resolveStateAdapterUserHasAccessTo ( User  $user)
static

Override in children classes as necessary.

See Also
ContactReportRules for example
Parameters
User$user
Exceptions
NotImplementedException

Definition at line 184 of file ModelToComponentRules.php.

static getVariableStateValuesForUser (   $modelClassName,
User  $user 
)
static

Override in children classes as necessary.

See Also
ContactReportRules for example
Parameters
$modelClassName
User$user

Definition at line 195 of file ModelToComponentRules.php.

static assertMetadataIsValid ( array  $metadata)
staticprotected

Override in children classes as necessary.

Parameters
array$metadata

Definition at line 205 of file ModelToComponentRules.php.


The documentation for this class was generated from the following file:
Generated on Fri Aug 7 2020 07:10:53
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.