Methods

setPrefix()

setPrefix(string $prefix)

Sets the message prefix.

Parameters

string $prefix

ircPass()

ircPass(string $password) : string

Returns a PASS message.

Parameters

string $password

Returns

string

ircNick()

ircNick(string $nickname, int $hopcount) : string

Returns a NICK message.

Parameters

string $nickname
int $hopcount

Returns

string

ircUser()

ircUser(string $username, string $hostname, string $servername, string $realname) : string

Returns a USER message.

Parameters

string $username
string $hostname
string $servername
string $realname

Returns

string

ircServer()

ircServer(string $servername, int $hopcount, string $info) : string

Returns a SERVER message.

Parameters

string $servername
int $hopcount
string $info

Returns

string

ircOper()

ircOper(string $user, string $password) : string

Returns an OPER message.

Parameters

string $user
string $password

Returns

string

ircQuit()

ircQuit(string $message) : string

Returns a QUIT message.

Parameters

string $message

Returns

string

ircSquit()

ircSquit(string $server, string $comment) : string

Returns an SQUIT message.

Parameters

string $server
string $comment

Returns

string

ircJoin()

ircJoin(string $channels, string $keys) : string

Returns a JOIN message.

Parameters

string $channels
string $keys

Returns

string

ircPart()

ircPart(string $channels, string $message) : string

Returns a PART message.

Parameters

string $channels
string $message

Returns

string

ircMode()

ircMode(string $target, string $mode, string $param) : string

Returns a MODE message.

Parameters

string $target
string $mode
string $param

Returns

string

ircTopic()

ircTopic(string $channel, string $topic) : string

Returns a TOPIC message.

Parameters

string $channel
string $topic

Returns

string

ircNames()

ircNames(string $channels) : string

Returns a NAMES message.

Parameters

string $channels

Returns

string

ircList()

ircList(string $channels, string $server) : string

Returns a LIST message.

Parameters

string $channels
string $server

Returns

string

ircInvite()

ircInvite(string $nickname, string $channel) : string

Returns an INVITE message.

Parameters

string $nickname
string $channel

Returns

string

ircKick()

ircKick(string $channel, string $user, string $comment) : string

Returns a KICK message.

Parameters

string $channel
string $user
string $comment

Returns

string

ircVersion()

ircVersion(string $server) : string

Returns a VERSION message.

Parameters

string $server

Returns

string

ircStats()

ircStats(string $query, string $server) : string

Returns a STATS message.

Parameters

string $query
string $server

Returns

string

ircLinks()

ircLinks(string $servermask, string $remoteserver) : string

Returns a LINKS message.

Note that the parameter order of this method is reversed with respect to the corresponding IRC message to alleviate the need to explicitly specify a null value for $remoteserver when it is not used.

Parameters

string $servermask
string $remoteserver

Returns

string

ircTime()

ircTime(string $server) : string

Returns a TIME message.

Parameters

string $server

Returns

string

ircConnect()

ircConnect(string $targetserver, int $port, string $remoteserver) : string

Returns a CONNECT message.

Parameters

string $targetserver
int $port
string $remoteserver

Returns

string

ircTrace()

ircTrace(string $server) : string

Returns a TRACE message.

Parameters

string $server

Returns

string

ircAdmin()

ircAdmin(string $server) : string

Returns an ADMIN message.

Parameters

string $server

Returns

string

ircInfo()

ircInfo(string $server) : string

Returns an INFO message.

Parameters

string $server

Returns

string

ircPrivmsg()

ircPrivmsg(string $receivers, string $text) : string

Returns a PRIVMSG message.

Parameters

string $receivers
string $text

Returns

string

ircNotice()

ircNotice(string $nickname, string $text) : string

Returns a NOTICE message.

Parameters

string $nickname
string $text

Returns

string

ircWho()

ircWho(string $name, string $o) : string

Returns a WHO message.

Parameters

string $name
string $o

Returns

string

ircWhois()

ircWhois(string $server, string $nickmasks) : string

Returns a WHOIS message.

Parameters

string $server
string $nickmasks

Returns

string

ircWhowas()

ircWhowas(string $nickname, int $count, string $server) : string

Returns a WHOWAS message.

Parameters

string $nickname
int $count
string $server

Returns

string

ircKill()

ircKill(string $nickname, string $comment) : string

Returns a KILL message.

Parameters

string $nickname
string $comment

Returns

string

ircPing()

ircPing(string $server1, string $server2) : string

Returns a PING message.

Parameters

string $server1
string $server2

Returns

string

ircPong()

ircPong(string $daemon, string $daemon2) : string

Returns a PONG message.

Parameters

string $daemon
string $daemon2

