Elgg  Version master
Public Member Functions | List of all members
Elgg\Queue\Queue Interface Reference

Queue interface. More...

Inheritance diagram for Elgg\Queue\Queue:
Elgg\Queue\DatabaseQueue Elgg\Queue\MemoryQueue Elgg\Notifications\NotificationsQueue

Public Member Functions

 enqueue ($item)
 Add an item to the queue. More...
 
 dequeue ()
 Remove an item from the queue. More...
 
 clear ()
 Clear all items from the queue. More...
 
 size ()
 Get the size of the queue. More...
 

Detailed Description

Queue interface.

Definition at line 11 of file Queue.php.

Member Function Documentation

Elgg\Queue\Queue::clear ( )

Clear all items from the queue.

Returns
void

Implemented in Elgg\Queue\DatabaseQueue, and Elgg\Queue\MemoryQueue.

Elgg\Queue\Queue::dequeue ( )

Remove an item from the queue.

Returns
mixed

Implemented in Elgg\Queue\DatabaseQueue, Elgg\Notifications\NotificationsQueue, and Elgg\Queue\MemoryQueue.

Elgg\Queue\Queue::enqueue (   $item)

Add an item to the queue.

Parameters
mixed$itemItem to add to queue
Returns
bool

Implemented in Elgg\Queue\DatabaseQueue, and Elgg\Queue\MemoryQueue.

Elgg\Queue\Queue::size ( )

Get the size of the queue.

Returns
int

Implemented in Elgg\Queue\DatabaseQueue, and Elgg\Queue\MemoryQueue.


The documentation for this interface was generated from the following file: