ConsoleCommandEvent.php 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  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\Event;
  11. /**
  12. * Allows to do things before the command is executed, like skipping the command or changing the input.
  13. *
  14. * @author Fabien Potencier <fabien@symfony.com>
  15. */
  16. final class ConsoleCommandEvent extends ConsoleEvent
  17. {
  18. /**
  19. * The return code for skipped commands, this will also be passed into the terminate event.
  20. */
  21. public const RETURN_CODE_DISABLED = 113;
  22. /**
  23. * Indicates if the command should be run or skipped.
  24. * @var bool
  25. */
  26. private $commandShouldRun = true;
  27. /**
  28. * Disables the command, so it won't be run.
  29. */
  30. public function disableCommand()
  31. {
  32. return $this->commandShouldRun = false;
  33. }
  34. public function enableCommand()
  35. {
  36. return $this->commandShouldRun = true;
  37. }
  38. /**
  39. * Returns true if the command is runnable, false otherwise.
  40. */
  41. public function commandShouldRun()
  42. {
  43. return $this->commandShouldRun;
  44. }
  45. }