get( (string) $queue_handle )

Description

Gets a queue object corresponding to the queue_handle passed to it, that will include all the items already in the queue as part of its items property.

If no queue by that name exists, it will create one.

A queue is a collection of files in the modules/formulize/queue folder, which contain PHP code. Each file will be executed in sequence when the queue is processed.

Parameters

$queue_handle - a string used to identify the queue

Return Values

Returns an object representing the queue that was created.

Example

$queueHandler = xoops_getModuleHandler('queue', 'formulize');
$queue = $queueHandler->get('my-queue');