MarketingListsModule Class Reference

Inheritance diagram for MarketingListsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

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

Data Fields

const RIGHT_CREATE_MARKETING_LISTS = 'Create Marketing Lists'
const RIGHT_DELETE_MARKETING_LISTS = 'Delete Marketing Lists'
const RIGHT_ACCESS_MARKETING_LISTS = 'Access Marketing Lists Tab'

Detailed Description

Definition at line 37 of file MarketingListsModule.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 MarketingListsModule.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 50 of file MarketingListsModule.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 64 of file MarketingListsModule.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 69 of file MarketingListsModule.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 74 of file MarketingListsModule.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 79 of file MarketingListsModule.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 84 of file MarketingListsModule.php.

static modelsAreNeverGloballySearched (  )  [static]

Override when there is a module that can have module scoping or special search fields in the module list/search view but is not globally searchable. Activities are an example of this or users.

Reimplemented from Module.

Definition at line 89 of file MarketingListsModule.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 94 of file MarketingListsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 105 of file MarketingListsModule.php.

static isReportable (  )  [static]

Override in modules that are reportable in the reporting module

Reimplemented from Module.

Definition at line 110 of file MarketingListsModule.php.

static hasPermissions (  )  [static]

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

Reimplemented from SecurableModule.

Definition at line 115 of file MarketingListsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Fri Dec 15 07:10:27 2017