Inheritance diagram for Elgg\Queue\DatabaseQueue:
Public Member Functions | ||||
| __construct ($name, \Elgg\Database $db) | ||||
| Create a queue. More... | ||||
| enqueue ($item) | ||||
{Add an item to the queue.
| ||||
| dequeue () | ||||
{Remove an item from the queue.
| ||||
| clear () | ||||
{Clear all items from the queue.
| ||||
| size () | ||||
{Get the size of the queue.
| ||||
Protected Attributes | |
| $name | |
| $db | |
| $workerId | |
Detailed Description
Definition at line 15 of file DatabaseQueue.php.
Constructor & Destructor Documentation
◆ __construct()
| Elgg\Queue\DatabaseQueue::__construct | ( | $name, | |
| \Elgg\Database | $db | ||
| ) |
Create a queue.
- Parameters
-
string $name Name of the queue. Must be less than 256 characters. \Elgg\Database $db Database adapter
Definition at line 32 of file DatabaseQueue.php.
Member Function Documentation
◆ clear()
| Elgg\Queue\DatabaseQueue::clear | ( | ) |
{Clear all items from the queue.
- Returns
- void
Implements Elgg\Queue\Queue.
Definition at line 84 of file DatabaseQueue.php.
◆ dequeue()
| Elgg\Queue\DatabaseQueue::dequeue | ( | ) |
{Remove an item from the queue.
- Returns
- mixed
Implements Elgg\Queue\Queue.
Definition at line 55 of file DatabaseQueue.php.
◆ enqueue()
| Elgg\Queue\DatabaseQueue::enqueue | ( | $item | ) |
{Add an item to the queue.
- Parameters
-
mixed $item Item to add to queue
- Returns
- bool
Implements Elgg\Queue\Queue.
Definition at line 41 of file DatabaseQueue.php.
◆ size()
| Elgg\Queue\DatabaseQueue::size | ( | ) |
{Get the size of the queue.
- Returns
- int
Implements Elgg\Queue\Queue.
Definition at line 94 of file DatabaseQueue.php.
Member Data Documentation
◆ $db
|
protected |
Definition at line 21 of file DatabaseQueue.php.
◆ $name
|
protected |
Definition at line 18 of file DatabaseQueue.php.
◆ $workerId
|
protected |
Definition at line 24 of file DatabaseQueue.php.
The documentation for this class was generated from the following file:
- engine/classes/Elgg/Queue/DatabaseQueue.php
