PHP Класс Phergie_Driver_Abstract, phergie

См. ссылку: http://pear.phergie.org/package/Phergie
Автор: Phergie Development Team ([email protected])
Показать файл Открыть проект Примеры использования класса

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

Свойство Тип Описание
$connection Phergie_Connection Currently active connection

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

Метод Описание
doAction ( string $target, string $text ) : void Sends a CTCP ACTION (/me) command to a nick or channel.
doConnect ( ) : void Initiates a connection with the server.
doFinger ( string $nick, string $finger = null ) : void Sends a CTCP FINGER request to a user.
doInvite ( string $nick, string $channel ) : void Invites a user to an invite-only channel.
doJoin ( string $channels, string $keys = null ) : void Joins a channel.
doKick ( string $nick, string $channel, string $reason = null ) : void Kicks a user from a channel.
doList ( string $channels = null ) : void Obtains a list of channel names and topics.
doMode ( string $target, string $mode = null, string $param = null ) : void Retrieves or changes a channel or user mode.
doNames ( string $channels ) : void Obtains a list of nicks of users in specified channels.
doNick ( string $nick ) : void Changes the client nick.
doNotice ( string $target, string $text ) : void Sends a notice to a nick or channel.
doPart ( string $channels ) : void Leaves a channel.
doPing ( string $nick, string $hash ) : void Sends a CTCP PING request to a user.
doPong ( string $daemon ) : void Responds to a server test of client responsiveness.
doPrivmsg ( string $target, string $text ) : void Sends a message to a nick or channel.
doQuit ( string $reason = null ) : void Terminates the connection with the server.
doRaw ( string $command ) : void Sends a raw command to the server.
doTime ( string $nick, string $time = null ) : void Sends a CTCP TIME request to a user.
doTopic ( string $channel, string $topic = null ) : void Retrieves or changes a channel topic.
doVersion ( string $nick, string $version = null ) : void Sends a CTCP VERSION request or response to a user.
doWhois ( string $nick ) : void Retrieves information about a nick.
getConnection ( ) : Phergie_Connection Returns the currently active connection.
getEvent ( ) : Phergie_Event_Interface | null Returns an event if one has been received from the server.
setConnection ( Phergie_Connection $connection ) : Phergie_Driver_Abstract Sets the currently active connection.

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

doAction() абстрактный публичный Метод

Sends a CTCP ACTION (/me) command to a nick or channel.
См. ссылку: http://www.invlogic.com/irc/ctcp.html#4.4
abstract public doAction ( string $target, string $text ) : void
$target string Channel name or user nick
$text string Text of the action to perform
Результат void

doConnect() абстрактный публичный Метод

Initiates a connection with the server.
abstract public doConnect ( ) : void
Результат void

doFinger() абстрактный публичный Метод

Sends a CTCP FINGER request to a user.
См. ссылку: http://www.irchelp.org/irchelp/rfc/ctcpspec.html
abstract public doFinger ( string $nick, string $finger = null ) : void
$nick string User nick
$finger string Finger string to send for a response
Результат void

doInvite() абстрактный публичный Метод

Invites a user to an invite-only channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_7
abstract public doInvite ( string $nick, string $channel ) : void
$nick string Nick of the user to invite
$channel string Name of the channel
Результат void

doJoin() абстрактный публичный Метод

Joins a channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_1
abstract public doJoin ( string $channels, string $keys = null ) : void
$channels string Comma-delimited list of channels to join
$keys string Optional comma-delimited list of channel keys
Результат void

doKick() абстрактный публичный Метод

Kicks a user from a channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_8
abstract public doKick ( string $nick, string $channel, string $reason = null ) : void
$nick string Nick of the user
$channel string Channel name
$reason string Reason for the kick (optional)
Результат void

doList() абстрактный публичный Метод

Obtains a list of channel names and topics.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_6
abstract public doList ( string $channels = null ) : void
$channels string Comma-delimited list of one or more channels to which the response should be restricted (optional)
Результат void

