ProductsModule Class Reference

Inheritance diagram for ProductsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getSingularCamelCasedName ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getDefaultDataMakerClassName ()
static getDemoDataMakerClassNames ()
static getGlobalSearchFormClassName ()
static hasPermissions ()
static isReportable ()
static modelsAreNeverGloballySearched ()
static canHaveWorkflow ()
static canHaveContentTemplates ()
static canShowOnCalendar ()

Data Fields

const RIGHT_CREATE_PRODUCTS = 'Create Products'
const RIGHT_DELETE_PRODUCTS = 'Delete Products'
const RIGHT_ACCESS_PRODUCTS = 'Access Products Tab'

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file ProductsModule.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 ProductsModule.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 ProductsModule.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 ProductsModule.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 91 of file ProductsModule.php.

static getSingularCamelCasedName (  )  [static]
Returns:
the singular name of the module for example 'Account' keeping the uppercase letters. Override if the module's pluralized name cannot be changed to singular by simply removing the end 's'.

Reimplemented from Module.

Definition at line 96 of file ProductsModule.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 101 of file ProductsModule.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 106 of file ProductsModule.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 111 of file ProductsModule.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 116 of file ProductsModule.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 121 of file ProductsModule.php.

static getDefaultDataMakerClassName (  )  [static]

Override in modules that create default data during an installation.

Reimplemented from Module.

Definition at line 126 of file ProductsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 131 of file ProductsModule.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 136 of file ProductsModule.php.

static hasPermissions (  )  [static]

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

Reimplemented from SecurableModule.

Definition at line 141 of file ProductsModule.php.

static isReportable (  )  [static]

Override in modules that are reportable in the reporting module

Reimplemented from Module.

Definition at line 146 of file ProductsModule.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 151 of file ProductsModule.php.

static canHaveWorkflow (  )  [static]

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

Reimplemented from Module.

Definition at line 156 of file ProductsModule.php.

static canHaveContentTemplates (  )  [static]

Override in modules that can be used in content templates

Reimplemented from Module.

Definition at line 161 of file ProductsModule.php.

static canShowOnCalendar (  )  [static]

Override in modules that can be used in calendar module

Reimplemented from Module.

Definition at line 166 of file ProductsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Tue Aug 22 07:10:29 2017