\Phergie\Irc\Bot\ReactEventQueue

Queue to contain commands issued by plugins to be sent to servers so as to allow for manipulation of those commands by plugins prior to their transmission.

Summary

Methods

Properties

Constants

__construct()
extract()
setPrefix()
compare()
ircPass()
ircNick()
ircUser()
ircServer()
ircOper()
ircQuit()
ircSquit()
ircJoin()
ircPart()
ircMode()
ircTopic()
ircNames()
ircList()
ircInvite()
ircKick()
ircVersion()
ircStats()
ircLinks()
ircTime()
ircConnect()
ircTrace()
ircAdmin()
ircInfo()
ircPrivmsg()
ircNotice()
ircWho()
ircWhois()
ircWhowas()
ircKill()
ircPing()
ircPong()
ircError()
ircAway()
ircRehash()
ircRestart()
ircSummon()
ircUsers()
ircWallops()
ircUserhost()
ircIson()
ctcpFinger()
ctcpFingerResponse()
ctcpVersion()
ctcpVersionResponse()
ctcpSource()
ctcpSourceResponse()
ctcpUserinfo()
ctcpUserinfoResponse()
ctcpClientinfo()
ctcpClientinfoResponse()
ctcpErrmsg()
ctcpErrmsgResponse()
ctcpPing()
ctcpPingResponse()
ctcpTime()
ctcpTimeResponse()
ctcpAction()
ctcpActionResponse()

No public properties found

No constants found

getPriority()
queueIrcRequest()
queueCtcpEvent()
queueCtcpRequest()
queueCtcpResponse()

$prefix
$priorities
$lastTimestamp

N/A

No private methods found

No private properties found

N/A

File: src/EventQueue.php
Package: \Phergie\Irc\Bot\React
Class hierarchy: \SplPriorityQueue

\Phergie\Irc\Bot\React\EventQueue
Implements: \Phergie\Irc\Bot\React\EventQueueInterface

Tags

category	Phergie
todo

Properties

$prefix

$prefix : string

Prefix for queued messages

Type

string

Tags

todo

$priorities

$priorities : array

Enumerated array of commands in priority order

Type

array

Tags

todo

$lastTimestamp

$lastTimestamp : int

Track the last timestamp used for priority so we can avoid duplicate values

Type

int

Tags

todo

Methods

__construct()

__construct()

Initializes the list of event priorities.

Tags

todo

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

Tags

todo

setPrefix()

setPrefix(string $prefix)

Implements \Phergie\Irc\GeneratorInterface->setPrefix().

Parameters

string

$prefix

Tags

todo

compare()

compare(\Phergie\Irc\Bot\React\EventQueuePriority $priority1, \Phergie\Irc\Bot\React\EventQueuePriority $priority2) : int

Overrides native default comparison logic to assign higher priority to events inserted earlier.

Parameters

\Phergie\Irc\Bot\React\EventQueuePriority	$priority1
\Phergie\Irc\Bot\React\EventQueuePriority	$priority2

Returns

int

Tags

todo

ircPass()

ircPass(string $password)

Implements \Phergie\Irc\GeneratorInterface->ircPass().

Parameters

string

$password

Tags

todo

ircNick()

ircNick(string $nickname, int $hopcount)

Implements \Phergie\Irc\GeneratorInterface->ircNick().

Parameters

string	$nickname
int	$hopcount

Tags

todo

ircUser()

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

Implements \Phergie\Irc\GeneratorInterface->ircUser().

Parameters

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

Tags

todo

ircServer()

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

Implements \Phergie\Irc\GeneratorInterface->ircServer().

Parameters

string	$servername
int	$hopcount
string	$info

Tags

todo

ircOper()

ircOper(string $user, string $password)

Implements \Phergie\Irc\GeneratorInterface->ircOper().

Parameters

string	$user
string	$password

Tags

todo

ircQuit()

ircQuit(string $message)

Implements \Phergie\Irc\GeneratorInterface->ircQuit().

Parameters

string

$message

Tags

todo

ircSquit()

ircSquit(string $server, string $comment)

Implements \Phergie\Irc\GeneratorInterface->ircSquit().

Parameters

string	$server
string	$comment

Tags

todo

ircJoin()

ircJoin(string $channels, string $keys)

Implements \Phergie\Irc\GeneratorInterface->ircJoin().

Parameters

string	$channels
string	$keys

Tags

todo

ircPart()

ircPart(string $channels, string|null $message)

Implements \Phergie\Irc\GeneratorInterface->ircPart().

Parameters

string	$channels
string\|null	$message

Tags

todo

ircMode()

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

Implements \Phergie\Irc\GeneratorInterface->ircMode().

Parameters

string	$target
string	$mode
string	$param

Tags

todo

ircTopic()

ircTopic(string $channel, string $topic)

Implements \Phergie\Irc\GeneratorInterface->ircTopic().

Parameters

string	$channel
string	$topic

Tags

todo

ircNames()

ircNames(string $channels)

Implements \Phergie\Irc\GeneratorInterface->ircNames().

Parameters

string

$channels

Tags

todo

ircList()

ircList(string $channels, string $server)

Implements \Phergie\Irc\GeneratorInterface->ircList().

Parameters

string	$channels
string	$server

Tags

todo

ircInvite()

ircInvite(string $nickname, string $channel)

Implements \Phergie\Irc\GeneratorInterface->ircInvite().

Parameters

string	$nickname
string	$channel

Tags

todo

ircKick()

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

Implements \Phergie\Irc\GeneratorInterface->ircKick().

Parameters

string	$channel
string	$user
string	$comment

Tags

todo

ircVersion()

ircVersion(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircVersion().

Parameters

string

$server

Tags

todo

ircStats()

ircStats(string $query, string $server)

Implements \Phergie\Irc\GeneratorInterface->ircStats().

Parameters

string	$query
string	$server

Tags

todo

ircLinks()

ircLinks(string $servermask, string $remoteserver)

Implements \Phergie\Irc\GeneratorInterface->ircLinks().

Parameters

string	$servermask
string	$remoteserver

Tags

todo

ircTime()

ircTime(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircTime().

Parameters

string

$server

Tags

todo

ircConnect()

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

Implements \Phergie\Irc\GeneratorInterface->ircConnect().

Parameters

string	$targetserver
int	$port
string	$remoteserver

Tags

todo

ircTrace()

ircTrace(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircTrace().

Parameters

string

$server

Tags

todo

ircAdmin()

ircAdmin(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircAdmin()

Parameters

string

$server

Tags

todo

ircInfo()

ircInfo(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircInfo().

Parameters

string

$server

Tags

todo

ircPrivmsg()

ircPrivmsg(string $receivers, string $text)

Implements \Phergie\Irc\GeneratorInterface->ircPrivmsg().

Parameters

string	$receivers
string	$text

Tags

todo

ircNotice()

ircNotice(string $nickname, string $text)

Implements \Phergie\Irc\GeneratorInterface->ircNotice().

Parameters

string	$nickname
string	$text

Tags

todo

ircWho()

ircWho(string $name, string $o)

Implements \Phergie\Irc\GeneratorInterface->ircWho().

Parameters

string	$name
string	$o

Tags

todo

ircWhois()

ircWhois(string $server, string $nickmasks)

Implements \Phergie\Irc\GeneratorInterface->ircWhois().

Parameters

string	$server
string	$nickmasks

Tags

todo

ircWhowas()

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

Implements \Phergie\Irc\GeneratorInterface->ircWhowas().

Parameters

string	$nickname
int	$count
string	$server

Tags

todo

ircKill()

ircKill(string $nickname, string $comment)

Implements \Phergie\Irc\GeneratorInterface->ircKill().

Parameters

string	$nickname
string	$comment

Tags

todo

ircPing()

ircPing(string $server1, string $server2)

Implements \Phergie\Irc\GeneratorInterface->ircPing().

Parameters

string	$server1
string	$server2

Tags

todo

ircPong()

ircPong(string $daemon, string $daemon2)

Implements \Phergie\Irc\GeneratorInterface->ircPong().

Parameters

string	$daemon
string	$daemon2

Tags

todo

ircError()

ircError(string $message)

Implements \Phergie\Irc\GeneratorInterface->ircError().

Parameters

string

$message

Tags

todo

ircAway()

ircAway(string $message)

Implements \Phergie\Irc\GeneratorInterface->ircAway().

Parameters

string

$message

Tags

todo

ircRehash()

ircRehash()

Implements \Phergie\Irc\GeneratorInterface->ircRehash().

Tags

todo

ircRestart()

ircRestart()

Implements \Phergie\Irc\GeneratorInterface->ircRestart().

Tags

todo

ircSummon()

ircSummon(string $user, string $server)

Implements \Phergie\Irc\GeneratorInterface->ircSummon().

Parameters

string	$user
string	$server

Tags

todo

ircUsers()

ircUsers(string $server)

Implements \Phergie\Irc\GeneratorInterface->ircUsers().

Parameters

string

$server

Tags

todo

ircWallops()

ircWallops(string $text)

Implements \Phergie\Irc\GeneratorInterface->ircWallops().

Parameters

string

$text

Tags

todo

ircUserhost()

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

Implements \Phergie\Irc\GeneratorInterface->ircUserhost().

Parameters

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

Tags

todo

ircIson()

ircIson(string $nicknames)

Implements \Phergie\Irc\GeneratorInterface->ircIson().

Parameters

string

$nicknames

Tags

todo

ctcpFinger()

ctcpFinger(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpFinger().

Parameters

string

$receivers

Tags

todo

ctcpFingerResponse()

ctcpFingerResponse(string $nickname, string $text)

Implements \Phergie\Irc\GeneratorInterface->ctcpFingerResponse().

Parameters

string	$nickname
string	$text

Tags

todo

ctcpVersion()

ctcpVersion(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpVersion().

Parameters

string

$receivers

Tags

todo

ctcpVersionResponse()

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

Implements \Phergie\Irc\GeneratorInterface->ctcpVersionResponse().

Parameters

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

Tags

todo

ctcpSource()

ctcpSource(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpSource().

Parameters

string

$receivers

Tags

todo

ctcpSourceResponse()

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

Implements \Phergie\Irc\GeneratorInterface->ctcpSourceResponse().

Parameters

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

Tags

todo

ctcpUserinfo()

ctcpUserinfo(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpUserinfo().

Parameters

string

$receivers

Tags

todo

ctcpUserinfoResponse()

ctcpUserinfoResponse(string $nickname, string $text)

Implements \Phergie\Irc\GeneratorInterface->ctcpUserinfoResponse().

Parameters

string	$nickname
string	$text

Tags

todo

ctcpClientinfo()

ctcpClientinfo(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpClientinfo().

Parameters

string

$receivers

Tags

todo

ctcpClientinfoResponse()

ctcpClientinfoResponse(string $nickname, string $client)

Implements \Phergie\Irc\GeneratorInterface->ctcpClientinfoResponse().

Parameters

string	$nickname
string	$client

Tags

todo

ctcpErrmsg()

ctcpErrmsg(string $receivers, string $query)

Implements \Phergie\Irc\GeneratorInterface->ctcpErrmsg().

Parameters

string	$receivers
string	$query

Tags

todo

ctcpErrmsgResponse()

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

Implements \Phergie\Irc\GeneratorInterface->ctcpErrmsgResponse().

Parameters

string	$nickname
string	$query
string	$message

Tags

todo

ctcpPing()

ctcpPing(string $receivers, int $timestamp)

Implements \Phergie\Irc\GeneratorInterface->ctcpPing().

Parameters

string	$receivers
int	$timestamp

Tags

todo

ctcpPingResponse()

ctcpPingResponse(string $nickname, int $timestamp)

Implements \Phergie\Irc\GeneratorInterface->ctcpPingResponse().

Parameters

string	$nickname
int	$timestamp

Tags

todo

ctcpTime()

ctcpTime(string $receivers)

Implements \Phergie\Irc\GeneratorInterface->ctcpTime().

Parameters

string

$receivers

Tags

todo

ctcpTimeResponse()

ctcpTimeResponse(string $nickname, string $time)

Implements \Phergie\Irc\GeneratorInterface->ctcpTimeResponse().

Parameters

string	$nickname
string	$time

Tags

todo

ctcpAction()

ctcpAction(string $receivers, string $action)

Implements \Phergie\Irc\GeneratorInterface->ctcpAction().

Parameters

string	$receivers
string	$action

Tags

todo

ctcpActionResponse()

ctcpActionResponse(string $nickname, string $action)

Implements \Phergie\Irc\GeneratorInterface->ctcpActionResponse().

Parameters

string	$nickname
string	$action

Tags

todo

getPriority()

getPriority(string $command, array $params) : \Phergie\Irc\Bot\React\EventQueuePriority

Returns the priority of a specified command.

Parameters

string	$command
array	$params	Unused, intended for use by subclasses

Returns

\Phergie\Irc\Bot\React\EventQueuePriority

Tags

todo

queueIrcRequest()

queueIrcRequest(string $command, array $params)

Enqueues a new IRC event.

Parameters

string	$command
array	$params

Tags

todo

queueCtcpEvent()

queueCtcpEvent(string $command, string $ctcpCommand, array $params)

Enqueues a new CTCP event.

Parameters

string	$command	IRC command
string	$ctcpCommand	CTCP command
array	$params	Command parameters

Tags

todo

queueCtcpRequest()

queueCtcpRequest(string $ctcpCommand, array $params)

Enqueues a new CTCP request.

Parameters

string	$ctcpCommand	CTCP command
array	$params	Command parameters

Tags

todo

queueCtcpResponse()

queueCtcpResponse(string $ctcpCommand, array $params)

Enqueues a new CTCP response.

Parameters

string	$ctcpCommand	CTCP command
array	$params	CTCP parameters

Tags

todo