dmBridge PHP API
DMBridgeDataStoreModule Interface Reference
Inheritance diagram for DMBridgeDataStoreModule:

Public Member Functions


Detailed Description

Interface to be implemented by dmBridge modules that use the dmBridge data store.

Modules should add a prefix to their table names in order to keep them obviously separate from dmBridge tables.

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

Definition at line 19 of file DMBridgeDataStoreModule.php.


Member Function Documentation

DMBridgeDataStoreModule::getSetupSQLForMySQL ( )

Invoked when the module is activated for the first time.

Should return any and all SQL commands 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.
See also:
getSupportedDataStores()

Implemented in UNLVHighlight, UNLVRandom, and UNLVSpatial.

DMBridgeDataStoreModule::getSetupSQLForSQLite ( )

Invoked when the module is activated for the first time.

Should return any and all SQL commands 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
See also:
getSupportedDataStores()

Implemented in UNLVHighlight, UNLVRandom, and UNLVSpatial.

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

Implemented in UNLVHighlight, UNLVRandom, and UNLVSpatial.

DMBridgeDataStoreModule::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()

Implemented in UNLVHighlight, UNLVRandom, and UNLVSpatial.

DMBridgeDataStoreModule::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()

Implemented in UNLVHighlight, UNLVRandom, and UNLVSpatial.


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