OMVModuleMgr Class Reference

Inheritance diagram for OMVModuleMgr:

Public Member Functions
	registerModule (OMVModuleAbstract $module)
	getModule ($name)
	getModules ()
	getDirtyModules ()
	setModuleDirty ($name)
	isModuleDirty ($name)
	dump ()
Public Member Functions inherited from OMVObject
	__construct ()
	getLastError ()

Static Public Member Functions
static &	getInstance ()

Additional Inherited Members
Protected Member Functions inherited from OMVObject
	setLastError ($error)
	debug ()

Detailed Description

The module manager.

Member Function Documentation

OMVModuleMgr::dump ( )

final

Dump all registered modules.

OMVModuleMgr::getDirtyModules ( )

final

Helper function to get a list of dirty modules.

Returns

An array containing the names of the dirty marked modules.

static& OMVModuleMgr::getInstance ( )

static

Returns a module manager singleton.

Returns

The module manager object.

OMVModuleMgr::getModule (   $name )

final

Get a module.

Parameters

name	The name of the module to get.

Returns

The module object or FALSE on failure.

OMVModuleMgr::getModules ( )

final

Get all registered modules.

Returns

An array containing all registered modules.

OMVModuleMgr::isModuleDirty (   $name )

final

Helper function to check whether a module is marked dirty.

Parameters

name	The name of the module.

Returns

TRUE if the module is marked dirty, otherwise FALSE.

OMVModuleMgr::registerModule ( OMVModuleAbstract  $module )

final

Register a module.

Parameters

module

The module class to be registered.

Returns

Returns TRUE on success or FALSE on failure.

Exceptions

E_MISC_FAILURE

OMVModuleMgr::setModuleDirty (   $name )

final

Helper function to mark a module as dirty.

Parameters

name	The name of the module.

Returns

The list of dirty modules.

---

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

• module.inc