Interfaces with the database to perform operations on the delayed_email_queue table.
More...
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 |
( |
Database |
$db | ) |
|
Elgg\Database\DelayedEmailQueueTable::deleteAllRecipientRows |
( |
int |
$recipient_guid | ) |
|
Deletes all the queue items from the database for the given recipient.
- Parameters
-
int | $recipient_guid | the recipient |
- Returns
- int number of deleted rows
Definition at line 151 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::deleteRecipientRows |
( |
int |
$recipient_guid, |
|
|
string |
$delivery_interval, |
|
|
int |
$timestamp = null |
|
) |
| |
Delete all the queue items from the database for the given recipient and interval.
- Parameters
-
int | $recipient_guid | the recipient |
string | $delivery_interval | the interval for the recipient |
int | $timestamp | (optional) all queue items before time (default: now) |
- Returns
- int number of deleted rows
Definition at line 135 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::deleteRow |
( |
int |
$id | ) |
|
Elgg\Database\DelayedEmailQueueTable::getIntervalRows |
( |
string |
$delivery_interval, |
|
|
int |
$timestamp = null |
|
) |
| |
Get the queued items from the database for a given interval.
- Parameters
-
string | $delivery_interval | the delivery interval to get |
int | $timestamp | (optional) all queue items before time (default: now) |
- Returns
- DatabaseRecord[]
Definition at line 101 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::getRecipientRows |
( |
int |
$recipient_guid, |
|
|
string |
$delivery_interval, |
|
|
int |
$timestamp = null |
|
) |
| |
Get all the rows in the queue for a given recipient.
- Parameters
-
int | $recipient_guid | the recipient |
string | $delivery_interval | the interval for the recipient |
int | $timestamp | (optional) all queue items before time (default: now) |
- Returns
- DatabaseRecord[] database rows
Definition at line 83 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::getRow |
( |
int |
$id | ) |
|
Elgg\Database\DelayedEmailQueueTable::queueEmail |
( |
int |
$recipient_guid, |
|
|
string |
$delivery_interval, |
|
|
|
$item |
|
) |
| |
Insert a delayed email into the queue.
- Parameters
-
int | $recipient_guid | the recipient of the email |
string | $delivery_interval | the desired interval of the recipient |
mixed | $item | the email to queue |
- Returns
- bool
Definition at line 47 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::rowToRecord |
( |
\stdClass |
$row | ) |
|
Convert a database row to a managable object.
- Parameters
-
\stdClass | $row | the database record |
- Returns
- DatabaseRecord
Definition at line 181 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.
- Parameters
-
int | $recipient_guid | the recipient |
string | $delivery_interval | the new delivery interval |
- Returns
- bool
Definition at line 166 of file DelayedEmailQueueTable.php.
Elgg\Database\DelayedEmailQueueTable::$db |
|
protected |
const Elgg\Database\DelayedEmailQueueTable::TABLE_NAME = 'delayed_email_queue' |
The documentation for this class was generated from the following file: