dmBridge PHP API
UNLVRandom Class Reference

The main module class. More...

Inheritance diagram for UNLVRandom:

Public Member Functions


Detailed Description

The main module class.

The purpose of this class is to interface the module with dmBridge. As such, it needs to comply with the DMBridgeModule interface. In this case, because it uses the dmBridge data store, it additionally needs to comply with the DMBridgeDataStoreModule interface (which extends DMBridgeModule). In getSupportedDataStores(), we tell dmBridge which data stores the module supports.

Author:
Alex Dolski <alex.dolski@unlv.edu> http://www.opensource.org/licenses/mit-license.php

Definition at line 20 of file UNLVRandom.php.


Member Function Documentation

UNLVRandom::getControlPanelMenuSections ( )
Returns:
array Array of DMCPMenuSections

Implements DMBridgeControlPanelModule.

Definition at line 27 of file UNLVRandom.php.

UNLVRandom::getMinSupportedVersionSequence ( )
Returns:
int

Implements DMBridgeModule.

Definition at line 43 of file UNLVRandom.php.

UNLVRandom::getName ( )
Returns:
string

Implements DMBridgeModule.

Definition at line 50 of file UNLVRandom.php.

UNLVRandom::getPathToSchemas ( )
Returns:
string

Implements DMBridgeRepresentationSchemaModule.

Definition at line 57 of file UNLVRandom.php.

UNLVRandom::getSetupSQLForMySQL ( )

Invoked when the module is first installed.

Should return any and all SQL commands that are necessary to get the tables in a working state.

Returns:
array Array of SQL command strings to be executed, with one command per array element.

Implements DMBridgeDataStoreModule.

Definition at line 68 of file UNLVRandom.php.

UNLVRandom::getSetupSQLForSQLite ( )

Invoked when the module is first installed.

Should return any and all SQL commands that are necessary to get the tables in a working state.

Returns:
array Array of SQL command strings to be executed, with one command per array element.

Implements DMBridgeDataStoreModule.

Definition at line 79 of file UNLVRandom.php.

UNLVRandom::getSupportedDataStores ( )
Returns:
array An array of strings corresponding to the data stores supported by the module. See the DMDataStoreType class for a list of types.

Implements DMBridgeDataStoreModule.

Definition at line 88 of file UNLVRandom.php.

UNLVRandom::getUpgradeSQLForMySQL ( )

Invoked when the module is upgraded.

Should return any and all SQL commands necessary to upgrade the tables from any previous version of the module.

Returns:
array Array of SQL command strings to be executed, with one command per array element.
See also:
getSupportedDataStores()

Implements DMBridgeDataStoreModule.

Definition at line 104 of file UNLVRandom.php.

UNLVRandom::getUpgradeSQLForSQLite ( )

Invoked when the module is upgraded.

Should return any and all SQL commands necessary to upgrade the tables from any previous version of the module.

Returns:
array Array of SQL command strings to be executed, with one command per array element
See also:
getSupportedDataStores()

Implements DMBridgeDataStoreModule.

Definition at line 117 of file UNLVRandom.php.

UNLVRandom::getVersion ( )
Returns:
string

Implements DMBridgeModule.

Definition at line 124 of file UNLVRandom.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables