• Главная
• Phergie
• Irc
• Bot
• React
• Bot

PHP Класс Phergie\Irc\Bot\React\Bot

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$client	Phergie\Irc\Client\React\ClientInterface	IRC client in use by the bot
$config	array	Configuration in use by the bot
$converter	Phergie\Irc\Event\ParserConverterInterface	Converter for event data from the IRC client's underlying parser
$logger	Psr\Log\LoggerInterface	Logger in use by the bot, defaults to logger in use by the IRC client
$parser	Phergie\Irc\ParserInterface	Parser for converting generated IRC commands into event objects
$queueFactory	Phergie\Irc\Bot\React\EventQueueFactoryInterface	Event queue factory for creating connection-specific event queues

Открытые методы

Метод	Описание
getClient ( ) : Phergie\Irc\Client\React\ClientInterface	Returns the IRC client in use by the bot.
getConfig ( ) : array	Returns the configuration in use by the bot.
getConverter ( ) : Phergie\Irc\Event\ParserConverterInterface	Returns the parser converter for event data in use by the bot.
getEventQueueFactory ( ) : Phergie\Irc\Bot\React\EventQueueFactoryInterface	Returns the event queue factory in use by the bot.
getLogger ( ) : Psr\Log\LoggerInterface	Returns the logger in use by the bot.
getParser ( ) : Phergie\Irc\ParserInterface	Returns the parser for generated event data in use by the bot.
processClientEvent ( string $event, array $message, Phergie\Irc\ConnectionInterface $connection, Phergie\Irc\Client\React\WriteStream $write )	Callback to process client events. Not intended to be called from outside this class.
processOutgoingEvents ( Phergie\Irc\ConnectionInterface $connection, Phergie\Irc\Client\React\WriteStream $write )	Callback to process any queued outgoing events. Not intended to be called from outside thie class.
run ( boolean $autorun = true )	Initiates an event loop for the bot in which it will connect to servers and monitor those connections for events to forward to plugins.
setClient ( Phergie\Irc\Client\React\ClientInterface $client )	Sets the IRC client for the bot to use.
setConfig ( array $config )	Sets the configuration to be used by the bot in its operations.
setConverter ( Phergie\Irc\Event\ParserConverterInterface $converter )	Sets the parser converter for event data in use by the bot.
setEventQueueFactory ( Phergie\Irc\Bot\React\EventQueueFactoryInterface $queueFactory )	Sets the event queue factory for the bot to use.
setLogger ( Psr\Log\LoggerInterface $logger )	Sets the logger in use by the bot.
setParser ( Phergie\Irc\ParserInterface $parser )	Sets the parser for generated event data in use by the bot.

Защищенные методы

Метод	Описание
getConnections ( array $config ) : Phergie\Irc\ConnectionInterface[]	Extracts connections from configuration.
getDefaultPluginProcessors ( ) : Phergie\Irc\Bot\React\PluginProcessor\PluginProcessorInterface[]	Returns a list of default plugin processors used when none are set via configuration.
getEventSubtype ( Phergie\Irc\Event\EventInterface $event ) : string	Returns an event subtype corresponding to a given event object, used to generate event names when emitting events.
getPluginProcessors ( array $config )	Returns a list of processors for plugins.
getPlugins ( array $config ) : Phergie\Irc\Bot\React\PluginInterface[]	Extracts plugins from configuration.
processPlugins ( array $plugins, array $processors, SplObjectStorage $processedPlugins = null )	Processes a list of plugins for use.
registerClientSubscribers ( Phergie\Irc\Client\React\ClientInterface $client )	Configures the client to emit events for specific types of messages.
registerPluginSubscribers ( array $plugins )	Registers event callbacks from plugins.
setDependencyOverrides ( array $config )	Sets dependencies from configuration.
validatePluginEvents ( Phergie\Irc\Bot\React\PluginInterface $plugin )	Validates a plugin's event callbacks.

Описание методов

Описание свойств