PHP Class PHPDaemon\Clients\IRC\Connection

Author: Vasily Zorin ([email protected])
Inheritance: extends PHPDaemon\Network\ClientConnection
Exibir arquivo Open project: kakserpom/phpdaemon Class Usage Examples

Public Properties

Property Type Description
$EOL string
$buffers array
$channels array
$lastPingTS integer
$latency integer
$mode string
$nick string
$realname string
$servername string
$timeout integer

Protected Properties

Property Type Description
$bevConnectEnabled To get local port number
$password Password
$user Username

Public Methods

Method Description
addMode ( string $channel, string $target, string $mode )
channel ( string $chan ) : Channel
channelIfExists ( string $chan ) : boolean
command ( string $cmd )
commandArr ( integer | string $cmd, array $args = [] ) : boolean
join ( array $channels )
message ( string $to, string $msg )
onCommand ( string $from, string $cmd, array $args )
onFinish ( ) : void Called when connection finishes
onRead ( ) : void Called when new data received
onReady ( ) : void Called when the connection is handshaked (at low-level), and peer is ready to recv. data
part ( array $channels, mixed $msg = null )
ping ( )
removeMode ( string $channel, string $target, string $mode )

Method Details

addMode() public method

public addMode ( string $channel, string $target, string $mode )
$channel string
$target string
$mode string

channel() public method

public channel ( string $chan ) : Channel
$chan string
return Channel

channelIfExists() public method

public channelIfExists ( string $chan ) : boolean
$chan string
return boolean

command() public method

public command ( string $cmd )
$cmd string

commandArr() public method

public commandArr ( integer | string $cmd, array $args = [] ) : boolean
$cmd integer | string
$args array
return boolean

join() public method

public join ( array $channels )
$channels array

message() public method

public message ( string $to, string $msg )
$to string
$msg string

onCommand() public method

public onCommand ( string $from, string $cmd, array $args )
$from string
$cmd string
$args array

onFinish() public method

Called when connection finishes
public onFinish ( ) : void
return void

onRead() public method

Called when new data received
public onRead ( ) : void
return void

onReady() public method

Called when the connection is handshaked (at low-level), and peer is ready to recv. data
public onReady ( ) : void
return void

part() public method

public part ( array $channels, mixed $msg = null )
$channels array
$msg mixed

ping() public method

public ping ( )

removeMode() public method

public removeMode ( string $channel, string $target, string $mode )
$channel string
$target string
$mode string

Property Details

$EOL public_oe property

public string $EOL
return string

$bevConnectEnabled protected_oe property

To get local port number
protected $bevConnectEnabled

$buffers public_oe property

public array $buffers
return array

$channels public_oe property

public array $channels
return array

$lastPingTS public_oe property

public int $lastPingTS
return integer

$latency public_oe property

public int $latency
return integer

$mode public_oe property

public string $mode
return string

$nick public_oe property

public string $nick
return string

$password protected_oe property

Password
protected $password

$realname public_oe property

public string $realname
return string

$servername public_oe property

public string $servername
return string

$timeout public_oe property

public int $timeout
return integer

$user protected_oe property

Username
protected $user