ContactsModule Class Reference

Inheritance diagram for ContactsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static loadStartingData ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getSecurableModuleDisplayName ()
static getDefaultDataMakerClassName ()
static getDemoDataMakerClassNames ()
static getStateMetadataAdapterClassName ()
static getGlobalSearchFormClassName ()
static hasPermissions ()
static isReportable ()
static canHaveWorkflow ()
static canHaveContentTemplates ()
static shouldUpdateLatestActivityDateTimeWhenATaskIsCompleted ()
static shouldUpdateLatestActivityDateTimeWhenANoteIsCreated ()
static shouldUpdateLatestActivityDateTimeWhenAnEmailIsSentOrArchived ()
static shouldUpdateLatestActivityDateTimeWhenAMeetingIsInThePast ()

Data Fields

const RIGHT_CREATE_CONTACTS = 'Create Contacts'
const RIGHT_DELETE_CONTACTS = 'Delete Contacts'
const RIGHT_ACCESS_CONTACTS = 'Access Contacts Tab'

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file ContactsModule.php.


Member Function Documentation

getDependencies (  ) 

Returns an array of the names of the the modules the module depends on. ie: if the module is enabled then those modules must be too, recursively through their dependencies.

Reimplemented from Module.

Definition at line 43 of file ContactsModule.php.

getRootModelNames (  ) 

Implement in all modules that have models. The root models are the models that if they are created, then their related models are created, and so on recursively, then all of module's models will have been created, allowing RedBean to create all of the required tables and columns.

Reimplemented from Module.

Definition at line 51 of file ContactsModule.php.

static getDefaultMetadata (  )  [static]

Returns the default meta data for the class. It must be appended to the meta data from the parent model, if any.

Reimplemented from Module.

Definition at line 66 of file ContactsModule.php.

static getPrimaryModelName (  )  [static]

Get the primary model name for a module. Make sure to override in modules that have a Primary model otherwise the method is not supported.

Reimplemented from Module.

Definition at line 107 of file ContactsModule.php.

static loadStartingData (  )  [static]

Used on first load to install ContactState data and the startingState for the Contacts module.

Returns:
true/false if data was in fact loaded.

Definition at line 117 of file ContactsModule.php.

static getAccessRight (  )  [static]

Override if the module has a right that determines if a user can access the module tab/subtabs in the user interface.

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 157 of file ContactsModule.php.

static getCreateRight (  )  [static]

Override if the module has a right that determines if a user can create the models in this modules

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 162 of file ContactsModule.php.

static getDeleteRight (  )  [static]

Override if the module has a right that determines if a user can delete the models in this modules

Returns:
null or access right

Reimplemented from SecurableModule.

Definition at line 167 of file ContactsModule.php.

static getSecurableModuleDisplayName (  )  [static]

Override since the ContactsModule controls module permissions for both leads and contacts.

Reimplemented from SecurableModule.

Definition at line 175 of file ContactsModule.php.

static getDefaultDataMakerClassName (  )  [static]

Override in modules that create default data during an installation.

Reimplemented from Module.

Definition at line 182 of file ContactsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 187 of file ContactsModule.php.

static getStateMetadataAdapterClassName (  )  [static]

Override and return a string of the StatemetadataAdataper class if the module's primary model supports states. An example is leads or contacts where the lead is only contacts in a certain state.

Reimplemented from Module.

Definition at line 192 of file ContactsModule.php.

static getGlobalSearchFormClassName (  )  [static]

Override and return a string if the module supports the global search mechanism.

Returns:
null if not supported otherwise return the appropriate string.

Reimplemented from Module.

Definition at line 197 of file ContactsModule.php.

static hasPermissions (  )  [static]

Override and set to true if the module has a model that utilizes permissions.

Reimplemented from SecurableModule.

Definition at line 202 of file ContactsModule.php.

static isReportable (  )  [static]

Override in modules that are reportable in the reporting module

Reimplemented from Module.

Definition at line 207 of file ContactsModule.php.

static canHaveWorkflow (  )  [static]

Override in modules that can have workflow rules in the workflow module

Reimplemented from Module.

Definition at line 212 of file ContactsModule.php.

static canHaveContentTemplates (  )  [static]

Override in modules that can be used in content templates

Reimplemented from Module.

Definition at line 217 of file ContactsModule.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 222 of file ContactsModule.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 227 of file ContactsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Mar 26 07:10:23 2017