NotesModule Class Reference

Inheritance diagram for NotesModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

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

Data Fields

const RIGHT_CREATE_NOTES = 'Create Notes'
const RIGHT_DELETE_NOTES = 'Delete Notes'
const RIGHT_ACCESS_NOTES = 'Access Notes'

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file NotesModule.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 NotesModule.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 48 of file NotesModule.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 63 of file NotesModule.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 77 of file NotesModule.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 82 of file NotesModule.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 87 of file NotesModule.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 92 of file NotesModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 97 of file NotesModule.php.

static hasPermissions (  )  [static]

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

Reimplemented from SecurableModule.

Definition at line 102 of file NotesModule.php.

static getGlobalSearchFormClassName (  )  [static]

Even though notes 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 112 of file NotesModule.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 117 of file NotesModule.php.

static isReportable (  )  [static]

Override in modules that are reportable in the reporting module

Reimplemented from Module.

Definition at line 122 of file NotesModule.php.

static canHaveWorkflow (  )  [static]

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

Reimplemented from Module.

Definition at line 127 of file NotesModule.php.

static canHaveContentTemplates (  )  [static]

Override in modules that can be used in content templates

Reimplemented from Module.

Definition at line 132 of file NotesModule.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 137 of file NotesModule.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 142 of file NotesModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Sun Jun 25 07:10:28 2017