GameRewardsModule Class Reference

Inheritance diagram for GameRewardsModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getTranslatedRightsLabels ()
static getDefaultMetadata ()
static getDemoDataMakerClassNames ()
static getPrimaryModelName ()
static getAccessRight ()
static getGlobalSearchFormClassName ()
static hasPermissions ()
static modelsAreNeverGloballySearched ()

Data Fields

const RIGHT_ACCESS_GAME_REWARDS = 'Access Game Rewards Tab'

Static Protected Member Functions

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

Detailed Description

Module for managing game rewards

Definition at line 40 of file GameRewardsModule.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 44 of file GameRewardsModule.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 49 of file GameRewardsModule.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 61 of file GameRewardsModule.php.

static getDemoDataMakerClassNames (  )  [static]

Override in modules that create demo data during an installation.

Reimplemented from Module.

Definition at line 81 of file GameRewardsModule.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 86 of file GameRewardsModule.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 91 of file GameRewardsModule.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 96 of file GameRewardsModule.php.

static hasPermissions (  )  [static]

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

Reimplemented from SecurableModule.

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


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Nov 23 07:10:26 2017