WorkflowsModule Class Reference

Inheritance diagram for WorkflowsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getGlobalSearchFormClassName ()
static modelsAreNeverGloballySearched ()
static hasPermissions ()

Data Fields

const RIGHT_CREATE_WORKFLOWS = 'Create Workflows'
const RIGHT_DELETE_WORKFLOWS = 'Delete Workflows'
const RIGHT_ACCESS_WORKFLOWS = 'Access Workflows Tab'

Static Protected Member Functions

static getSingularModuleLabel ($language)
static getPluralModuleLabel ($language)

Detailed Description

Module for creating workflow rules that can trigger on beforeSave or by a time duration. Then actions and email messages can be fired.

Definition at line 41 of file WorkflowsModule.php.


Member Function Documentation

getDependencies (  ) 
Returns:
array

Reimplemented from Module.

Definition at line 59 of file WorkflowsModule.php.

getRootModelNames (  ) 
Returns:
array

Reimplemented from Module.

Definition at line 70 of file WorkflowsModule.php.

static getDefaultMetadata (  )  [static]
Returns:
array

Reimplemented from Module.

Definition at line 78 of file WorkflowsModule.php.

static getPrimaryModelName (  )  [static]
Returns:
string|void

Reimplemented from Module.

Definition at line 108 of file WorkflowsModule.php.

static getAccessRight (  )  [static]
Returns:
null|string

Reimplemented from SecurableModule.

Definition at line 116 of file WorkflowsModule.php.

static getCreateRight (  )  [static]
Returns:
null|string

Reimplemented from SecurableModule.

Definition at line 124 of file WorkflowsModule.php.

static getDeleteRight (  )  [static]
Returns:
null|string

Reimplemented from SecurableModule.

Definition at line 132 of file WorkflowsModule.php.

static getGlobalSearchFormClassName (  )  [static]

Even though workflows are never globally searched, the search form can still be used by a specific search view for a module. Either this module or a related module. This is why a class is returned.

See also:
modelsAreNeverGloballySearched controls it not being searchable though in the global search.

Reimplemented from Module.

Definition at line 142 of file WorkflowsModule.php.

static modelsAreNeverGloballySearched (  )  [static]
Returns:
bool

Reimplemented from Module.

Definition at line 150 of file WorkflowsModule.php.

static hasPermissions (  )  [static]
Returns:
bool

Reimplemented from SecurableModule.

Definition at line 158 of file WorkflowsModule.php.

static getSingularModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system. If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - singular module label.

Reimplemented from Module.

Definition at line 163 of file WorkflowsModule.php.

static getPluralModuleLabel ( language  )  [static, protected]

Override in all children modules to ensure proper availability of module labels in the translation system If the override is not available, then it will generate a label as a last resort.

Parameters:
string $language
Returns:
string - plural module label

Reimplemented from Module.

Definition at line 168 of file WorkflowsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue Apr 25 07:10:33 2017