Interface for an IRC network's configuration. More...

Inheritance diagram for Erebot\Interfaces\Config\Network:

Public Member Functions
	getChannelCfg ($channel)

	getChannels ()

	getName ()

	getServerCfg ($server)

	getServers ()

Public Member Functions inherited from Erebot\Interfaces\Config\Proxy
	getMainCfg ()

	getModule ($moduleName)

	getModules ($recursive)

	getTranslator ($component)

	parseBool ($module, $param, $default=null)

	parseInt ($module, $param, $default=null)

	parseReal ($module, $param, $default=null)

	parseString ($module, $param, $default=null)

Detailed Description

Interface for an IRC network's configuration.

This interface provides the necessary methods to represent the configuration associated with some IRC network.

Definition at line 31 of file Network.php.

Member Function Documentation

Erebot\Interfaces\Config\Network::getChannelCfg ( $channel )

Returns the configuration object for a particular IRC channel.

Parameters

string $channel The name of the IRC channel whose configuration we're interested in.

Return values

Erebot::Interfaces::Config::Channel The configuration object for that channel.

Exceptions

Erebot::NotFoundException No such channel has been configured on this IRC network.

Implemented in Erebot\Config\Network.

Erebot\Interfaces\Config\Network::getChannels ( )

Returns all IRC channel configurations.

Return values

array A list of all channel configuration instances stored by this network configuration, as objects implementing Erebot::Interfaces::Config::Channel.

Implemented in Erebot\Config\Network.

Erebot\Interfaces\Config\Network::getName ( )

Returns the name of this IRC network.

Return values

string The name of this IRC network.

Implemented in Erebot\Config\Network.

Erebot\Interfaces\Config\Network::getServerCfg ( $server )

Returns the configuration object for a particular IRC server.

Parameters

string $server The name of the IRC server whose configuration we're interested in.

Return values

Erebot::Interfaces::Config::Server The configuration object for that server.