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:
<?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\Resolver;
use Webmozart\Console\Api\Args\Args;
use Webmozart\Console\Api\Args\CannotParseArgsException;
use Webmozart\Console\Api\Args\RawArgs;
use Webmozart\Console\Api\Command\Command;
/**
* An intermediate result created during resolving.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class ResolveResult
{
/**
* @var Command
*/
private $command;
/**
* @var RawArgs
*/
private $rawArgs;
/**
* @var Args
*/
private $parsedArgs;
/**
* @var CannotParseArgsException
*/
private $parseError;
/**
* @var bool
*/
private $parsed = false;
/**
* Creates a new resolved command.
*
* @param Command $command The command.
* @param RawArgs $rawArgs The raw console arguments.
*/
public function __construct(Command $command, RawArgs $rawArgs)
{
$this->command = $command;
$this->rawArgs = $rawArgs;
}
/**
* Returns the command.
*
* @return Command The command.
*/
public function getCommand()
{
return $this->command;
}
/**
* The raw console arguments.
*
* @return RawArgs The raw console arguments.
*/
public function getRawArgs()
{
return $this->rawArgs;
}
/**
* Returns the parsed console arguments.
*
* @return Args The parsed console arguments or `null` if the console
* arguments cannot be parsed.
*
* @see isParsable(), getParseError()
*/
public function getParsedArgs()
{
if (!$this->parsed) {
$this->parse();
}
return $this->parsedArgs;
}
/**
* Returns the error that happened during argument parsing.
*
* @return CannotParseArgsException The parse error or `null` if the
* arguments were parsed successfully.
*
* @see isParsable(), getParsedArgs()
*/
public function getParseError()
{
if (!$this->parsed) {
$this->parse();
}
return $this->parseError;
}
/**
* Returns whether the console arguments can be parsed.
*
* @return bool Returns `true` if the console arguments can be parsed and
* `false` if a parse error occurred.
*
* @see getParsedArgs(), getParseError()
*/
public function isParsable()
{
if (!$this->parsed) {
$this->parse();
}
return null === $this->parseError;
}
private function parse()
{
try {
$this->parsedArgs = $this->command->parseArgs($this->rawArgs);
} catch (CannotParseArgsException $e) {
$this->parseError = $e;
}
$this->parsed = true;
}
}