openmediavault  4.0 (Arrakis)
The open network attached storage solution
Public Member Functions | List of all members
OMV\Engine\Module\ServiceAbstract Class Reference
Inheritance diagram for OMV\Engine\Module\ServiceAbstract:
OMV\Engine\Module\ModuleAbstract OMV\Engine\Module\IService

Public Member Functions

 shouldApply ()
 
 shouldStart ()
 
 startBefore ()
 
 shouldStop ()
 
 stopAfter ()
 
 applyConfig ()
 
 stopService ()
 
 startService ()
 
- Public Member Functions inherited from OMV\Engine\Module\ModuleAbstract
 getName ()
 
 setDirty ()
 
 setDirtyByName ($name)
 
 isDirty ()
 

Additional Inherited Members

- Protected Member Functions inherited from OMV\Engine\Module\ModuleAbstract
 exec ($command, &$output=NULL)
 
 getAdminContext ()
 
 addTask ($id, $name, $params)
 
 execTasks ($id)
 

Detailed Description

A module class that implements the default methods defined by the interface.

Member Function Documentation

◆ applyConfig()

OMV\Engine\Module\ServiceAbstract::applyConfig ( )

Generate the configuration.

Implements OMV\Engine\Module\IService.

◆ shouldApply()

OMV\Engine\Module\ServiceAbstract::shouldApply ( )

Defines the modules that if present should build their configuration before the service provided by this module.

Returns
An array of modules.

Implements OMV\Engine\Module\IService.

◆ shouldStart()

OMV\Engine\Module\ServiceAbstract::shouldStart ( )

Defines the modules that if present should start before the service provided by this module.

Returns
An array of modules.

Implements OMV\Engine\Module\IService.

◆ shouldStop()

OMV\Engine\Module\ServiceAbstract::shouldStop ( )

Defines the modules that if present should be stopped after the service provided by this module.

Returns
An array of modules.

Implements OMV\Engine\Module\IService.

◆ startBefore()

OMV\Engine\Module\ServiceAbstract::startBefore ( )

Defines the modules that if present should start after the service provided by this module.

Returns
An array of modules.

Implements OMV\Engine\Module\IService.

◆ startService()

OMV\Engine\Module\ServiceAbstract::startService ( )

Start the managed service.

Implements OMV\Engine\Module\IService.

◆ stopAfter()

OMV\Engine\Module\ServiceAbstract::stopAfter ( )

Defines the modules that if present should stop before the service provided by this module.

Returns
An array of modules.

Implements OMV\Engine\Module\IService.

◆ stopService()

OMV\Engine\Module\ServiceAbstract::stopService ( )

Stop the managed service.

Implements OMV\Engine\Module\IService.


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