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: <?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\Format;
use InvalidArgumentException;
use Webmozart\Assert\Assert;
use Webmozart\Console\Util\StringUtil;
/**
* An input option.
*
* Args options are passed after the command name(s). Each option has a
* long name that is prefixed by two dashes ("--") and optionally a short name
* that is prefixed by one dash only ("-"). The long name must have at least
* two characters, the short name must contain a single letter only.
*
* In the example below, "--verbose" and "-v" are the long and short names of
* the same option:
*
* ```
* $ console server --verbose
* $ console server -v
* ```
*
* The long and short names are passed to the constructor of this class. The
* leading dashes can be omitted:
*
* ```php
* $option = new Option('verbose', 'v');
* ```
*
* If an option accepts a value, you must pass one of the flags
* {@link VALUE_REQUIRED}, {@link VALUE_OPTIONAL} or {@link MULTI_VALUED} to
* the constructor:
*
* ```php
* $option = new Option('format', 'f', Option::VALUE_REQUIRED);
* ```
*
* * The flag {@link VALUE_REQUIRED} indicates that a value must always be
* passed.
* * The flag {@link VALUE_OPTIONAL} indicates that a value may optionally be
* passed. If no value is passed, the default value passed to the constructor
* is returned, which defaults to `null`.
* * The flag {@link MULTI_VALUED} indicates that the option can be passed
* multiple times with different values. The passed values are returned to
* the application as array. The value of a multi-valued option is always
* required.
*
* @since 1.0
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class Option extends AbstractOption
{
/**
* Flag: The option has no value.
*/
const NO_VALUE = 4;
/**
* Flag: The option has a required value.
*/
const REQUIRED_VALUE = 8;
/**
* Flag: The option has an optional value.
*/
const OPTIONAL_VALUE = 16;
/**
* Flag: The option can be stated multiple times with different values.
*/
const MULTI_VALUED = 32;
/**
* Flag: The option value is parsed as string.
*/
const STRING = 128;
/**
* Flag: The option value is parsed as boolean.
*/
const BOOLEAN = 256;
/**
* Flag: The option value is parsed as integer.
*/
const INTEGER = 512;
/**
* Flag: The option value is parsed as float.
*/
const FLOAT = 1024;
/**
* Flag: The option value "null" should be parsed as `null`.
*/
const NULLABLE = 2048;
/**
* @var mixed
*/
private $defaultValue;
/**
* @var string
*/
private $valueName;
/**
* Creates a new option.
*
* @param string $longName The long option name.
* @param string|null $shortName The short option name.
* @param int $flags A bitwise combination of the option flag
* constants.
* @param string $description A human-readable description of the option.
* @param mixed $defaultValue The default value (must be null for
* {@link VALUE_REQUIRED} or
* {@link VALUE_NONE}).
* @param string $valueName The name of the value to be used in
* usage examples of the option.
*
* @throws InvalidValueException If the default value is invalid.
*/
public function __construct($longName, $shortName = null, $flags = 0, $description = null, $defaultValue = null, $valueName = '...')
{
Assert::string($valueName, 'The option value name must be a string. Got: %s');
Assert::notEmpty($valueName, 'The option value name must not be empty.');
$this->assertFlagsValid($flags);
$this->addDefaultFlags($flags);
parent::__construct($longName, $shortName, $flags, $description);
$this->valueName = $valueName;
if ($this->acceptsValue() || null !== $defaultValue) {
$this->setDefaultValue($defaultValue);
}
}
/**
* Returns whether the option accepts a value.
*
* @return bool Returns `true` if a value flag other than {@link VALUE_NONE}
* was passed to the constructor.
*/
public function acceptsValue()
{
return !(self::NO_VALUE & $this->flags);
}
/**
* Parses an option value.
*
* Pass one of the flags {@link STRING}, {@link BOOLEAN}, {@link INTEGER}
* and {@link FLOAT} to the constructor to configure the result of this
* method. You can optionally combine the flags with {@link NULLABLE} to
* support the conversion of "null" to `null`.
*
* @param mixed $value The value to parse.
*
* @return mixed The parsed value.
*
* @throws InvalidValueException
*/
public function parseValue($value)
{
$nullable = ($this->flags & self::NULLABLE);
if ($this->flags & self::BOOLEAN) {
return StringUtil::parseBoolean($value, $nullable);
}
if ($this->flags & self::INTEGER) {
return StringUtil::parseInteger($value, $nullable);
}
if ($this->flags & self::FLOAT) {
return StringUtil::parseFloat($value, $nullable);
}
return StringUtil::parseString($value, $nullable);
}
/**
* Returns whether the option requires a value.
*
* @return bool Returns `true` if the flag {@link VALUE_REQUIRED} was
* passed to the constructor.
*/
public function isValueRequired()
{
return (bool) (self::REQUIRED_VALUE & $this->flags);
}
/**
* Returns whether the option takes an optional value.
*
* @return bool Returns `true` if the flag {@link VALUE_OPTIONAL} was
* passed to the constructor.
*/
public function isValueOptional()
{
return (bool) (self::OPTIONAL_VALUE & $this->flags);
}
/**
* Returns whether the option accepts multiple values.
*
* @return bool Returns `true` if the flag {@link MULTI_VALUED} was
* passed to the constructor.
*/
public function isMultiValued()
{
return (bool) (self::MULTI_VALUED & $this->flags);
}
/**
* Sets the default value of the option.
*
* If the option does not accept a value, this method throws an exception.
*
* If the option is multi-valued, the passed value must be an array or
* `null`.
*
* @param mixed $defaultValue The default value.
*
* @throws InvalidValueException If the default value is invalid.
*/
public function setDefaultValue($defaultValue = null)
{
if (!$this->acceptsValue()) {
throw new InvalidValueException('Cannot set a default value when using the flag VALUE_NONE.');
}
if ($this->isMultiValued()) {
if (null === $defaultValue) {
$defaultValue = array();
} elseif (!is_array($defaultValue)) {
throw new InvalidValueException(sprintf(
'The default value of a multi-valued option must be an '.
'array. Got: %s',
is_object($defaultValue) ? get_class($defaultValue) : gettype($defaultValue)
));
}
}
$this->defaultValue = $defaultValue;
}
/**
* Returns the default value of the option.
*
* @return mixed The default value.
*/
public function getDefaultValue()
{
return $this->defaultValue;
}
/**
* Returns the name of the option value.
*
* This name can be used as placeholder of the value when displaying the
* option's usage.
*
* @return string The name of the option value.
*/
public function getValueName()
{
return $this->valueName;
}
private function assertFlagsValid($flags)
{
Assert::integer($flags, 'The option flags must be an integer. Got: %s');
if ($flags & self::NO_VALUE) {
if ($flags & self::REQUIRED_VALUE) {
throw new InvalidArgumentException('The option flags VALUE_NONE and VALUE_REQUIRED cannot be combined.');
}
if ($flags & self::OPTIONAL_VALUE) {
throw new InvalidArgumentException('The option flags VALUE_NONE and VALUE_OPTIONAL cannot be combined.');
}
if ($flags & self::MULTI_VALUED) {
throw new InvalidArgumentException('The option flags VALUE_NONE and MULTI_VALUED cannot be combined.');
}
}
if (($flags & self::OPTIONAL_VALUE) && ($flags & self::MULTI_VALUED)) {
throw new InvalidArgumentException('The option flags VALUE_OPTIONAL and MULTI_VALUED cannot be combined.');
}
if ($flags & self::STRING) {
if ($flags & self::BOOLEAN) {
throw new InvalidArgumentException('The option flags STRING and BOOLEAN cannot be combined.');
}
if ($flags & self::INTEGER) {
throw new InvalidArgumentException('The option flags STRING and INTEGER cannot be combined.');
}
if ($flags & self::FLOAT) {
throw new InvalidArgumentException('The option flags STRING and FLOAT cannot be combined.');
}
} elseif ($flags & self::BOOLEAN) {
if ($flags & self::INTEGER) {
throw new InvalidArgumentException('The option flags BOOLEAN and INTEGER cannot be combined.');
}
if ($flags & self::FLOAT) {
throw new InvalidArgumentException('The option flags BOOLEAN and FLOAT cannot be combined.');
}
} elseif ($flags & self::INTEGER) {
if ($flags & self::FLOAT) {
throw new InvalidArgumentException('The option flags INTEGER and FLOAT cannot be combined.');
}
}
}
private function addDefaultFlags(&$flags)
{
if (!($flags & (self::NO_VALUE | self::REQUIRED_VALUE | self::OPTIONAL_VALUE | self::MULTI_VALUED))) {
$flags |= self::NO_VALUE;
}
if (!($flags & (self::STRING | self::BOOLEAN | self::INTEGER | self::FLOAT))) {
$flags |= self::STRING;
}
if (($flags & self::MULTI_VALUED) && !($flags & self::REQUIRED_VALUE)) {
$flags |= self::REQUIRED_VALUE;
}
}
}