vendor/shopware/core/Framework/MessageQueue/ScheduledTask/Api/ScheduledTaskController.php line 52

Open in your IDE?
  1. <?php declare(strict_types=1);
  3. namespace Shopware\Core\Framework\MessageQueue\ScheduledTask\Api;
  5. use OpenApi\Annotations as OA;
  6. use Shopware\Core\Framework\MessageQueue\ScheduledTask\Scheduler\TaskScheduler;
  7. use Shopware\Core\Framework\Routing\Annotation\RouteScope;
  8. use Shopware\Core\Framework\Routing\Annotation\Since;
  9. use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
  10. use Symfony\Component\HttpFoundation\JsonResponse;
  11. use Symfony\Component\Routing\Annotation\Route;
  13. /**
  14.  * @Route(defaults={"_routeScope"={"api"}})
  15.  */
  16. class ScheduledTaskController extends AbstractController
  17. {
  18.     /**
  19.      * @var TaskScheduler
  20.      */
  21.     private $taskScheduler;
  23.     public function __construct(TaskScheduler $taskScheduler)
  24.     {
  25.         $this->taskScheduler = $taskScheduler;
  26.     }
  28.     /**
  29.      * @Since("6.0.0.0")
  30.      * @OA\Post(
  31.      *     path="/_action/scheduled-task/run",
  32.      *     summary="Run scheduled tasks.",
  33.      *     description="Starts the scheduled task worker to handle the next scheduled tasks.",
  34.      *     operationId="runScheduledTasks",
  35.      *     tags={"Admin API", "System Operations"},
  36.      *     @OA\Response(
  37.      *         response="200",
  38.      *         description="Returns a success message indicating a successful run.",
  39.      *         @OA\JsonContent(
  40.      *               @OA\Property(
  41.      *                  property="message",
  42.      *                  description="Success message",
  43.      *                  type="string"
  44.      *              )
  45.      *         )
  46.      *     )
  47.      * )
  48.      * @Route("/api/_action/scheduled-task/run", name="api.action.scheduled-task.run", methods={"POST"})
  49.      */
  50.     public function runScheduledTasks(): JsonResponse
  51.     {
  52.         $this->taskScheduler->queueScheduledTasks();
  54.         return $this->json(['message' => 'Success']);
  55.     }
  57.     /**
  58.      * @Since("6.0.0.0")
  59.      * @OA\Get(
  60.      *     path="/_action/scheduled-task/min-run-interval",
  61.      *     summary="Get the minimum schedules task interval",
  62.      *     description="Fetches the smallest interval that a scheduled task uses.",
  63.      *     operationId="getMinRunInterval",
  64.      *     tags={"Admin API", "System Operations"},
  65.      *     @OA\Response(
  66.      *         response="200",
  67.      *         description="Returns the minimum interval.",
  68.      *         @OA\JsonContent(
  69.      *               @OA\Property(
  70.      *                  property="minRunInterval",
  71.      *                  description="Minimal interval in seconds.",
  72.      *                  type="string"
  73.      *              )
  74.      *         )
  75.      *     )
  76.      * )
  77.      * @Route("/api/_action/scheduled-task/min-run-interval", name="api.action.scheduled-task.min-run-interval", methods={"GET"})
  78.      */
  79.     public function getMinRunInterval(): JsonResponse
  80.     {
  81.         return $this->json(['minRunInterval' => $this->taskScheduler->getMinRunInterval()]);
  82.     }
  83. }