InstallModule Class Reference

Inheritance diagram for InstallModule:
Module

Public Member Functions

 canDisable ()
 getRootModelNames ()
 getDependencies ()

Static Public Member Functions

static getDefaultMetadata ()

Static Protected Member Functions

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

Detailed Description

Definition at line 37 of file InstallModule.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 39 of file InstallModule.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 44 of file InstallModule.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 49 of file InstallModule.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 56 of file InstallModule.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 61 of file InstallModule.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 66 of file InstallModule.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Mon Nov 20 07:10:25 2017