From b96fd06c999ff78587e9d0ee87303381b38abcdb Mon Sep 17 00:00:00 2001 From: Tim Otten Date: Fri, 29 Sep 2023 16:40:20 -0700 Subject: [PATCH] (NFC) Civi\Api4\Queue - Clarify quantity for claimItems/runItems --- Civi/Api4/Queue.php | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/Civi/Api4/Queue.php b/Civi/Api4/Queue.php index f504862457..1fe7aacdcc 100644 --- a/Civi/Api4/Queue.php +++ b/Civi/Api4/Queue.php @@ -40,10 +40,14 @@ class Queue extends \Civi\Api4\Generic\DAOEntity { } /** - * Claim an item from the queue. Returns zero or one items. + * Claim some items from the queue. Returns zero or more items. * * Note: This is appropriate for persistent, auto-run queues. * + * The number of items depends on the specific queue. Most notably, batch sizes are + * influenced by queue-driver support (`BatchQueueInterface`) and queue-configuration + * (`civicrm_queue.batch_limit`). + * * @param bool $checkPermissions * @return \Civi\Api4\Action\Queue\ClaimItems */ @@ -53,10 +57,14 @@ class Queue extends \Civi\Api4\Generic\DAOEntity { } /** - * Run an item from the queue. + * Run some items from the queue. * * Note: This is appropriate for persistent, auto-run queues. * + * The number of items depends on the specific queue. Most notably, batch sizes are + * influenced by queue-driver support (`BatchQueueInterface`) and queue-configuration + * (`civicrm_queue.batch_limit`). + * * @param bool $checkPermissions * @return \Civi\Api4\Action\Queue\RunItems */ -- 2.25.1