doMode() абстрактный публичный Метод

Retrieves or changes a channel or user mode.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_3
abstract public doMode ( string $target, string $mode = null, string $param = null ) : void
$target string Channel name or user nick
$mode string New mode to assign (optional)
$param string User limit when $mode is 'l', user hostmask when $mode is 'b', or user nick when $mode is 'o'
Результат void

doNames() абстрактный публичный Метод

Obtains a list of nicks of users in specified channels.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_5
abstract public doNames ( string $channels ) : void
$channels string Comma-delimited list of one or more channels
Результат void

doNick() абстрактный публичный Метод

Changes the client nick.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_1_2
abstract public doNick ( string $nick ) : void
$nick string New nick to assign
Результат void

doNotice() абстрактный публичный Метод

Sends a notice to a nick or channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_4_2
abstract public doNotice ( string $target, string $text ) : void
$target string Channel name or user nick
$text string Text of the notice to send
Результат void

doPart() абстрактный публичный Метод

Leaves a channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_2
abstract public doPart ( string $channels ) : void
$channels string Comma-delimited list of channels to leave
Результат void

doPing() абстрактный публичный Метод

Sends a CTCP PING request to a user.
См. ссылку: http://www.invlogic.com/irc/ctcp.html#4.2
abstract public doPing ( string $nick, string $hash ) : void
$nick string User nick
$hash string Hash to use in the handshake
Результат void

doPong() абстрактный публичный Метод

Responds to a server test of client responsiveness.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_6_3
abstract public doPong ( string $daemon ) : void
$daemon string Daemon from which the original request originates
Результат void

doPrivmsg() абстрактный публичный Метод

Sends a message to a nick or channel.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_4_1
abstract public doPrivmsg ( string $target, string $text ) : void
$target string Channel name or user nick
$text string Text of the message to send
Результат void

doQuit() абстрактный публичный Метод

Terminates the connection with the server.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_1_6
abstract public doQuit ( string $reason = null ) : void
$reason string Reason for connection termination (optional)
Результат void

doRaw() абстрактный публичный Метод

Sends a raw command to the server.
abstract public doRaw ( string $command ) : void
$command string Command string to send
Результат void

doTime() абстрактный публичный Метод

Sends a CTCP TIME request to a user.
См. ссылку: http://www.invlogic.com/irc/ctcp.html#4.6
abstract public doTime ( string $nick, string $time = null ) : void
$nick string User nick
$time string Time string to send for a response
Результат void

doTopic() абстрактный публичный Метод

Retrieves or changes a channel topic.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_2_4
abstract public doTopic ( string $channel, string $topic = null ) : void
$channel string Name of the channel
$topic string New topic to assign (optional)
Результат void

doVersion() абстрактный публичный Метод

Sends a CTCP VERSION request or response to a user.
См. ссылку: http://www.invlogic.com/irc/ctcp.html#4.1
abstract public doVersion ( string $nick, string $version = null ) : void
$nick string User nick
$version string Version string to send for a response
Результат void

doWhois() абстрактный публичный Метод

Retrieves information about a nick.
См. ссылку: http://www.irchelp.org/irchelp/rfc/chapter4.html#c4_5_2
abstract public doWhois ( string $nick ) : void
$nick string Nick
Результат void

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

Returns the currently active connection.
public getConnection ( ) : Phergie_Connection
Результат Phergie_Connection

getEvent() абстрактный публичный Метод

Returns an event if one has been received from the server.
abstract public getEvent ( ) : Phergie_Event_Interface | null
Результат Phergie_Event_Interface | null Event instance if an event has been received, NULL otherwise

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

Sets the currently active connection.
public setConnection ( Phergie_Connection $connection ) : Phergie_Driver_Abstract
$connection Phergie_Connection Active connection
Результат Phergie_Driver_Abstract Provides a fluent interface

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

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

Currently active connection
protected Phergie_Connection $connection
Результат Phergie_Connection