[Summary view] [Print] [Text view]

   1  <?php
   2  
   3  /*
   4   * This file is part of the Symfony package.
   5   *
   6   * (c) Fabien Potencier <fabien@symfony.com>
   7   *
   8   * For the full copyright and license information, please view the LICENSE
   9   * file that was distributed with this source code.
  10   */
  11  
  12  namespace Symfony\Component\Console\Event;
  13  
  14  /**
  15   * Allows to do things before the command is executed, like skipping the command or changing the input.
  16   *
  17   * @author Fabien Potencier <fabien@symfony.com>
  18   */
  19  class ConsoleCommandEvent extends ConsoleEvent
  20  {
  21      /**
  22       * The return code for skipped commands, this will also be passed into the terminate event.
  23       */
  24      const RETURN_CODE_DISABLED = 113;
  25  
  26      /**
  27       * Indicates if the command should be run or skipped.
  28       */
  29      private $commandShouldRun = true;
  30  
  31      /**
  32       * Disables the command, so it won't be run.
  33       *
  34       * @return bool
  35       */
  36      public function disableCommand()
  37      {
  38          return $this->commandShouldRun = false;
  39      }
  40  
  41      /**
  42       * Enables the command.
  43       *
  44       * @return bool
  45       */
  46      public function enableCommand()
  47      {
  48          return $this->commandShouldRun = true;
  49      }
  50  
  51      /**
  52       * Returns true if the command is runnable, false otherwise.
  53       *
  54       * @return bool
  55       */
  56      public function commandShouldRun()
  57      {
  58          return $this->commandShouldRun;
  59      }
  60  }