dmBridge PHP API
DMBridgeModule Interface Reference

Base interface for dmBridge modules. More...

Inheritance diagram for DMBridgeModule:

Public Member Functions


Detailed Description

Base interface for dmBridge modules.

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

Definition at line 16 of file DMBridgeModule.php.


Member Function Documentation

DMBridgeModule::getAbsolutePathname ( )
Returns:
string The absolute pathname of the module's root folder. Typically this will be the return value of dirname(__FILE__).
DMBridgeModule::getHTTPAPIDocumentation ( )
Returns:
A DOMNode containing an XML representation of the module's HTTP API documentation, or null if the module does not have any.
DMBridgeModule::getMinSupportedVersionSequence ( )

Every version of dmBridge has both a version, which is an arbitrary string, and a version sequence, which is an integer that increments by one with each new version.

The current version sequence can be accessed via DMBridgeVersion::getDmBridgeVersionSequence().

Returns:
int The minimum dmBridge version sequence that the module supports.
See also:
DMBridgeVersion::getDmBridgeVersionSequence()

Implemented in SampleModule, UNLVHighlight, UNLVRandom, and UNLVSpatial.

Referenced by DMModuleManager::setModuleEnabled().

DMBridgeModule::getName ( )
DMBridgeModule::getVersion ( )
Returns:
string The version of the module.

Implemented in SampleModule, UNLVHighlight, UNLVRandom, and UNLVSpatial.

Referenced by DMConfigXML::isModuleOfSameNameAndVersionInstalled(), and DMConfigXML::setModuleEnabled().


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