dmBridge PHP API
UNLVHighlight Class Reference

The main module class. More...

Inheritance diagram for UNLVHighlight:

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 UNLVHighlight.php.


Member Function Documentation

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

Implements DMBridgeControlPanelModule.

Definition at line 27 of file UNLVHighlight.php.

UNLVHighlight::getMinSupportedVersionSequence ( )
Returns:
int

Implements DMBridgeModule.

Definition at line 45 of file UNLVHighlight.php.

UNLVHighlight::getName ( )
Returns:
string

Implements DMBridgeModule.

Definition at line 52 of file UNLVHighlight.php.

UNLVHighlight::getPathToSchemas ( )
Returns:
string

Implements DMBridgeRepresentationSchemaModule.

Definition at line 59 of file UNLVHighlight.php.

UNLVHighlight::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 70 of file UNLVHighlight.php.

UNLVHighlight::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 81 of file UNLVHighlight.php.

UNLVHighlight::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 90 of file UNLVHighlight.php.

UNLVHighlight::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 106 of file UNLVHighlight.php.

UNLVHighlight::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 119 of file UNLVHighlight.php.

UNLVHighlight::getVersion ( )
Returns:
string

Implements DMBridgeModule.

Definition at line 126 of file UNLVHighlight.php.


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