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: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: <?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\Args;
use Webmozart\Console\Api\Args\Format\ArgsFormat;
use Webmozart\Console\Api\Args\Format\CommandName;
use Webmozart\Console\Api\Args\Format\CommandOption;
/**
* The parsed console arguments.
*
* The parsed arguments provide access to the options and arguments passed via
* the command line. Usually you can construct an {@link Args} instance by
* parsing a {@link RawArgs} instance with an {@link ArgsParser}:
*
* ```php
* $format = ArgsFormat::build()
* ->addCommandName(new CommandName('server'))
* ->addCommandName(new CommandName('add'))
* ->addOption(new Option('port', 'p', Option::VALUE_REQUIRED | Option::INTEGER))
* ->addArgument(new Argument('host', Argument::REQUIRED))
* ->getFormat();
*
* $args = $parser->parseArgs($rawArgs, $format);
* ```
*
* The {@link ArgsFormat} defines which rules the console arguments must adhere
* to.
*
* You can also create {@link Args} instances manually. This is especially
* useful in tests:
*
* ```php
* $format = ArgsFormat::build()
* ->addOption(new Option('port', 'p', Option::VALUE_REQUIRED | Option::INTEGER))
* ->addArgument(new Argument('host', Argument::REQUIRED))
* ->getFormat();
*
* $args = new Args($format);
* $args->setOption('port', 80);
* $args->setArgument('host', 'localhost');
* ```
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see RawArgs, ArgsFormat, ArgsParser
*/
class Args
{
/**
* @var ArgsFormat
*/
private $format;
/**
* @var RawArgs
*/
private $rawArgs;
/**
* @var array
*/
private $options = array();
/**
* @var array
*/
private $arguments = array();
/**
* Creates the console arguments.
*
* @param ArgsFormat $format The format that the arguments and options must
* adhere to.
* @param RawArgs $rawArgs The raw console arguments.
*/
public function __construct(ArgsFormat $format, RawArgs $rawArgs = null)
{
$this->format = $format;
$this->rawArgs = $rawArgs;
}
/**
* Returns the PHP script as it was called on the console.
*
* @return string|null The script name or null if no script name is
* available.
*/
public function getScriptName()
{
return $this->rawArgs ? $this->rawArgs->getScriptName() : null;
}
/**
* Returns the command names as array.
*
* @return CommandName[] The command names.
*/
public function getCommandNames()
{
return $this->format->getCommandNames();
}
/**
* Returns the command options as array.
*
* @return CommandOption[] The command options.
*/
public function getCommandOptions()
{
return $this->format->getCommandOptions();
}
/**
* Returns an option.
*
* If the option accepts a value, the value set for that option is returned.
* If no value was set with {@link setOption()}, the default value of the
* option is returned.j
*
* If the option accepts no value, the method returns `true` if the option
* was set and `false` otherwise.
*
* @param string $name The long or short option name.
*
* @return mixed The option value or `true`/`false` for options without
* values.
*
* @throws NoSuchOptionException If the option does not exist.
*/
public function getOption($name)
{
$option = $this->format->getOption($name);
if (array_key_exists($option->getLongName(), $this->options)) {
return $this->options[$option->getLongName()];
}
if ($option->acceptsValue()) {
return $option->getDefaultValue();
}
return false;
}
/**
* Returns all options.
*
* By default, this method also includes the default values set for options
* with values. You can disable this behavior by passing `false` for
* `$includeDefaults`.
*
* @param bool $includeDefaults Whether to return the default values for
* options that were not set.
*
* @return array The option values and `true`/`false` for options without
* values.
*
* @see getOption()
*/
public function getOptions($includeDefaults = true)
{
$options = $this->options;
if ($includeDefaults) {
foreach ($this->format->getOptions() as $option) {
$name = $option->getLongName();
if (!array_key_exists($name, $options)) {
$options[$name] = $option->acceptsValue() ? $option->getDefaultValue() : false;
}
}
}
return $options;
}
/**
* Sets an option.
*
* For options with values, you can pass the value in the second argument.
* The value is converted to the type defined by the argument format.
*
* For options without values, you can omit the second argument. Optionally,
* you can pass `true`/`false` explicitly to enable/disable the option.
*
* @param string $name The long or short option name.
* @param mixed $value The value to set for the option.
*
* @return static The current instance.
*
* @throws NoSuchOptionException If the option does not exist.
*/
public function setOption($name, $value = true)
{
$option = $this->format->getOption($name);
if ($option->isMultiValued()) {
$value = (array) $value;
foreach ($value as $k => $v) {
$value[$k] = $option->parseValue($v);
}
} elseif ($option->acceptsValue()) {
$value = $option->parseValue($value);
} elseif (false === $value) {
unset($this->options[$option->getLongName()]);
return $this;
} else {
$value = true;
}
$this->options[$option->getLongName()] = $value;
return $this;
}
/**
* Sets the values of multiple options.
*
* The existing options are preserved.
*
* @param array $options The options indexed by their long or short names
* and their values.
*
* @return static The current instance.
*
* @see setOption()
*/
public function addOptions(array $options)
{
foreach ($options as $name => $value) {
$this->setOption($name, $value);
}
return $this;
}
/**
* Sets the values of multiple options.
*
* The existing options are unset.
*
* @param array $options The options indexed by their long or short names
* and their values.
*
* @return static The current instance.
*
* @see setOption()
*/
public function setOptions(array $options)
{
$this->options = array();
$this->addOptions($options);
return $this;
}
/**
* Returns whether an option is set.
*
* @param string $name The long or short option name.
*
* @return bool Returns `true` if the option is set and `false` otherwise.
*/
public function isOptionSet($name)
{
return array_key_exists($name, $this->options);
}
/**
* Returns whether an option is defined in the format.
*
* @param string $name The long or short option name.
*
* @return bool Returns `true` if the option exists and `false` otherwise.
*/
public function isOptionDefined($name)
{
return $this->format->hasOption($name);
}
/**
* Returns the value of an argument.
*
* If the argument is not set, the default value configured in the argument
* format is returned.
*
* @param string|int $name The argument name or its 0-based position in the
* argument list.
*
* @return mixed The value of the argument.
*
* @throws NoSuchArgumentException If the argument does not exist.
*/
public function getArgument($name)
{
$argument = $this->format->getArgument($name);
if (array_key_exists($argument->getName(), $this->arguments)) {
return $this->arguments[$argument->getName()];
}
return $argument->getDefaultValue();
}
/**
* Returns the values of all arguments.
*
* By default, this method also includes the default values of unset
* arguments. You can disable this behavior by passing `false` for
* `$includeDefaults`.
*
* @param bool $includeDefaults Whether to return the default values for
* arguments that were not set.
*
* @return array The argument values.
*
* @see getArgument()
*/
public function getArguments($includeDefaults = true)
{
$arguments = array();
foreach ($this->format->getArguments() as $argument) {
$name = $argument->getName();
if (array_key_exists($name, $this->arguments)) {
$arguments[$name] = $this->arguments[$name];
} elseif ($includeDefaults) {
$arguments[$name] = $argument->getDefaultValue();
}
}
return $arguments;
}
/**
* Sets the value of an argument.
*
* The value is converted to the type defined by the argument format.
*
* @param string|int $name The argument name or its 0-based position in the
* argument list.
* @param mixed $value The value of the argument.
*
* @return static The current instance.
*
* @throws NoSuchArgumentException If the argument does not exist.
*/
public function setArgument($name, $value)
{
$argument = $this->format->getArgument($name);
if ($argument->isMultiValued()) {
$value = (array) $value;
foreach ($value as $k => $v) {
$value[$k] = $argument->parseValue($v);
}
} else {
$value = $argument->parseValue($value);
}
$this->arguments[$argument->getName()] = $value;
return $this;
}
/**
* Sets the values of multiple arguments.
*
* The existing arguments are preserved.
*
* @param array $arguments The argument values indexed by the argument names
* or their 0-based positions in the argument list.
*
* @return static The current instance.
*
* @see setArgument()
*/
public function addArguments(array $arguments)
{
foreach ($arguments as $name => $value) {
$this->setArgument($name, $value);
}
return $this;
}
/**
* Sets the values of multiple arguments.
*
* The existing arguments are unset.
*
* @param array $arguments The argument values indexed by the argument names
* or their 0-based positions in the argument list.
*
* @return static The current instance.
*
* @see setArgument()
*/
public function setArguments(array $arguments)
{
$this->arguments = array();
$this->addArguments($arguments);
return $this;
}
/**
* Returns whether an argument is set.
*
* @param string|int $name The argument name or its 0-based position in the
* argument list.
*
* @return bool Returns `true` if the argument is set and `false` otherwise.
*/
public function isArgumentSet($name)
{
return array_key_exists($name, $this->arguments);
}
/**
* Returns whether an argument is defined in the format.
*
* @param string|int $name The argument name or its 0-based position in the
* argument list.
*
* @return bool Returns `true` if the argument exists and `false` otherwise.
*/
public function isArgumentDefined($name)
{
return $this->format->hasArgument($name);
}
/**
* Returns the format of the console arguments.
*
* @return ArgsFormat The format.
*/
public function getFormat()
{
return $this->format;
}
/**
* Returns the raw console arguments.
*
* @return RawArgs The raw arguments.
*/
public function getRawArgs()
{
return $this->rawArgs;
}
}