X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=CRM%2FQueue%2FQueue.php;h=c60897b0c94f89d1fdb2c614ae2b093b79680654;hb=1e94e997c66872d420b31d5adc2226db82f448b9;hp=0fe31594a6d242b8bccec901e847b72bb86752d2;hpb=a6c01b45f0cdaee8677de72b8bf3e784d8b6b62a;p=civicrm-core.git diff --git a/CRM/Queue/Queue.php b/CRM/Queue/Queue.php index 0fe31594a6..c60897b0c9 100644 --- a/CRM/Queue/Queue.php +++ b/CRM/Queue/Queue.php @@ -23,7 +23,7 @@ | GNU Affero General Public License or the licensing of CiviCRM, | | see the CiviCRM license FAQ at http://civicrm.org/licensing | +--------------------------------------------------------------------+ -*/ + */ /** * A queue is an object (usually backed by some persistent data store) @@ -60,7 +60,7 @@ abstract class CRM_Queue_Queue { } /** - * Determine the string name of this queue + * Determine the string name of this queue. * * @return string */ @@ -84,14 +84,14 @@ abstract class CRM_Queue_Queue { public abstract function deleteQueue(); /** - * Check if the queue exists + * Check if the queue exists. * * @return bool */ public abstract function existsQueue(); /** - * Add a new item to the queue + * Add a new item to the queue. * * @param mixed $data * Serializable PHP object or array. @@ -102,14 +102,14 @@ abstract class CRM_Queue_Queue { public abstract function createItem($data, $options = array()); /** - * Determine number of items remaining in the queue + * Determine number of items remaining in the queue. * * @return int */ public abstract function numberOfItems(); /** - * Get the next item + * Get the next item. * * @param int $lease_time * Seconds. @@ -131,7 +131,7 @@ abstract class CRM_Queue_Queue { public abstract function stealItem($lease_time = 3600); /** - * Remove an item from the queue + * Remove an item from the queue. * * @param object $item * The item returned by claimItem. @@ -139,10 +139,11 @@ abstract class CRM_Queue_Queue { public abstract function deleteItem($item); /** - * Return an item that could not be processed + * Return an item that could not be processed. * * @param object $item * The item returned by claimItem. */ public abstract function releaseItem($item); + }