comparison vendor/symfony/console/Event/ConsoleCommandEvent.php @ 0:4c8ae668cc8c

Initial import (non-working)
author Chris Cannam
date Wed, 29 Nov 2017 16:09:58 +0000
parents
children 1fec387a4317
comparison
equal deleted inserted replaced
-1:000000000000 0:4c8ae668cc8c
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 * @var bool
30 */
31 private $commandShouldRun = true;
32
33 /**
34 * Disables the command, so it won't be run.
35 *
36 * @return bool
37 */
38 public function disableCommand()
39 {
40 return $this->commandShouldRun = false;
41 }
42
43 /**
44 * Enables the command.
45 *
46 * @return bool
47 */
48 public function enableCommand()
49 {
50 return $this->commandShouldRun = true;
51 }
52
53 /**
54 * Returns true if the command is runnable, false otherwise.
55 *
56 * @return bool
57 */
58 public function commandShouldRun()
59 {
60 return $this->commandShouldRun;
61 }
62 }