Erebot\Interfaces\Config\Module Interface Reference

Interface for a module's configuration. More...

Inheritance diagram for Erebot\Interfaces\Config\Module:

Public Member Functions
	getName ()
	getParam ($param)
	getParamsNames ()
	isActive ($active=null)

Detailed Description

Interface for a module's configuration.

This interface provides the necessary methods to represent the configuration associated with a module.

Definition at line 31 of file Module.php.

Member Function Documentation

Erebot\Interfaces\Config\Module::getName

(

)

Returns the name of this module.

Return values

string

The name of the module represented by this module configuration.

Implemented in Erebot\Config\Module.

Erebot\Interfaces\Config\Module::getParam

(

$param

)

Returns the value for the given parameter.

Parameters

string

$param

The name of the parameter we are interested in.

Return values

string

The value of the parameter.

Exceptions

Erebot::InvalidValueException	The $param argument was not a valid parameter name.
Erebot::NotFoundException	There was no parameter with this name defined in the configuration file.

Implemented in Erebot\Config\Module.

Erebot\Interfaces\Config\Module::getParamsNames

(

)

Returns the names of the parameters for this module.

Return values

array

A list with the names (as strings) of the parameters configured for this module.

Implemented in Erebot\Config\Module.

Erebot\Interfaces\Config\Module::isActive

(

$active = null

)

Gets/sets the active flag on this module.

Parameters

null | bool

$active

An optional parameter which can be used to change the value of the active flag for this module.

Return values

bool	The value of the active flag as it was before this method was called.

Exceptions

Erebot::InvalidValueException

The new value for the active flag is not a valid boolean value.

Implemented in Erebot\Config\Module.

---

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

• vendor/erebot/api/src/Interfaces/Config/Module.php