Contains the main (general) configuration for Erebot. More...

Inheritance diagram for Erebot\Config\Main:

Public Member Functions
	__clone ()

	__construct ($configData, $source,\Erebot\Intl\TranslatorInterface $translator)

	__destruct ()

	getCommandsPrefix ()

	getConfigFile ()

	getGroupIdentity ()

	getNetworkCfg ($network)

	getNetworks ()

	getPidfile ()

	getTimezone ()

	getTranslator ($component)

	getUserIdentity ()

	getVersion ()

	load ($configData, $source)

	mustDaemonize ()

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
	$commandsPrefix
	The prefix used to recognize commands.

	$configFile
	The (relative or absolute) path to the configuration, if available.

	$coreTranslator
	Translator used by core files.

	$daemonize
	Whether to daemonize the bot or not.

	$groupIdentity
	Group identity to switch to.

	$networks
	A list of Erebot::Config::Network objects.

	$pidfile
	File where the bot's PID will be written.

	$timezone
	The bot's current timezone.

	$userIdentity
	User identity to switch to.

	$version
	The configuration file's version string.

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.

Private Member Functions
	stripXGlobWrappers (&$domxml)

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

Contains the main (general) configuration for Erebot.

This class deals with settings which affect the whole bot such as its version string. It also contains references to instances of Erebot::Config::Network.

Definition at line 31 of file Main.php.

Constructor & Destructor Documentation

Erebot\Config\Main::__construct	(		$configData,
			$source,
		\Erebot\Intl\TranslatorInterface	$translator
	)

Creates a new instance of the Erebot::Config::Main class.

Parameters

string	$configData	Either a (relative or absolute) path to the configuration file to load or a string representation of the configuration, depending on the value of the $source parameter.
opaque	$source	Erebot::Interfaces::Config::Main::LOAD_FROM_FILE or Erebot::Interfaces::Config::Main::LOAD_FROM_STRING, depending on whether $configData contains a filename or the string representation of the configuration data, respectively.
Erebot::Intl::TranslatorInterface	$translator	Translator to use for messages coming from core files.

Exceptions

Erebot::InvalidValueException The configuration file did not exist or contained invalid values. This exception is also thrown when the $source parameter contains an invalid value.

Definition at line 86 of file Main.php.

References Erebot\Config\Main\load().

Erebot\Config\Main::__destruct ( )

Destructs Erebot::Config::Main instances.

Definition at line 101 of file Main.php.