In Drupal 9.4, the Queue API has been enhanced to support batch processing. This allows developers to efficiently process a large number of queued items in smaller batches, improving performance and resource utilization. In this blog post, we’ll explore how to implement a Queue Worker with batch processing in Drupal 9.4 using a practical example.<\/p>\n
Before we dive into the implementation, let’s set up a basic module called “customqueue” that will contain our queue worker and batch processing code.<\/p>\n
modules\/custom<\/code> directory of your Drupal installation.<\/li>\n- Inside the customqueue directory, create a new file called customqueue
.info.yml<\/code> with the following contents:<\/li>\n<\/ol>\nCODE:<\/p>\n
\nname: 'customqueue'\r\n\r\ntype: module\r\n\r\ndescription: 'Example module for Queue Worker with Batch Processing'\r\n\r\ncore_version_requirement: ^9 || ^10\r\n\r\npackage: Custom\r\n\r\ndependencies:\r\n\r\n- php: ^7.3<\/pre>\n<\/div>\n\n\n- Create another file called customqueue.services.yml with the following contents:<\/li>\n<\/ol>\n\n
services:\r\ncustomqueue.queue_worker:\r\nclass: Drupal\\customqueue\\QueueWorker\\MyCustomQueue\r\narguments: ['@entity_type.manager']\r\ntags:\r\n- { name: queue_worker }<\/pre>\n<\/div>\n<\/div>\n\n\n- Create the necessary directory structure and an empty file for the queue worker class:<\/li>\n<\/ol>\n
\n- Create a directory called
src<\/code> inside the customqueue\u00a0directory.<\/li>\n- Inside the
src<\/code> directory, create a directory called QueueWorker<\/code>.<\/li>\n- Inside the
QueueWorker<\/code> directory, create a file called MyCustomQueue.php<\/li>\n<\/ul>\n<\/div>\n\nImplementing the Queue Worker<\/h2>\n
Now that we have our module set up, let’s implement the Queue Worker class.<\/p>\n
Open the MyCustomQueue.php file and add the following code:<\/p>\n
\n<?php\r\n\r\nnamespace Drupal\\customqueue\\QueueWorker;\r\n\r\nuse Drupal\\Core\\Entity\\EntityTypeManagerInterface;\r\nuse Drupal\\Core\\Queue\\QueueWorkerBase;\r\n\r\n\/**\r\n* Processes queued items using batch processing.\r\n*\r\n* @QueueWorker(\r\n* id = \"customqueue_queue_worker\",\r\n* title = @Translation(\"customqueue Queue Worker\"),\r\n* cron = {\"time\" = 60}\r\n* )\r\n*\/\r\nclass MyCustomQueue extends QueueWorkerBase {\r\n\r\n\/**\r\n* The entity type manager.\r\n*\r\n* @var \\Drupal\\Core\\Entity\\EntityTypeManagerInterface\r\n*\/\r\nprotected $entityTypeManager;\r\n\r\n\/**\r\n* Constructs a new MyCustomQueue object.\r\n*\r\n* @param \\Drupal\\Core\\Entity\\EntityTypeManagerInterface $entity_type_manager\r\n* The entity type manager.\r\n*\/\r\npublic function __construct(EntityTypeManagerInterface $entity_type_manager) {\r\n$this->entityTypeManager = $entity_type_manager;\r\n}\r\n\r\n\/**\r\n* {@inheritdoc}\r\n*\/\r\npublic function processItem($data) {\r\n\/\/ Implement your custom processing logic here.\r\n\/\/ This method will be called for each item in the queue.\r\n\r\n\/\/ Example: Updating an entity field value.\r\n$entity = $this->entityTypeManager->getStorage('node')->load($data['nid']);\r\n$entity->set('field_status', 'processed');\r\n$entity->save();\r\n}\r\n\r\n}<\/pre>\n<\/div>\nIn this example, we have defined a Queue Worker class called MyCustomQueue. The class extends the QueueWorkerBase<\/code> class provided by Drupal core.<\/p>\nThe @QueueWorker<\/code> annotation is used to define the queue worker ID, title, and cron timing. Make sure to update the id<\/code> and title<\/code> values as per your requirements.<\/p>\nThe processItem()<\/code> method is called for each item in the queue. Inside this method, you can implement your custom processing logic. In this example, we load a node entity based on the provided nid<\/code> and update a field value (field_status<\/code> in this case).<\/p>\nImplementing Batch Processing<\/h2>\n
To add batch processing to our queue worker, we need to modify the processItem()<\/code> method to utilize Drupal’s Batch API. The Batch API allows us to process items in smaller batches, reducing the strain on server resources.<\/p>\nUpdate the processItem()<\/code> method in the MyCustomQueue\u00a0class as follows:<\/p>\n\n\n\/**\r\n* {@inheritdoc}\r\n*\/\r\npublic function processItem($data) {\r\n\/\/ Implement your custom processing logic here.\r\n\/\/ This method will be called for each item in the queue.\r\n\r\n\/\/ Example: Updating an entity field value.\r\n$entity = $this->entityTypeManager->getStorage('node')->load($data['nid']);\r\n$entity->set('field_status', 'processed');\r\n$entity->save();\r\n\r\n\/\/ Batch processing.\r\n$batch = [\r\n'operations' => [\r\n[[get_class($this), 'processItem'], [$data]],\r\n],\r\n'finished' => [get_class($this), 'finishedCallback'],\r\n'title' => t('Processing queue items...'),\r\n'init_message' => t('Starting processing...'),\r\n'progress_message' => t('Processed @current out of @total.'),\r\n];\r\n\r\nbatch_set($batch);\r\n}\r\n\r\n\/**\r\n* Batch processing finished callback.\r\n*\/\r\npublic static function finishedCallback($success, $results, $operations) {\r\nif ($success) {\r\n\/\/ Batch processing completed successfully.\r\n\/\/ Perform any additional actions here.\r\n}\r\nelse {\r\n\/\/ Batch processing failed.\r\n\/\/ Log or handle errors here.\r\n}\r\n}<\/pre>\n<\/div>\n<\/div>\n<\/div>\n\nIn this updated code, we have added the necessary code for batch processing:<\/p>\n
\n- After updating the entity field value, we define a $batch array that contains information about the batch process.<\/li>\n
- The operations key holds an array of operations to be executed in each batch. In our case, we include the processItem() method itself as the operation and pass the $data parameter to it.<\/li>\n
- The finished key specifies the callback method to be called when the batch processing is finished. We have defined a finished Callback() method that handles any post-processing actions.<\/li>\n
- The title, init_message, and progress_message keys define the messages displayed during the batch processing.<\/li>\n<\/ul>\n
Finally, we call batch_set() and pass the $batch array to initiate the batch processing.<\/p>\n
Conclusion:<\/strong><\/p>\nBy utilizing the Queue API and Batch API, you can improve performance and resource utilization when working with large datasets or time-consuming tasks in Drupal. It provides a scalable and efficient way to handle background processing.<\/p>\n
Let us know in case of any queries , please feel free to reach out via comments.<\/p>\n<\/div>\n
<\/div>","protected":false},"excerpt":{"rendered":"In Drupal 9.4, the Queue API has been enhanced to support batch processing. This allows developers to efficiently process a large number of queued items in smaller batches, improving performance and resource utilization. In this blog post, we’ll explore how to implement a Queue Worker with batch processing in Drupal 9.4 using a practical example. […]<\/p>\n","protected":false},"author":1513,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":385},"categories":[3602],"tags":[5245,4862,5152,5246],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57485"}],"collection":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/users\/1513"}],"replies":[{"embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/comments?post=57485"}],"version-history":[{"count":5,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57485\/revisions"}],"predecessor-version":[{"id":57515,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/posts\/57485\/revisions\/57515"}],"wp:attachment":[{"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/media?parent=57485"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/categories?post=57485"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.tothenew.com\/blog\/wp-json\/wp\/v2\/tags?post=57485"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}