<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.5 |
+ | CiviCRM version 4.6 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
class CRM_Queue_Queue_Memory extends CRM_Queue_Queue {
/**
- * @var array(queueItemId => queueItemData)
+ * @var array
+ * array(queueItemId => queueItemData)
*/
- var $items;
+ public $items;
/**
- * @var array(
- queueItemId => releaseTime), expressed in seconds since epoch
+ * @var array
+ * array(queueItemId => releaseTime), expressed in seconds since epoch.
*/
- var $releaseTimes;
+ public $releaseTimes;
- var $nextQueueItemId = 1;
+ public $nextQueueItemId = 1;
/**
* Create a reference to queue. After constructing the queue, one should
* usually call createQueue (if it's a new queue) or loadQueue (if it's
* known to be an existing queue).
*
- * @param $queueSpec, array with keys:
- * - type: string, required, e.g. "interactive", "immediate", "stomp", "beanstalk"
+ * @param array $queueSpec
+ * Array with keys:
+ * - type: string, required, e.g. "interactive", "immediate", "stomp",
+ * "beanstalk"
* - name: string, required, e.g. "upgrade-tasks"
- * - reset: bool, optional; if a queue is found, then it should be flushed; default to TRUE
- * - (additional keys depending on the queue provider)
+ * - reset: bool, optional; if a queue is found, then it should be
+ * flushed; default to TRUE
+ * - (additional keys depending on the queue provider).
*/
- function __construct($queueSpec) {
+ public function __construct($queueSpec) {
parent::__construct($queueSpec);
}
/**
* Perform any registation or resource-allocation for a new queue
*/
- function createQueue() {
+ public function createQueue() {
$this->items = array();
$this->releaseTimes = array();
}
/**
* Perform any loading or pre-fetch for an existing queue.
*/
- function loadQueue() {
+ public function loadQueue() {
// $this->createQueue();
throw new Exception('Unsupported: CRM_Queue_Queue_Memory::loadQueue');
}
/**
* Release any resources claimed by the queue (memory, DB rows, etc)
*/
- function deleteQueue() {
+ public function deleteQueue() {
$this->items = NULL;
$this->releaseTimes = NULL;
}
*
* @return bool
*/
- function existsQueue() {
+ public function existsQueue() {
return is_array($this->items);
}
/**
* Add a new item to the queue
*
- * @param $data serializable PHP object or array
- * @param array|\queue $options queue-dependent options; for example, if this is a
- * priority-queue, then $options might specify the item's priority
- *
- * @return bool, TRUE on success
+ * @param mixed $data
+ * Serializable PHP object or array.
+ * @param array $options
+ * Queue-dependent options; for example, if this is a
+ * priority-queue, then $options might specify the item's priority.
*/
- function createItem($data, $options = array()) {
+ public function createItem($data, $options = array()) {
$id = $this->nextQueueItemId++;
// force copy, no unintendedsharing effects from pointers
$this->items[$id] = serialize($data);
*
* @return int
*/
- function numberOfItems() {
+ public function numberOfItems() {
return count($this->items);
}
/**
* Get and remove the next item
*
- * @param int|\seconds $leaseTime seconds
+ * @param int $leaseTime
+ * Seconds.
*
- * @return object with key 'data' that matches the inputted data
+ * @return object
+ * Includes key 'data' that matches the inputted data.
*/
- function claimItem($leaseTime = 3600) {
+ public function claimItem($leaseTime = 3600) {
// foreach hits the items in order -- but we short-circuit after the first
foreach ($this->items as $id => $data) {
$nowEpoch = CRM_Utils_Time::getTimeRaw();
if (empty($this->releaseTimes[$id]) || $this->releaseTimes[$id] < $nowEpoch) {
$this->releaseTimes[$id] = $nowEpoch + $leaseTime;
- $item = new stdClass();
- $item->id = $id;
+ $item = new stdClass();
+ $item->id = $id;
$item->data = unserialize($data);
return $item;
}
/**
* Get the next item
*
- * @param int|\seconds $leaseTime seconds
+ * @param int $leaseTime
+ * Seconds.
*
- * @return object with key 'data' that matches the inputted data
+ * @return object
+ * With key 'data' that matches the inputted data.
*/
- function stealItem($leaseTime = 3600) {
+ public function stealItem($leaseTime = 3600) {
// foreach hits the items in order -- but we short-circuit after the first
foreach ($this->items as $id => $data) {
$nowEpoch = CRM_Utils_Time::getTimeRaw();
$this->releaseTimes[$id] = $nowEpoch + $leaseTime;
- $item = new stdClass();
- $item->id = $id;
+ $item = new stdClass();
+ $item->id = $id;
$item->data = unserialize($data);
return $item;
}
/**
* Remove an item from the queue
*
- * @param $item object The item returned by claimItem
+ * @param object $item
+ * The item returned by claimItem.
*/
- function deleteItem($item) {
+ public function deleteItem($item) {
unset($this->items[$item->id]);
unset($this->releaseTimes[$item->id]);
}
/**
* Return an item that could not be processed
*
- * @param CRM_Core_DAO $item The item returned by claimItem
- *
- * @return bool
+ * @param CRM_Core_DAO $item
+ * The item returned by claimItem.
*/
- function releaseItem($item) {
+ public function releaseItem($item) {
unset($this->releaseTimes[$item->id]);
}
}
-
projects / civicrm-core.git / blobdiff