Elgg
Version 6.0
|
Interfaces with the database to perform operations on the delayed_email_queue table. More...
Public Member Functions | |
__construct (protected Database $db) | |
Create new service. More... | |
queueEmail (int $recipient_guid, string $delivery_interval, $item) | |
Insert a delayed email into the queue. More... | |
getRow (int $id) | |
Get a row from the queue. More... | |
getRecipientRows (int $recipient_guid, string $delivery_interval, int $timestamp=null, int $max_results=0) | |
Get all the rows in the queue for a given recipient. More... | |
getNextRecipientGUID (string $delivery_interval, int $timestamp=null) | |
Fetch the GUID of the next recipient to process. More... | |
deleteRow (int $id) | |
Remove a queue items from the database. More... | |
deleteRecipientRows (int $recipient_guid, string $delivery_interval, int $timestamp=null, int $max_id=0) | |
Delete all the queue items from the database for the given recipient and interval. More... | |
deleteAllRecipientRows (int $recipient_guid) | |
Deletes all the queue items from the database for the given recipient. More... | |
updateRecipientInterval (int $recipient_guid, string $delivery_interval) | |
Update the queued notifications for the recipient to a new delivery interval. More... | |
rowToRecord (\stdClass $row) | |
Convert a database row to a manageable object. More... | |
Public Attributes | |
const | TABLE_NAME = 'delayed_email_queue' |
Interfaces with the database to perform operations on the delayed_email_queue table.
Definition at line 15 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::__construct | ( | protected Database | $db | ) |
Create new service.
Database | $db | the database service |
Definition at line 29 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::deleteAllRecipientRows | ( | int | $recipient_guid | ) |
Deletes all the queue items from the database for the given recipient.
int | $recipient_guid | the recipient |
Definition at line 165 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::deleteRecipientRows | ( | int | $recipient_guid, |
string | $delivery_interval, | ||
int | $timestamp = null , |
||
int | $max_id = 0 |
||
) |
Delete all the queue items from the database for the given recipient and interval.
int | $recipient_guid | the recipient |
string | $delivery_interval | the interval for the recipient |
null | int | $timestamp | (optional) all queue items before time (default: now) |
int | $max_id | (optional) the max row ID to remove (this includes the given row ID) |
Definition at line 143 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::deleteRow | ( | int | $id | ) |
Remove a queue items from the database.
int | $id | the row to delete |
Definition at line 126 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::getNextRecipientGUID | ( | string | $delivery_interval, |
int | $timestamp = null |
||
) |
Fetch the GUID of the next recipient to process.
string | $delivery_interval | the delivery interval to get |
null | int | $timestamp | (optional) based on queue items before time (default: now) |
Definition at line 102 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::getRecipientRows | ( | int | $recipient_guid, |
string | $delivery_interval, | ||
int | $timestamp = null , |
||
int | $max_results = 0 |
||
) |
Get all the rows in the queue for a given recipient.
int | $recipient_guid | the recipient |
string | $delivery_interval | the interval for the recipient |
null | int | $timestamp | (optional) all queue items before time (default: now) |
int | $max_results | (optional) maximum number of rows to return |
Definition at line 78 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::getRow | ( | int | $id | ) |
Get a row from the queue.
int | $id | the ID to fetch |
Definition at line 60 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::queueEmail | ( | int | $recipient_guid, |
string | $delivery_interval, | ||
$item | |||
) |
Insert a delayed email into the queue.
int | $recipient_guid | the recipient of the email |
string | $delivery_interval | the desired interval of the recipient |
mixed | $item | the email to queue |
Definition at line 41 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::rowToRecord | ( | \stdClass | $row | ) |
Convert a database row to a manageable object.
\stdClass | $row | the database record |
Definition at line 195 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::updateRecipientInterval | ( | int | $recipient_guid, |
string | $delivery_interval | ||
) |
Update the queued notifications for the recipient to a new delivery interval.
int | $recipient_guid | the recipient |
string | $delivery_interval | the new delivery interval |
Definition at line 180 of file DelayedEmailQueueTable.php.
const Elgg\Database\DelayedEmailQueueTable::TABLE_NAME = 'delayed_email_queue' |
Definition at line 22 of file DelayedEmailQueueTable.php.