LeadsModule Class Reference

Inheritance diagram for LeadsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getConvertToAccountSetting ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getDemoDataMakerClassNames ()
static getStateMetadataAdapterClassName ()
static getGlobalSearchFormClassName ()

Data Fields

const CONVERT_NO_ACCOUNT = 1
const CONVERT_ACCOUNT_NOT_REQUIRED = 2
const CONVERT_ACCOUNT_REQUIRED = 3
const RIGHT_CREATE_LEADS = 'Create Leads'
const RIGHT_DELETE_LEADS = 'Delete Leads'
const RIGHT_ACCESS_LEADS = 'Access Leads Tab'
const RIGHT_CONVERT_LEADS = 'Convert Leads'

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file LeadsModule.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 48 of file LeadsModule.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 58 of file LeadsModule.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 74 of file LeadsModule.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 121 of file LeadsModule.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 132 of file LeadsModule.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 137 of file LeadsModule.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 142 of file LeadsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 147 of file LeadsModule.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 152 of file LeadsModule.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 157 of file LeadsModule.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 162 of file LeadsModule.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 167 of file LeadsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sat Aug 19 07:10:26 2017