Docs: fix SymfonyConsoleJob command parameters

orisai · May 25, 2024 · a947f25 · a947f25
1 parent 9105939
commit a947f25
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -603,8 +603,9 @@ Command can be parametrized:
 ```php
 $job->setCommandParameters([
 	'argument' => 'value',
-	'--option' => 'value',
-	'--boolean-option' => true,
+	'--value-option' => 'value',
+	'--no-value-option' => null,
+	'--array-value-option' => ['value1', 'value2'],
 ]);
 ```
 

diff --git a/tests/Doubles/TestParametrizedCommand.php b/tests/Doubles/TestParametrizedCommand.php
@@ -15,8 +15,9 @@ protected function configure(): void
 	{
 		$this->setName('test:parameters');
 		$this->addArgument('argument', InputArgument::REQUIRED);
-		$this->addOption('option', null, InputOption::VALUE_REQUIRED);
-		$this->addOption('bool-option', null, InputOption::VALUE_NONE);
+		$this->addOption('value-option', null, InputOption::VALUE_REQUIRED);
+		$this->addOption('no-value-option', null, InputOption::VALUE_NONE);
+		$this->addOption('array-value-option', null, InputOption::VALUE_IS_ARRAY | InputOption::VALUE_REQUIRED);
 	}
 
 	protected function execute(InputInterface $input, OutputInterface $output): int

diff --git a/tests/Unit/Job/SymfonyConsoleJobTest.php b/tests/Unit/Job/SymfonyConsoleJobTest.php
@@ -151,13 +151,15 @@ public function testCommandParameters(): void
 		$application->add($command);
 		$job = new SymfonyConsoleJob($command, $application);
 		$job->setCommandParameters([
-			'argument' => 'a',
-			'--option' => 'b',
-			'--bool-option' => true,
+			'argument' => 'value',
+			'--value-option' => 'value',
+			'--no-value-option' => null,
+			'--array-value-option' => ['value1', 'value2'],
 		]);
 
 		self::assertStringMatchesFormat(
-			'symfony/console: %ctest:parameters%c a --option=b --bool-option=1',
+			'symfony/console: %ctest:parameters%c'
+			. ' value --value-option=value --no-value-option --array-value-option=value1 --array-value-option=value2',
 			$job->getName(),
 		);