• 홈
  • Phergie_Driver_Abstract

PHP 클래스 Phergie_Driver_Abstract, phergie

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

보호된 프로퍼티들

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