openmediavault  4.0 (Arrakis)
The open network attached storage solution
Public Member Functions | Static Public Member Functions | List of all members
OMV\Engine\Module\Manager Class Reference

Public Member Functions

 getModule ($name)
 
 getModules ()
 
 getDirtyModules ()
 
 setModuleDirty ($name)
 
 isModuleDirty ($name)
 
 dump ()
 

Static Public Member Functions

static & getInstance ()
 

Detailed Description

The module manager.

Member Function Documentation

◆ dump()

OMV\Engine\Module\Manager::dump ( )
final

Dump all registered modules.

◆ getDirtyModules()

OMV\Engine\Module\Manager::getDirtyModules ( )
final

Helper function to get a list of dirty modules.

Returns
An array containing the names of the dirty marked modules.

◆ getInstance()

static& OMV\Engine\Module\Manager::getInstance ( )
static

Returns a module manager singleton.

Returns
The module manager object.

◆ getModule()

OMV\Engine\Module\Manager::getModule (   $name)
final

Get a module.

Parameters
nameThe name of the module to get.
Returns
The module object or FALSE on failure.

◆ getModules()

OMV\Engine\Module\Manager::getModules ( )
final

Get all registered modules.

Returns
An array containing all registered modules.

◆ isModuleDirty()

OMV\Engine\Module\Manager::isModuleDirty (   $name)
final

Helper function to check whether a module is marked dirty.

Parameters
nameThe name of the module.
Returns
TRUE if the module is marked dirty, otherwise FALSE.

◆ setModuleDirty()

OMV\Engine\Module\Manager::setModuleDirty (   $name)
final

Helper function to mark a module as dirty.

Parameters
nameThe name of the module.
Returns
The list of dirty modules.

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