GroupsModule Class Reference

Inheritance diagram for GroupsModule:
SecurableModule Module

Public Member Functions

 canDisable ()
 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getPrimaryModelName ()
static getAccessRight ()
static getCreateRight ()
static getDeleteRight ()
static getDefaultDataMakerClassName ()
static getDemoDataMakerClassNames ()
static resolveEveryoneDisplayLabel ()
static setEveryoneDisplayLabel ($label)

Data Fields

const RIGHT_CREATE_GROUPS = 'Create Groups'
const RIGHT_DELETE_GROUPS = 'Delete Groups'
const RIGHT_ACCESS_GROUPS = 'Access Groups Tab'

Detailed Description

Definition at line 37 of file GroupsModule.php.


Member Function Documentation

canDisable (  ) 

Returns whether the module is can be disabled. Modules that must not be disabled must override and return false.

Reimplemented from Module.

Definition at line 52 of file GroupsModule.php.

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 57 of file GroupsModule.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 62 of file GroupsModule.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 67 of file GroupsModule.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 103 of file GroupsModule.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 108 of file GroupsModule.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 113 of file GroupsModule.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 118 of file GroupsModule.php.

static getDefaultDataMakerClassName (  )  [static]

Override in modules that create default data during an installation.

Reimplemented from Module.

Definition at line 123 of file GroupsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 128 of file GroupsModule.php.

static resolveEveryoneDisplayLabel (  )  [static]

Resolves the everyone display label for a custom label

Returns:
string

Definition at line 137 of file GroupsModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Wed Aug 23 07:10:25 2017