[TASK] Deprecate Extbase CommandControllers and @cli annotation
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Mvc / Exception / AmbiguousCommandIdentifierException.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Mvc\Exception;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * An "Ambiguous command identifier" exception
19 *
20 * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
21 * @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0. Use symfony/console commands instead.
22 */
23 class AmbiguousCommandIdentifierException extends \TYPO3\CMS\Extbase\Mvc\Exception\CommandException
24 {
25 /**
26 * @var array<\TYPO3\CMS\Extbase\Mvc\Cli\Command>
27 */
28 protected $matchingCommands = [];
29
30 /**
31 * Overwrites parent constructor to be able to inject matching commands.
32 *
33 * @param string $message
34 * @param int $code
35 * @param \Exception|null $previousException
36 * @param array $matchingCommands <\TYPO3\CMS\Extbase\Mvc\Cli\Command> $matchingCommands Commands that matched the command identifier
37 * @see Exception
38 */
39 public function __construct($message = '', $code = 0, \Exception $previousException = null, array $matchingCommands)
40 {
41 $this->matchingCommands = $matchingCommands;
42 parent::__construct($message, $code, $previousException);
43 }
44
45 /**
46 * @return array<\TYPO3\CMS\Extbase\Mvc\Cli\Command>
47 */
48 public function getMatchingCommands()
49 {
50 return $this->matchingCommands;
51 }
52 }