The main module class. More...

Inheritance diagram for UNLVSpatial:

Public Member Functions

getControlPanelMenuSections ()
getMinSupportedVersionSequence ()
getName ()
getPathToSchemas ()
getSetupSQLForMySQL ()
Invoked when the module is first installed.
getSetupSQLForSQLite ()
Invoked when the module is first installed.
getSupportedDataStores ()
getTemplateHelper (DMAbstractView $view, DMSession $session)
getUpgradeSQLForMySQL ()
Invoked when the module is upgraded.
getUpgradeSQLForSQLite ()
Invoked when the module is upgraded.
getVersion ()

Static Public Member Functions

static getDataStore ()

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. It also complies with a number of other sub-interfaces of DMBridgeModule, to support more specific features, including functionality within the Control Panel; the ability to persist data in the dmBridge data store; and the ability to provide template helpers in the dmBridge template engine.

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

Definition at line 20 of file UNLVSpatial.php.

Member Function Documentation

UNLVSpatial::getControlPanelMenuSections ( )

Returns:: array Array of DMCPMenuSections

Implements DMBridgeControlPanelModule.

Definition at line 45 of file UNLVSpatial.php.

static UNLVSpatial::getDataStore ( ) [static]

Returns:: DMDataStore

Definition at line 29 of file UNLVSpatial.php.

Referenced by UNLVSpatialIndexer::reindex(), and UNLVSpatialObjectFactory::spatializeObject().

UNLVSpatial::getMinSupportedVersionSequence ( )

Returns:: int

Implements DMBridgeModule.

Definition at line 62 of file UNLVSpatial.php.

UNLVSpatial::getName ( )

Returns:: string

Implements DMBridgeModule.

Definition at line 69 of file UNLVSpatial.php.

UNLVSpatial::getPathToSchemas ( )

Returns:: string

Implements DMBridgeRepresentationSchemaModule.

Definition at line 76 of file UNLVSpatial.php.

UNLVSpatial::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 87 of file UNLVSpatial.php.

UNLVSpatial::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 98 of file UNLVSpatial.php.

UNLVSpatial::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 107 of file UNLVSpatial.php.

UNLVSpatial::getTemplateHelper	(	DMAbstractView $	view,
		DMSession $	session
	)

Parameters:

DMAbstractView	view
DMSession	session

Returns:: DMTemplateHelper

Implements DMBridgeTemplateHelperModule.

Definition at line 119 of file UNLVSpatial.php.

UNLVSpatial::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 138 of file UNLVSpatial.php.

UNLVSpatial::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 151 of file UNLVSpatial.php.

UNLVSpatial::getVersion ( )

Returns:: string

Implements DMBridgeModule.

Definition at line 158 of file UNLVSpatial.php.

The documentation for this class was generated from the following file:

UNLVSpatial.php