Erebot  latest
A modular IRC bot for PHP 7.0+
Erebot\Config\Server Class Reference

This class contains the configuration for an IRC server. More...

+ Inheritance diagram for Erebot\Config\Server:

Public Member Functions

 __construct (\Erebot\Interfaces\Config\Network $netCfg,\SimpleXMLElement $xml)
 
 __destruct ()
 Destructor.
 
 getConnectionURI ()
 
 getNetworkCfg ()
 
- Public Member Functions inherited from Erebot\Config\Proxy
 __clone ()
 
 __destruct ()
 
 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)
 

Protected Attributes

 $connectionURI
 An array of URI to follow to connect to this IRC(S) server.
 
- Protected Attributes inherited from Erebot\Config\Proxy
 $locale
 The current locale.
 
 $modules
 Array of modules loaded at this particular configuration level.
 
 $proxified
 Reference to a proxified object.
 

Additional Inherited Members

- Static Public Member Functions inherited from Erebot\Config\Proxy
static parseBoolHelper ($value)
 
static parseIntHelper ($value)
 
static parseRealHelper ($value)
 
- Protected Member Functions inherited from Erebot\Config\Proxy
 __construct (\Erebot\Interfaces\Config\Proxy $proxified,\SimpleXMLElement $xml)
 
 parseSomething ($module, $param, $default, callable $parser, $origin, callable $checker)
 
- Static Protected Member Functions inherited from Erebot\Config\Proxy
static getBaseDir ($component)
 

Detailed Description

This class contains the configuration for an IRC server.

This class stores settings which are specific to an IRC server, such as a connection URL and a default quit message.

Definition at line 30 of file Server.php.

Constructor & Destructor Documentation

Erebot\Config\Server::__construct ( \Erebot\Interfaces\Config\Network  $netCfg,
\SimpleXMLElement  $xml 
)

Creates a new Erebot::Config::Server instance.

Parameters
Erebot::Interfaces::Config::Network$netCfgA reference to an object which contains the configuration for the IRC network this server is a part of.
SimpleXMLElement$xmlAn XML node containing the configuration data for this server.

Definition at line 46 of file Server.php.

Member Function Documentation

Erebot\Config\Server::getConnectionURI ( )

Definition at line 63 of file Server.php.

References Erebot\Config\Server\$connectionURI.

Erebot\Config\Server::getNetworkCfg ( )

Definition at line 69 of file Server.php.

References Erebot\Config\Proxy\$proxified.


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