Drupal Answers is a question and answer site for Drupal developers and administrators. It only takes a minute to sign up.
Sign up to join this community
Can someone please help me with an example on how to create a QueueWorker class, add items, and run it inside hook_ENTITY_TYPE_presave() or anywhere in a module file?
Basically, what I want is adding an item to the queue and run it soon after a node save, without waiting until the next cron runs.
What you probably want is a different kind of queue worker. See https://mglaman.dev/blog/flush-and-run-using-kernelterminate-improve-page-speed-performance
A simple example:
/src/EventSubscriber/TaskOnTerminateSubscriber.php
<?php
namespace Drupal\mymodule\EventSubscriber;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\TerminateEvent;
use Symfony\Component\HttpKernel\KernelEvents;
/**
* A subscriber running a task by request
*/
class TaskOnTerminateSubscriber implements EventSubscriberInterface {
/**
* TRUE if a task run is requested.
*
* @var bool
*/
protected $runTask = FALSE;
/**
* Request a task run
*/
public function runTask() {
$this->runTask = TRUE;
}
/**
* Run task if requested.
*
* @param \Symfony\Component\HttpKernel\Event\TerminateEvent $event
* The Event to process.
*/
public function onTerminate(TerminateEvent $event) {
if ($this->runTask) {
// replace this with your long-running task
sleep(10);
}
}
/**
* {@inheritdoc}
*/
public static function getSubscribedEvents() {
return [KernelEvents::TERMINATE => [['onTerminate', 150]]];
}
}
mymodule.services.yml
services:
mymodule.task_on_terminate_subscriber:
class: Drupal\mymodule\EventSubscriber\TaskOnTerminateSubscriber
tags:
- { name: event_subscriber }
Trigger the task in hook_ENTITY_TYPE_presave/insert/update:
\Drupal::service('mymodule.task_on_terminate_subscriber')->runTask();
runTask() could contain arguments, like the entity ID. You can also make the service store multiple tasks in an array class property, which would then be a queue stored in memory processed right after the response is flushed to the client.
hook_ENTITY_TYPE_insert(), which runs after successful node save.hook_ENTITY_TYPE_presave()is run before save and will be run even if the save fails.hook_ENTITY_TYPE_insert()Cron::processQueues()hook_ENTITY_TYPE_presave()which require me to save a node from one content type when updating another content type node. When I try to save the other node inside thehook_ENTITY_TYPE_presave()with$other_entity->save()it simply doesn't save it. That's when I thought maybe queueing it and claiming the queue would be the best thing to do.