1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152:
<?php
/*
* This file is part of the webmozart/console package.
*
* (c) Bernhard Schussek <bschussek@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Webmozart\Console\Api\Event;
use Symfony\Component\EventDispatcher\Event;
use Webmozart\Console\Api\Args\Args;
use Webmozart\Console\Api\Command\Command;
use Webmozart\Console\Api\IO\IO;
/**
* Dispatched before a command is handled.
*
* Add a listener for this event to execute custom logic before or instead of
* the default handler.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class PreHandleEvent extends Event
{
/**
* @var Args
*/
private $args;
/**
* @var IO
*/
private $io;
/**
* @var Command
*/
private $command;
/**
* @var bool
*/
private $handled = false;
/**
* @var int
*/
private $statusCode = 0;
/**
* Creates the event.
*
* @param Args $args The parsed console arguments.
* @param IO $io The I/O.
* @param Command $command The executed command.
*/
public function __construct(Args $args, IO $io, Command $command)
{
$this->args = $args;
$this->io = $io;
$this->command = $command;
}
/**
* Returns the parsed console arguments.
*
* @return Args The parsed console arguments.
*/
public function getArgs()
{
return $this->args;
}
/**
* Returns the I/O.
*
* @return IO The I/O.
*/
public function getIO()
{
return $this->io;
}
/**
* Returns the executed command.
*
* @return Command The executed command.
*/
public function getCommand()
{
return $this->command;
}
/**
* Returns whether the command was handled by the event listener.
*
* @return bool Returns `true` if the command was handled and `false`
* otherwise.
*
* @see setHandled()
*/
public function isHandled()
{
return $this->handled;
}
/**
* Sets whether the command was handled by the event listener.
*
* If set to `true`, the handler configured for the command is not
* executed. Instead the status code returned by {@link getStatusCode()}
* is returned.
*
* @param bool $handled Whether the command was handled by the event
* listener.
*/
public function setHandled($handled)
{
$this->handled = (bool) $handled;
}
/**
* Returns the status code to return.
*
* @return int Returns 0 on success and any positive integer on error.
*/
public function getStatusCode()
{
return $this->statusCode;
}
/**
* Sets the status code to return.
*
* This method is only useful in combination with {@link setHandled()}.
* If the event is not marked as handled, the status code is ignored.
*
* @param int $statusCode Set to 0 on success and any positive integer on
* error.
*/
public function setStatusCode($statusCode)
{
$this->statusCode = (int) $statusCode;
}
}