minor #20278 [Scheduler] Add example about how to pass arguments to a Symfony command (W0rma)

javiereguiluz · javiereguiluz · commit 4a1d96d6841d · 2025-01-22T09:09:01.000+01:00
This PR was merged into the 6.4 branch. Discussion ---------- [Scheduler] Add example about how to pass arguments to a Symfony command We recently wanted to pass arguments to a Symfony command which is configured for the scheduler component with the `#[AsPeriodicTask]` attribute. The syntax mentioned in symfony/symfony#51525 (comment) worked. This PR adds an example to the docs. Commits ------- fc90d83 [Scheduler] Add example about how to pass arguments to a Symfony command
diff --git a/scheduler.rst b/scheduler.rst
@@ -473,6 +473,20 @@ The attribute takes more parameters to customize the trigger::
     // defines the timezone to use
     #[AsCronTask('0 0 * * *', timezone: 'Africa/Malabo')]
 
+Arguments/options for Symfony commands are passed as plain string::
+
+    use Symfony\Component\Console\Command\Command;
+
+    #[AsCronTask('0 0 * * *', arguments: 'arg --my-option')]
+    class MyCommand extends Command
+    {
+        protected function configure(): void
+        {
+            $this->addArgument('my-arg');
+            $this->addOption('my-option');
+        }
+    }
+
 .. versionadded:: 6.4
 
     The :class:`Symfony\\Component\\Scheduler\\Attribute\\AsCronTask` attribute
@@ -522,6 +536,20 @@ The ``#[AsPeriodicTask]`` attribute takes many parameters to customize the trigg
         }
     }
 
+Arguments/options for Symfony commands are passed as plain string::
+
+    use Symfony\Component\Console\Command\Command;
+
+    #[AsPeriodicTask(frequency: '1 day', arguments: 'arg --my-option')]
+    class MyCommand extends Command
+    {
+        protected function configure(): void
+        {
+            $this->addArgument('my-arg');
+            $this->addOption('my-option');
+        }
+    }
+
 .. versionadded:: 6.4
 
     The :class:`Symfony\\Component\\Scheduler\\Attribute\\AsPeriodicTask` attribute
