PHP 클래스 Phergie_Driver_Streams, phergie

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

보호된 프로퍼티들

프로퍼티 타입 설명
$socket resource Reference to the currently active socket handler
$sockets array Socket handlers
$timeout float Amount of time in seconds to wait to receive an event each time the socket is polled

공개 메소드들

메소드 설명
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 usrs in currently joined 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 or response (they are identical) 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.
getActiveReadSockets ( integer $sec, integer $usec = 200000 ) : array Returns a list of hostmasks corresponding to sockets with data to read.
getEvent ( ) : Phergie_Event_Interface | null Listens for an event on the current connection.
getTimeout ( ) : float Returns the amount of time to wait for a new event each time the socket is polled.
setConnection ( Phergie_Connection $connection ) : Phergie_Driver_Streams Overrides the parent class to set the currently active socket handler when the active connection is changed.
setTimeout ( float $timeout ) : Phergie_Driver_Streams Sets the amount of time to wait for a new event each time the socket is polled.

보호된 메소드들

메소드 설명
connect ( string $remote, &$errno, &$errstr, array $context = [] ) : resource Establishes a socket connection, separatedly mainly to allow for stubbing during unit testing.
doCtcp ( string $nick, string $command, string $args = null ) : void Sends a CTCP response to a user.
parseArguments ( string $args, integer $count ) : array Supporting method to parse event argument strings where the last argument may contain a colon.
send ( string $command, string | array $args = '' ) : string Handles construction of command strings and their transmission to the server.
write ( string $data ) : integer Writes data to the socket, separatedly mainly to allow for stubbing during unit testing.

메소드 상세

connect() 보호된 메소드

Establishes a socket connection, separatedly mainly to allow for stubbing during unit testing.
protected connect ( string $remote, &$errno, &$errstr, array $context = [] ) : resource
$remote string Address to connect the socket to
$context array Optional socket context options
리턴 resource Established socket

doAction() 공개 메소드

Sends a CTCP ACTION (/me) command to a nick or channel.
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.
public doConnect ( ) : void
리턴 void

doCtcp() 보호된 메소드

Sends a CTCP response to a user.
protected doCtcp ( string $nick, string $command, string $args = null ) : void
$nick string User nick
$command string Command to send
$args string Sequential arguments (optional)
리턴 void

doFinger() 공개 메소드

Sends a CTCP FINGER request to a user.
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.
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.
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.
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.
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.
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 usrs in currently joined channels.
public doNames ( string $channels ) : void
$channels string Comma-delimited list of one or more channels
리턴 void

doNick() 공개 메소드

Changes the client nick.
public doNick ( string $nick ) : void
$nick string New nick to assign
리턴 void

doNotice() 공개 메소드

Sends a notice to a nick or channel.
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.
public doPart ( string $channels ) : void
$channels string Comma-delimited list of channels to leave
리턴 void

doPing() 공개 메소드

Sends a CTCP PING request or response (they are identical) to a user.
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.
public doPong ( string $daemon ) : void
$daemon string Daemon from which the original request originates
리턴 void

doPrivmsg() 공개 메소드

Sends a message to a nick or channel.
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.
public doQuit ( string $reason = null ) : void
$reason string Reason for connection termination (optional)
리턴 void

doRaw() 공개 메소드

Sends a raw command to the server.
public doRaw ( string $command ) : void
$command string Command string to send
리턴 void

doTime() 공개 메소드

Sends a CTCP TIME request to a user.
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.
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.
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.
public doWhois ( string $nick ) : void
$nick string Nick
리턴 void

getActiveReadSockets() 공개 메소드

Returns a list of hostmasks corresponding to sockets with data to read.
public getActiveReadSockets ( integer $sec, integer $usec = 200000 ) : array
$sec integer Length of time to wait for new data (seconds)
$usec integer Length of time to wait for new data (microseconds)
리턴 array List of hostmasks or an empty array if none were found to have data to read

getEvent() 공개 메소드

Listens for an event on the current connection.
public getEvent ( ) : Phergie_Event_Interface | null
리턴 Phergie_Event_Interface | null Event instance if an event was received, NULL otherwise

getTimeout() 공개 메소드

Returns the amount of time to wait for a new event each time the socket is polled.
public getTimeout ( ) : float
리턴 float Amount of time in seconds

parseArguments() 보호된 메소드

Supporting method to parse event argument strings where the last argument may contain a colon.
protected parseArguments ( string $args, integer $count ) : array
$args string Argument string to parse
$count integer Optional maximum number of arguments
리턴 array Array of argument values

send() 보호된 메소드

Handles construction of command strings and their transmission to the server.
protected send ( string $command, string | array $args = '' ) : string
$command string Command to send
$args string | array Optional string or array of sequential arguments
리턴 string Command string that was sent

setConnection() 공개 메소드

Overrides the parent class to set the currently active socket handler when the active connection is changed.
public setConnection ( Phergie_Connection $connection ) : Phergie_Driver_Streams
$connection Phergie_Connection Active connection
리턴 Phergie_Driver_Streams Provides a fluent interface

setTimeout() 공개 메소드

Sets the amount of time to wait for a new event each time the socket is polled.
public setTimeout ( float $timeout ) : Phergie_Driver_Streams
$timeout float Amount of time in seconds
리턴 Phergie_Driver_Streams Provides a fluent interface

write() 보호된 메소드

Writes data to the socket, separatedly mainly to allow for stubbing during unit testing.
protected write ( string $data ) : integer
$data string Data to write to the socket
리턴 integer Number of bytes successfully written to the socket

프로퍼티 상세

$socket 보호되어 있는 프로퍼티

Reference to the currently active socket handler
protected resource $socket
리턴 resource

$sockets 보호되어 있는 프로퍼티

Socket handlers
protected array $sockets
리턴 array

$timeout 보호되어 있는 프로퍼티

Amount of time in seconds to wait to receive an event each time the socket is polled
protected float $timeout
리턴 float