LazyCommand.php 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. <?php
  2. /*
  3. * This file is part of the Symfony package.
  4. *
  5. * (c) Fabien Potencier <fabien@symfony.com>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Symfony\Component\Console\Command;
  11. use Symfony\Component\Console\Application;
  12. use Symfony\Component\Console\Completion\CompletionInput;
  13. use Symfony\Component\Console\Completion\CompletionSuggestions;
  14. use Symfony\Component\Console\Helper\HelperSet;
  15. use Symfony\Component\Console\Input\InputDefinition;
  16. use Symfony\Component\Console\Input\InputInterface;
  17. use Symfony\Component\Console\Output\OutputInterface;
  18. /**
  19. * @author Nicolas Grekas <p@tchwork.com>
  20. */
  21. final class LazyCommand extends Command
  22. {
  23. private $command;
  24. private ?bool $isEnabled;
  25. public function __construct(string $name, array $aliases, string $description, bool $isHidden, \Closure $commandFactory, ?bool $isEnabled = true)
  26. {
  27. $this->setName($name)
  28. ->setAliases($aliases)
  29. ->setHidden($isHidden)
  30. ->setDescription($description);
  31. $this->command = $commandFactory;
  32. $this->isEnabled = $isEnabled;
  33. }
  34. public function ignoreValidationErrors(): void
  35. {
  36. $this->getCommand()->ignoreValidationErrors();
  37. }
  38. public function setApplication(Application $application = null): void
  39. {
  40. if ($this->command instanceof parent) {
  41. $this->command->setApplication($application);
  42. }
  43. parent::setApplication($application);
  44. }
  45. public function setHelperSet(HelperSet $helperSet): void
  46. {
  47. if ($this->command instanceof parent) {
  48. $this->command->setHelperSet($helperSet);
  49. }
  50. parent::setHelperSet($helperSet);
  51. }
  52. public function isEnabled(): bool
  53. {
  54. return $this->isEnabled ?? $this->getCommand()->isEnabled();
  55. }
  56. public function run(InputInterface $input, OutputInterface $output): int
  57. {
  58. return $this->getCommand()->run($input, $output);
  59. }
  60. public function complete(CompletionInput $input, CompletionSuggestions $suggestions): void
  61. {
  62. $this->getCommand()->complete($input, $suggestions);
  63. }
  64. public function setCode(callable $code): static
  65. {
  66. $this->getCommand()->setCode($code);
  67. return $this;
  68. }
  69. /**
  70. * @internal
  71. */
  72. public function mergeApplicationDefinition(bool $mergeArgs = true): void
  73. {
  74. $this->getCommand()->mergeApplicationDefinition($mergeArgs);
  75. }
  76. public function setDefinition(array|InputDefinition $definition): static
  77. {
  78. $this->getCommand()->setDefinition($definition);
  79. return $this;
  80. }
  81. public function getDefinition(): InputDefinition
  82. {
  83. return $this->getCommand()->getDefinition();
  84. }
  85. public function getNativeDefinition(): InputDefinition
  86. {
  87. return $this->getCommand()->getNativeDefinition();
  88. }
  89. public function addArgument(string $name, int $mode = null, string $description = '', mixed $default = null): static
  90. {
  91. $this->getCommand()->addArgument($name, $mode, $description, $default);
  92. return $this;
  93. }
  94. public function addOption(string $name, string|array $shortcut = null, int $mode = null, string $description = '', mixed $default = null): static
  95. {
  96. $this->getCommand()->addOption($name, $shortcut, $mode, $description, $default);
  97. return $this;
  98. }
  99. public function setProcessTitle(string $title): static
  100. {
  101. $this->getCommand()->setProcessTitle($title);
  102. return $this;
  103. }
  104. public function setHelp(string $help): static
  105. {
  106. $this->getCommand()->setHelp($help);
  107. return $this;
  108. }
  109. public function getHelp(): string
  110. {
  111. return $this->getCommand()->getHelp();
  112. }
  113. public function getProcessedHelp(): string
  114. {
  115. return $this->getCommand()->getProcessedHelp();
  116. }
  117. public function getSynopsis(bool $short = false): string
  118. {
  119. return $this->getCommand()->getSynopsis($short);
  120. }
  121. public function addUsage(string $usage): static
  122. {
  123. $this->getCommand()->addUsage($usage);
  124. return $this;
  125. }
  126. public function getUsages(): array
  127. {
  128. return $this->getCommand()->getUsages();
  129. }
  130. public function getHelper(string $name): mixed
  131. {
  132. return $this->getCommand()->getHelper($name);
  133. }
  134. public function getCommand(): parent
  135. {
  136. if (!$this->command instanceof \Closure) {
  137. return $this->command;
  138. }
  139. $command = $this->command = ($this->command)();
  140. $command->setApplication($this->getApplication());
  141. if (null !== $this->getHelperSet()) {
  142. $command->setHelperSet($this->getHelperSet());
  143. }
  144. $command->setName($this->getName())
  145. ->setAliases($this->getAliases())
  146. ->setHidden($this->isHidden())
  147. ->setDescription($this->getDescription());
  148. // Will throw if the command is not correctly initialized.
  149. $command->getDefinition();
  150. return $command;
  151. }
  152. }