PHP Класс Phergie_Bot, phergie

Автор: Phergie Development Team ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$config Phergie_Config Current configuration instance
$connections Phergie_Connection_Handler Current connection handler instance
$driver Phergie_Driver_Abstract Current driver instance
$events Phergie_Event_Handler Current event handler instance
$plugins Phergie_Plugin_Handler Current plugin handler instance
$processor Phergie_Process_Abstract Current processor instance
$ui Phergie_Ui_Abstract Current end-user interface instance

Открытые методы

Метод Описание
getConfig ( string $index = null, mixed $default = null ) : mixed Returns the entire configuration in use or the value of a specific configuration setting.
getConnectionHandler ( ) : Phergie_Connection_Handler Returns a connection handler instance, creating it if it does not already exist and using a default class if none has been set.
getDefaultConfiguration ( ) : string | boolean Tries to locate the default configuration file
getDriver ( ) : Phergie_Driver_Abstract Returns a driver instance, creating one of the default class if none has been set.
getEventHandler ( ) : Phergie_Event_Handler Returns an event handler instance, creating it if it does not already exist and using a default class if none has been set.
getPluginHandler ( ) : Phergie_Plugin_Handler Returns a plugin handler instance, creating it if it does not already exist and using a default class if none has been set.
getProcessor ( ) : Phergie_Process_Abstract Returns a processer instance, creating one if none exists.
getUi ( ) : Phergie_Ui_Abstract Returns an end-user interface instance, creating it if it does not already exist and using a default class if none has been set.
run ( ) : Phergie_Bot Establishes server connections and initiates an execution loop to continuously receive and process events.
setConfig ( Phergie_Config $config ) : Phergie_Runner_Abstract Sets the configuration to use.
setConnectionHandler ( Phergie_Connection_Handler $handler ) : Phergie_Bot Sets the connection handler instance to use.
setDriver ( Phergie_Driver_Abstract $driver ) : Phergie_Bot Sets the driver instance to use.
setEventHandler ( Phergie_Event_Handler $handler ) : Phergie_Bot Sets the event handler instance to use.
setPluginHandler ( Phergie_Plugin_Handler $handler ) : Phergie_Bot Sets the plugin handler instance to use.
setProcessor ( Phergie_Process_Abstract $processor ) : Phergie_Bot Sets the processer instance to use.
setUi ( Phergie_Ui_Abstract $ui ) : Phergie_Bot Sets the end-user interface instance to use.

Защищенные методы

Метод Описание
loadConnections ( ) : void Configures and establishes connections to IRC servers.
loadPlugins ( ) : void Loads plugins into the plugin handler.

Описание методов

getConfig() публичный Метод

Returns the entire configuration in use or the value of a specific configuration setting.
public getConfig ( string $index = null, mixed $default = null ) : mixed
$index string Optional index of a specific configuration setting for which the corresponding value should be returned
$default mixed Value to return if no match is found for $index
Результат mixed Value corresponding to $index or the entire configuration if $index is not specified

getConnectionHandler() публичный Метод

Returns a connection handler instance, creating it if it does not already exist and using a default class if none has been set.
public getConnectionHandler ( ) : Phergie_Connection_Handler
Результат Phergie_Connection_Handler

getDefaultConfiguration() публичный Метод

Tries to locate the default configuration file
public getDefaultConfiguration ( ) : string | boolean
Результат string | boolean Returns false when no file was found

getDriver() публичный Метод

Returns a driver instance, creating one of the default class if none has been set.
public getDriver ( ) : Phergie_Driver_Abstract
Результат Phergie_Driver_Abstract

getEventHandler() публичный Метод

Returns an event handler instance, creating it if it does not already exist and using a default class if none has been set.
public getEventHandler ( ) : Phergie_Event_Handler
Результат Phergie_Event_Handler

getPluginHandler() публичный Метод

Returns a plugin handler instance, creating it if it does not already exist and using a default class if none has been set.
public getPluginHandler ( ) : Phergie_Plugin_Handler
Результат Phergie_Plugin_Handler

getProcessor() публичный Метод

Returns a processer instance, creating one if none exists.
public getProcessor ( ) : Phergie_Process_Abstract
Результат Phergie_Process_Abstract

getUi() публичный Метод

Returns an end-user interface instance, creating it if it does not already exist and using a default class if none has been set.
public getUi ( ) : Phergie_Ui_Abstract
Результат Phergie_Ui_Abstract

loadConnections() защищенный Метод

Configures and establishes connections to IRC servers.
protected loadConnections ( ) : void
Результат void

loadPlugins() защищенный Метод

Loads plugins into the plugin handler.
protected loadPlugins ( ) : void
Результат void

run() публичный Метод

Establishes server connections and initiates an execution loop to continuously receive and process events.
public run ( ) : Phergie_Bot
Результат Phergie_Bot Provides a fluent interface

setConfig() публичный Метод

Sets the configuration to use.
public setConfig ( Phergie_Config $config ) : Phergie_Runner_Abstract
$config Phergie_Config Configuration instance
Результат Phergie_Runner_Abstract Provides a fluent interface

setConnectionHandler() публичный Метод

Sets the connection handler instance to use.
public setConnectionHandler ( Phergie_Connection_Handler $handler ) : Phergie_Bot
$handler Phergie_Connection_Handler Connection handler instance
Результат Phergie_Bot Provides a fluent interface

setDriver() публичный Метод

Sets the driver instance to use.
public setDriver ( Phergie_Driver_Abstract $driver ) : Phergie_Bot
$driver Phergie_Driver_Abstract Driver instance
Результат Phergie_Bot Provides a fluent interface

setEventHandler() публичный Метод

Sets the event handler instance to use.
public setEventHandler ( Phergie_Event_Handler $handler ) : Phergie_Bot
$handler Phergie_Event_Handler Event handler instance
Результат Phergie_Bot Provides a fluent interface

setPluginHandler() публичный Метод

Sets the plugin handler instance to use.
public setPluginHandler ( Phergie_Plugin_Handler $handler ) : Phergie_Bot
$handler Phergie_Plugin_Handler Plugin handler instance
Результат Phergie_Bot Provides a fluent interface

setProcessor() публичный Метод

Sets the processer instance to use.
public setProcessor ( Phergie_Process_Abstract $processor ) : Phergie_Bot
$processor Phergie_Process_Abstract Processer instance
Результат Phergie_Bot Provides a fluent interface

setUi() публичный Метод

Sets the end-user interface instance to use.
public setUi ( Phergie_Ui_Abstract $ui ) : Phergie_Bot
$ui Phergie_Ui_Abstract End-user interface instance
Результат Phergie_Bot Provides a fluent interface

Описание свойств

$config защищенное свойство

Current configuration instance
protected Phergie_Config $config
Результат Phergie_Config

$connections защищенное свойство

Current connection handler instance
protected Phergie_Connection_Handler $connections
Результат Phergie_Connection_Handler

$driver защищенное свойство

Current driver instance
protected Phergie_Driver_Abstract $driver
Результат Phergie_Driver_Abstract

$events защищенное свойство

Current event handler instance
protected Phergie_Event_Handler $events
Результат Phergie_Event_Handler

$plugins защищенное свойство

Current plugin handler instance
protected Phergie_Plugin_Handler $plugins
Результат Phergie_Plugin_Handler

$processor защищенное свойство

Current processor instance
protected Phergie_Process_Abstract $processor
Результат Phergie_Process_Abstract

$ui защищенное свойство

Current end-user interface instance
protected Phergie_Ui_Abstract $ui
Результат Phergie_Ui_Abstract