Erebot  latest
A modular IRC bot for PHP 5.3+
Erebot\Config\Channel Class Reference

Contains the configuration for an IRC channel. More...

+ Inheritance diagram for Erebot\Config\Channel:

Public Member Functions

 __construct (\Erebot\Interfaces\Config\Network $netCfg,\SimpleXMLElement $xml)
 
 __destruct ()
 Destructor.
 
 getName ()
 
 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)
 
- 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)
 

Protected Attributes

 $name
 The name of the channel this configuration refers to.
 
 $netCfg
 Netword configuration configuration this object depends on.
 
- 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,\Erebot\CallableInterface $parser, $origin,\Erebot\CallableInterface $checker)
 

Detailed Description

Contains the configuration for an IRC channel.

This is mainly used to provide autojoin and advanced i18n capabilities to the bot.

Definition at line 30 of file Channel.php.

Constructor & Destructor Documentation

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

Creates a new configuration object for an IRC channel.

Parameters
Erebot::Interfaces::Config::Network$netCfgAn object which contains the network configuration for this channel.
SimpleXMLElement$xmlAn XML node containing the configuration data for this network.

Definition at line 49 of file Channel.php.

References Erebot\Config\Channel\$netCfg.

Member Function Documentation

Erebot\Config\Channel::getName ( )

Returns the name of this IRC channel.

Return values
stringThe name of this IRC channel.

Implements Erebot\Interfaces\Config\Channel.

Definition at line 65 of file Channel.php.

References Erebot\Config\Channel\$name.

Erebot\Config\Channel::getNetworkCfg ( )

Returns the IRC network configuration upon which this IRC channel configuration depends.

Return values
Erebot::Interfaces::Config::NetworkThe IRC network configuration for this IRC channel.

Implements Erebot\Interfaces\Config\Channel.

Definition at line 71 of file Channel.php.

References Erebot\Config\Channel\$netCfg.


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