ConsoleCommandEvent.php 1.3 KB

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