Returns

string

ircError()

ircError(string $message) : string

Returns an ERROR message.

Parameters

string $message

Returns

string

ircAway()

ircAway(string $message) : string

Returns an AWAY message.

Parameters

string $message

Returns

string

ircRehash()

ircRehash() : string

Returns a REHASH message.

Returns

string

ircRestart()

ircRestart() : string

Returns a RESTART message.

Returns

string

ircSummon()

ircSummon(string $user, string $server) : string

Returns a SUMMON message.

Parameters

string $user
string $server

Returns

string

ircUsers()

ircUsers(string $server) : string

Returns a USERS message.

Parameters

string $server

Returns

string

ircWallops()

ircWallops(string $text) : string

Returns a WALLOPS message.

Parameters

string $text

Returns

string

ircUserhost()

ircUserhost(string $nickname1, string $nickname2, string $nickname3, string $nickname4, string $nickname5) : string

Returns a USERHOST message.

Parameters

string $nickname1
string $nickname2
string $nickname3
string $nickname4
string $nickname5

Returns

string

ircIson()

ircIson(string $nicknames) : string

Returns an ISON message.

Parameters

string $nicknames

Returns

string

ctcpFinger()

ctcpFinger(string $receivers) : string

Returns a CTCP FINGER message.

Parameters

string $receivers

Returns

string

ctcpFingerResponse()

ctcpFingerResponse(string $nickname, string $text) : string

Returns a CTCP FINGER reply message.

Parameters

string $nickname
string $text

Returns

string

ctcpVersion()

ctcpVersion(string $receivers) : string

Returns a CTCP VERSION message.

Parameters

string $receivers

Returns

string

ctcpVersionResponse()

ctcpVersionResponse(string $nickname, string $name, string $version, string $environment) : string

Returns a CTCP VERSION reply message.

Parameters

string $nickname
string $name
string $version
string $environment

Returns

string

ctcpSource()

ctcpSource(string $receivers) : string

Returns a CTCP SOURCE message.

Parameters

string $receivers

Returns

string

ctcpSourceResponse()

ctcpSourceResponse(string $nickname, string $host, string $directories, string $files) : string

Returns a CTCP SOURCE reply message.

Parameters

string $nickname
string $host
string $directories
string $files

Returns

string

ctcpUserinfo()

ctcpUserinfo(string $receivers) : string

Returns a CTCP USERINFO message.

Parameters

string $receivers

Returns

string

ctcpUserinfoResponse()

ctcpUserinfoResponse(string $nickname, string $text) : string

Returns a CTCP USERINFO reply message.

Parameters

string $nickname
string $text

Returns

string

ctcpClientinfo()

ctcpClientinfo(string $receivers) : string

Returns a CTCP CLIENTINFO message.

Parameters

string $receivers

Returns

string

ctcpClientinfoResponse()

ctcpClientinfoResponse(string $nickname, string $client) : string

Returns a CTCP CLIENTINFO reply message.

Parameters

string $nickname
string $client

Returns

string

ctcpErrmsg()

ctcpErrmsg(string $receivers, string $query) : string

Returns a CTCP ERRMSG message.

Parameters

string $receivers
string $query

Returns

string

ctcpErrmsgResponse()

ctcpErrmsgResponse(string $nickname, string $query, string $message) : string

Returns a CTCP ERRMSG reply message.

Parameters

string $nickname
string $query
string $message

Returns

string

ctcpPing()

ctcpPing(string $receivers, int $timestamp) : string

Returns a CTCP PING message.

Parameters

string $receivers
int $timestamp

Returns

string

ctcpPingResponse()

ctcpPingResponse(string $nickname, int $timestamp) : string

Returns a CTCP PING reply message.

Parameters

string $nickname
int $timestamp

Returns

string

ctcpTime()

ctcpTime(string $receivers) : string

Returns a CTCP TIME message.

Parameters

string $receivers

Returns

string

ctcpTimeResponse()

ctcpTimeResponse(string $nickname, string $time) : string

Returns a CTCP TIME reply message.

Parameters

string $nickname
string $time

Returns

string

ctcpAction()

ctcpAction(string $receivers, string $action) : string

Returns a CTCP ACTION message.

Parameters

string $receivers
string $action

Returns

string

ctcpActionResponse()

ctcpActionResponse(string $nickname, string $action) : string

Returns a CTCP ACTION reply message.

Parameters

string $nickname
string $action

Returns

string

extract()

extract() : \Phergie\Irc\Event\EventInterface|null

Removes and returns an event from the front of the queue.

Returns

\Phergie\Irc\Event\EventInterface|null —

Removed event or null if

    the queue is empty