process( (object|string) $queue_or_queue_handle )

Description

Triggers the processing of the items in the specified queue. If the exec function is available in PHP, then the queue will be processed asynchronously, otherwise, the queue will be processed for approximately 60 seconds as part of the current http request. Once PHP has executed a file in the queue, the file is deleted.

Queue processing can be triggered by the Public API.

If the queue is processed asynchronously, certain PHP environment constraints may timeout the processing after many minutes, depending on your server configuration. If this is a problem, you should work with your server admin to remove or extend the timeout limits.

If the queue processing times out, triggering the processing of the queue again will pick up where the previous process left off. It is possible that the last item from the timed out processing will be processed again when the queue resumes.

Parameters

$queue_or_queue_handle - a queue object, or a string used to identify the queue

Return Values

Returns true if asynchronous queue processing was triggered. Returns an array of the filenames that were processed, if the queue was triggered synchronously as part of the http request.

Examples

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