ConsoleCommandEvent.php 1.3KB

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