PHP 클래스 Phergie_Bot, phergie

저자: Phergie Development Team ([email protected])
파일 보기 프로젝트 열기: phergie/phergie 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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