ApiModule Class Reference

Inheritance diagram for ApiModule:
SecurableModule Module

Public Member Functions

 getDependencies ()
 getRootModelNames ()

Static Public Member Functions

static getDefaultMetadata ()
static getSingularCamelCasedName ()

Static Protected Member Functions

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

Detailed Description

ApiModule is used to manage api calls.

Definition at line 41 of file ApiModule.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 ApiModule.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 ApiModule.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 ApiModule.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 62 of file ApiModule.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 67 of file ApiModule.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 72 of file ApiModule.php.


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