ConsoleCommandEvent.php 1.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  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. */
  25. private $commandShouldRun = true;
  26. /**
  27. * Disables the command, so it won't be run.
  28. */
  29. public function disableCommand(): bool
  30. {
  31. return $this->commandShouldRun = false;
  32. }
  33. public function enableCommand(): bool
  34. {
  35. return $this->commandShouldRun = true;
  36. }
  37. /**
  38. * Returns true if the command is runnable, false otherwise.
  39. */
  40. public function commandShouldRun(): bool
  41. {
  42. return $this->commandShouldRun;
  43. }
  44. }