Elgg\Notifications\NotificationsQueue Class Reference

Database queue for notifications. More...

Inheritance diagram for Elgg\Notifications\NotificationsQueue:

Public Member Functions
	__construct (string $name, \Elgg\Database $db, \Elgg\Config $config)
	Create a queue. More...
	dequeue ()
	{Remove an item from the queue. Returns mixed } More...
Public Member Functions inherited from Elgg\Queue\DatabaseQueue
	__construct (protected string $name, protected \Elgg\Database $db)
	Create a queue. More...
	enqueue ($item)
	{Add an item to the queue. Parameters mixed $item Item to add to queue Returns bool } More...
	clear ()
	{Clear all items from the queue. Returns void } More...
	size ()
	{Get the size of the queue. Returns int } More...

Public Attributes
const	QUEUE_NAME = 'notifications'
Public Attributes inherited from Elgg\Queue\DatabaseQueue
const	TABLE_NAME = 'queue'

Protected Attributes
	$config
Protected Attributes inherited from Elgg\Queue\DatabaseQueue
	$workerId

Detailed Description

Database queue for notifications.

Definition at line 17 of file NotificationsQueue.php.

Constructor & Destructor Documentation

__construct()

Elgg\Notifications\NotificationsQueue::__construct	(	string	$name,
		\Elgg\Database	$db,
		\Elgg\Config	$config
	)

Create a queue.

Parameters

string	$name	Name of the queue. Must be less than 256 characters.
\Elgg\Database	$db	Database adapter
\Elgg\Config	$config	Global config

Definition at line 36 of file NotificationsQueue.php.

Member Function Documentation

dequeue()

Elgg\Notifications\NotificationsQueue::dequeue

(

)

{Remove an item from the queue.

Returns

mixed

}

Reimplemented from Elgg\Queue\DatabaseQueue.

Definition at line 45 of file NotificationsQueue.php.

Member Data Documentation

$config

Elgg\Notifications\NotificationsQueue::$config

protected

Definition at line 27 of file NotificationsQueue.php.

QUEUE_NAME

const Elgg\Notifications\NotificationsQueue::QUEUE_NAME = 'notifications'

Definition at line 22 of file NotificationsQueue.php.

---

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

• engine/classes/Elgg/Notifications/NotificationsQueue.php