ConsoleCommandEvent.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  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. class ConsoleCommandEvent extends ConsoleEvent
  17. {
  18. /**
  19. * The return code for skipped commands, this will also be passed into the terminate event.
  20. */
  21. const RETURN_CODE_DISABLED = 113;
  22. /**
  23. * Indicates if the command should be run or skipped.
  24. *
  25. * @var bool
  26. */
  27. private $commandShouldRun = true;
  28. /**
  29. * Disables the command, so it won't be run.
  30. *
  31. * @return bool
  32. */
  33. public function disableCommand()
  34. {
  35. return $this->commandShouldRun = false;
  36. }
  37. /**
  38. * Enables the command.
  39. *
  40. * @return bool
  41. */
  42. public function enableCommand()
  43. {
  44. return $this->commandShouldRun = true;
  45. }
  46. /**
  47. * Returns true if the command is runnable, false otherwise.
  48. *
  49. * @return bool
  50. */
  51. public function commandShouldRun()
  52. {
  53. return $this->commandShouldRun;
  54. }
  55. }