PHP Класс Phergie_Plugin_Remind, phergie

Автор: Phergie Development Team ([email protected])
Наследование: extends Phergie_Plugin_Abstract
Показать файл Открыть проект

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

Свойство Тип Описание
$db resource PDO resource for a SQLite database containing the reminders.
$keepListInMemory boolean Flag that indicates whether or not to use an in-memory reminder list.
$msgStorage In-memory store for pending reminders.
$onlyTargetedReminders boolean Respond *only* to targeted reminders or not.
$publicReminders Number of reminders to show in public.
$remindOnJoin boolean Send reminders when a user joins the channel or not.

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

Метод Описание
onCommandAsk ( string $recipient, string $message ) : void Handle reminder requests
onCommandRemind ( string $recipient, string $message ) : void Handle reminder requests
onCommandTell ( string $recipient, string $message ) : void Handle reminder requests
onJoin ( ) : void Handler for when a user joins a channel.
onLoad ( ) : void Check for dependencies.
onPrivmsg ( ) : void Intercepts a message and processes any contained recognized commands.

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

Метод Описание
createTables ( ) : void Creates the database table(s) (if they don't exist)
deleteMessage ( integer $rowid, string $channel, string $nick ) : void Deletes a delivered message
deliverReminders ( string $channel, string $nick ) : void Determines if the user has pending reminders, and if so, delivers them.
fetchMessages ( string $channel = null, string $recipient = null ) : array Get pending messages (for a specific channel/recipient)
handleDelivery ( ) : void Deliver reminders to a user.
handleRemind ( string $recipient, string $message ) : void Handles the tell/remind command (stores the message)
haveTable ( string $name ) : boolean Determines if a table exists
populateMemory ( ) : void Populates the in-memory cache of pending reminders

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

createTables() защищенный Метод

Creates the database table(s) (if they don't exist)
protected createTables ( ) : void
Результат void

deleteMessage() защищенный Метод

Deletes a delivered message
protected deleteMessage ( integer $rowid, string $channel, string $nick ) : void
$rowid integer ID of the message to delete
$channel string message's channel
$nick string message's recipient
Результат void

deliverReminders() защищенный Метод

Determines if the user has pending reminders, and if so, delivers them.
protected deliverReminders ( string $channel, string $nick ) : void
$channel string channel to check
$nick string nick to check
Результат void

fetchMessages() защищенный Метод

Get pending messages (for a specific channel/recipient)
protected fetchMessages ( string $channel = null, string $recipient = null ) : array
$channel string channel on which to check for pending messages
$recipient string user for which to check pending messages
Результат array of records

handleDelivery() защищенный Метод

Deliver reminders to a user.
protected handleDelivery ( ) : void
Результат void

handleRemind() защищенный Метод

Handles the tell/remind command (stores the message)
protected handleRemind ( string $recipient, string $message ) : void
$recipient string name of the recipient
$message string message to store
Результат void

haveTable() защищенный Метод

Determines if a table exists
protected haveTable ( string $name ) : boolean
$name string Table name
Результат boolean

onCommandAsk() публичный Метод

Handle reminder requests
См. также: handleRemind()
public onCommandAsk ( string $recipient, string $message ) : void
$recipient string recipient of the message
$message string message to tell the recipient
Результат void

onCommandRemind() публичный Метод

Handle reminder requests
См. также: handleRemind()
public onCommandRemind ( string $recipient, string $message ) : void
$recipient string recipient of the message
$message string message to tell the recipient
Результат void

onCommandTell() публичный Метод

Handle reminder requests
См. также: handleRemind()
public onCommandTell ( string $recipient, string $message ) : void
$recipient string recipient of the message
$message string message to tell the recipient
Результат void

onJoin() публичный Метод

Handler for when a user joins a channel.
public onJoin ( ) : void
Результат void

onLoad() публичный Метод

Check for dependencies.
public onLoad ( ) : void
Результат void

onPrivmsg() публичный Метод

Intercepts a message and processes any contained recognized commands.
public onPrivmsg ( ) : void
Результат void

populateMemory() защищенный Метод

Populates the in-memory cache of pending reminders
protected populateMemory ( ) : void
Результат void

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

$db защищенное свойство

PDO resource for a SQLite database containing the reminders.
protected resource $db
Результат resource

$keepListInMemory защищенное свойство

Flag that indicates whether or not to use an in-memory reminder list.
protected bool $keepListInMemory
Результат boolean

$msgStorage защищенное свойство

In-memory store for pending reminders.
protected $msgStorage

$onlyTargetedReminders защищенное свойство

Respond *only* to targeted reminders or not.
protected bool $onlyTargetedReminders
Результат boolean

$publicReminders защищенное свойство

Number of reminders to show in public.
protected $publicReminders

$remindOnJoin защищенное свойство

Send reminders when a user joins the channel or not.
protected bool $remindOnJoin
Результат boolean