API Documentation
\
Evenement
Phergie
Irc
Bot
React
PluginProcessor
Client
React
Event
Psr
Log
Test
React
Cache
Dns
Config
Model
Protocol
Query
Resolver
EventLoop
Tick
Timer
Promise
Socket
SocketClient
Stream

\Phergie\Irc\EventEvent

Base class for events.

Summary

Methods
Properties
Constants
setMessage()
getMessage()
setConnection()
getConnection()
setParams()
getParams()
setCommand()
getCommand()
No public properties found
No constants found
No protected methods found
$message
$connection
$params
$command
N/A
No private methods found
No private properties found
N/A

Properties

$message

$message : string

Original unparsed message

Type

string

$connection

$connection : \Phergie\Irc\ConnectionInterface

Metadata for the connection over which the event was received

Type

\Phergie\Irc\ConnectionInterface

$params

$params : array

Command parameters parsed from the message

Type

array

$command

$command : string

Command parsed from the message

Type

string

Methods

setMessage()

setMessage(string $message)

Sets the original unparsed message.

Parameters

string $message

getMessage()

getMessage() : string

Returns the original unparsed message.

Returns

string

setConnection()

setConnection(\Phergie\Irc\ConnectionInterface $connection)

Sets metadata for the connection over which the message was received.

Parameters

\Phergie\Irc\ConnectionInterface $connection

getConnection()

getConnection() : \Phergie\Irc\ConnectionInterface

Returns metadata for the connection over which the message was received.

Returns

\Phergie\Irc\ConnectionInterface

setParams()

setParams(array $params)

Sets the command parameters parsed from the message.

Parameters

array $params

Enumerated array of parameter values

getParams()

getParams() : array

Returns the command parameters parsed from the message.

Returns

array —

Enumerated array of parameter values

setCommand()

setCommand(string $command)

Sets the command parsed from the message.

Parameters

string $command

getCommand()

getCommand() : string

Returns the command parsed from the message.

Returns

string