Methods

getPrefix()

getPrefix() : string

Gets the prefix identifying the sender of the event.

Returns

string

setPrefix()

setPrefix(string $prefix)

Sets the prefix identifying the sender of the event.

Parameters

string $prefix

getNick()

getNick() : string

Returns the nick portion of the prefix identifying the sender of the event.

Returns

string

setNick()

setNick(string $nick)

Sets the nick portion of the prefix identifying the sender of the event.

Parameters

string $nick

getUsername()

getUsername() : string

Returns the username portion of the prefix identifying the sender of the event.

Returns

string

setUsername()

setUsername(string $username)

Sets the username portion of the prefix identifying the sender of the event.

Parameters

string $username

getHost()

getHost() : string

Returns the host portion of the prefix identifying the sender of the event.

Returns

string

setHost()

setHost(string $host)

Sets the host portion of the prefix identifying the sender of the event.

Parameters

string $host

setTargets()

setTargets(array $targets)

Sets targets parsed from the message, typically user nicks or channel names.

Parameters

array $targets

getTargets()

getTargets() : array

Returns targets parsed from the message, typically user nicks or channel names.

Returns

array

getSource()

getSource() : string

Returns the source of this event.

If the event occurred within a channel, this will be the channel name. If it was sent directly to the bot, this will be the nickname of the originating user.

Returns

string —

User nick or channel name

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

setCtcpParams()

setCtcpParams(array $params)

Sets the CTCP command parameters parsed from the message.

Parameters

array $params

Enumerated array of parameter values

getCtcpParams()

getCtcpParams() : array

Returns the CTCP command parameters parsed from the message.

Returns

array —

Enumerated array of parameter values

setCtcpCommand()

setCtcpCommand(string $command)

Sets the CTCP command parsed from the message.

Parameters

string $command

getCtcpCommand()

getCtcpCommand() : string

Returns the CTCP command parsed from the message.

Returns

string