annotate vendor/symfony/console/Event/ConsoleCommandEvent.php @ 19:fa3358dc1485 tip

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