PHP Класс Phergie_Plugin_Lart, phergie

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

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

Свойство Тип Описание
$db PDO PDO instance for the database
$delete PDOStatement Prepared statement for deleting the definition for a given term
$process PDOStatement Prepared statement for searching for a definition for which the term matches as a regular expression against a given search string
$save PDOStatement Prepared statement for inserting a new definition
$select PDOStatement Prepared statement for searching for a definition by its exact term

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

Метод Описание
onAction ( ) : void Processes definition triggers in CTCP actions.
onCommandAddlart ( string $term, string $definition ) : void Creates a new definition.
onCommandDeletelart ( string $term ) : void Removes an existing definition.
onCommandLartinfo ( string $term ) : void Returns information about a definition.
onLoad ( ) : void Checks for dependencies and initializes the database.
onPrivmsg ( ) : void Processes definition triggers in messages.

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

Метод Описание
deleteLart ( string $term ) : boolean Deletes a given definition.
getLart ( string $term ) : mixed Retrieves the definition for a given term if it exists.
processLart ( ) : void Processes definition triggers in the text of the current event.
saveLart ( string $term, string $definition ) : boolean Saves a given definition.

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

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

Deletes a given definition.
protected deleteLart ( string $term ) : boolean
$term string Term for which the definition should be deleted
Результат boolean TRUE if the definition was found and deleted, FALSE otherwise

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

Retrieves the definition for a given term if it exists.
protected getLart ( string $term ) : mixed
$term string Term to search for
Результат mixed String containing the definition or FALSE if no definition exists

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

Processes definition triggers in CTCP actions.
public onAction ( ) : void
Результат void

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

Creates a new definition.
public onCommandAddlart ( string $term, string $definition ) : void
$term string Term to add
$definition string Definition to add
Результат void

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

Removes an existing definition.
public onCommandDeletelart ( string $term ) : void
$term string Term for which the definition should be removed
Результат void

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

Returns information about a definition.
public onCommandLartinfo ( string $term ) : void
$term string Term about which to return information
Результат void

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

Checks for dependencies and initializes the database.
public onLoad ( ) : void
Результат void

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

Processes definition triggers in messages.
public onPrivmsg ( ) : void
Результат void

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

Processes definition triggers in the text of the current event.
protected processLart ( ) : void
Результат void

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

Saves a given definition.
protected saveLart ( string $term, string $definition ) : boolean
$term string Term to trigger a response containing the corresponding definition, may be a regular expression
$definition string Definition corresponding to the term
Результат boolean TRUE if the definition was saved successfully, FALSE otherwise

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

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

PDO instance for the database
protected PDO $db
Результат PDO

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

Prepared statement for deleting the definition for a given term
protected PDOStatement $delete
Результат PDOStatement

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

Prepared statement for searching for a definition for which the term matches as a regular expression against a given search string
protected PDOStatement $process
Результат PDOStatement

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

Prepared statement for inserting a new definition
protected PDOStatement $save
Результат PDOStatement

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

Prepared statement for searching for a definition by its exact term
protected PDOStatement $select
Результат PDOStatement