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: 

<?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 argument.
 *
 * Args arguments are passed after the command name and its options. In the
 * example below, "localhost" is the argument to the "server -d" command.
 *
 * ```
 * $ console server -d localhost
 * ```
 *
 * Arguments can be either optional or required. By default, all arguments are
 * optional, but you can explicitly make an argument optional or required by
 * passing one of the flags {@link OPTIONAL} and {@link REQUIRED} to the
 * constructor:
 *
 * ```php
 * $argument = new Argument('server', Argument::REQUIRED);
 * ```
 *
 * Arguments can also be multi-valued. Multi-valued arguments can be passed any
 * number of times:
 *
 * ```
 * $ console server -d localhost google.com
 * ```
 *
 * To create a multi-valued argument, pass the flag {@link MULTI_VALUED} to the
 * constructor:
 *
 * ```php
 * $argument = new Argument('server', Argument::MULTI_VALUED);
 * ```
 *
 * You can combine the {@link MULTI_VALUED} flag with either {@link OPTIONAL}
 * or {@link REQUIRED} using the bitwise operator "|":
 *
 * ```php
 * $argument = new Argument('server', Argument::REQUIRED | Argument::MULTI_VALUED);
 * ```
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class Argument
{
    /**
     * Flag: The argument is required.
     */
    const REQUIRED = 1;

    /**
     * Flag: The argument is optional.
     */
    const OPTIONAL = 2;

    /**
     * Flag: The argument can be repeated multiple times.
     */
    const MULTI_VALUED = 4;

    /**
     * Flag: The value is parsed as string.
     */
    const STRING = 16;

    /**
     * Flag: The value is parsed as boolean.
     */
    const BOOLEAN = 32;

    /**
     * Flag: The value is parsed as integer.
     */
    const INTEGER = 64;

    /**
     * Flag: The value is parsed as float.
     */
    const FLOAT = 128;

    /**
     * Flag: The value "null" should be parsed as `null`.
     */
    const NULLABLE = 256;

    /**
     * @var string
     */
    private $name;

    /**
     * @var int
     */
    private $flags;

    /**
     * @var mixed
     */
    private $defaultValue;

    /**
     * @var string
     */
    private $description;

    /**
     * Creates a new argument.
     *
     * @param string $name         The argument name
     * @param int    $flags        A bitwise combination of the flag constants.
     * @param string $description  A human-readable description of the argument.
     * @param mixed  $defaultValue The default value of the argument (must be
     *                             null for the flag {@link self::REQUIRED}).
     */
    public function __construct($name, $flags = 0, $description = null, $defaultValue = null)
    {
        Assert::string($name, 'The argument name must be a string. Got: %s');
        Assert::notEmpty($name, 'The argument name must not be empty.');
        Assert::startsWithLetter($name, 'The argument name must start with a letter.');
        Assert::regex($name, '~^[a-zA-Z0-9\-]+$~', 'The argument name must contain letters, digits and hyphens only.');
        Assert::nullOrString($description, 'The argument description must be a string or null. Got: %s');
        Assert::nullOrNotEmpty($description, 'The argument description must not be empty.');

        $this->assertFlagsValid($flags);

        $this->addDefaultFlags($flags);

        $this->name = $name;
        $this->flags = $flags;
        $this->description = $description;
        $this->defaultValue = $this->isMultiValued() ? array() : null;

        if ($this->isOptional() || null !== $defaultValue) {
            $this->setDefaultValue($defaultValue);
        }
    }

    /**
     * Returns the name of the argument.
     *
     * @return string The argument name.
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Returns whether the argument is required.
     *
     * @return bool Returns `true` if the flag {@link REQUIRED} was passed to
     *              the constructor.
     */
    public function isRequired()
    {
        return (bool) (self::REQUIRED & $this->flags);
    }

    /**
     * Returns whether the argument is optional.
     *
     * @return bool Returns `true` if the flag {@link OPTIONAL} was passed to
     *              the constructor.
     */
    public function isOptional()
    {
        return (bool) (self::OPTIONAL & $this->flags);
    }

    /**
     * Returns whether the argument 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.
     *
     * If the argument is required, 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->isRequired()) {
            throw new InvalidValueException('Required arguments do not accept default values.');
        }

        if ($this->isMultiValued()) {
            if (null === $defaultValue) {
                $defaultValue = array();
            } elseif (!is_array($defaultValue)) {
                throw new InvalidValueException(sprintf(
                    'The default value of a multi-valued argument must be an '.
                    'array. Got: %s',
                    is_object($defaultValue) ? get_class($defaultValue) : gettype($defaultValue)
                ));
            }
        }

        $this->defaultValue = $defaultValue;
    }

    /**
     * Returns the default value of the argument.
     *
     * @return mixed The default value.
     */
    public function getDefaultValue()
    {
        return $this->defaultValue;
    }

    /**
     * Parses an argument 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 the description text.
     *
     * @return string The description text.
     */
    public function getDescription()
    {
        return $this->description;
    }

    private function assertFlagsValid($flags)
    {
        Assert::integer($flags, 'The argument flags must be an integer. Got: %s');

        if (($flags & self::REQUIRED) && ($flags & self::OPTIONAL)) {
            throw new InvalidArgumentException('The argument flags REQUIRED and OPTIONAL cannot be combined.');
        }

        if ($flags & self::STRING) {
            if ($flags & self::BOOLEAN) {
                throw new InvalidArgumentException('The argument flags STRING and BOOLEAN cannot be combined.');
            }

            if ($flags & self::INTEGER) {
                throw new InvalidArgumentException('The argument flags STRING and INTEGER cannot be combined.');
            }

            if ($flags & self::FLOAT) {
                throw new InvalidArgumentException('The argument flags STRING and FLOAT cannot be combined.');
            }
        } elseif ($flags & self::BOOLEAN) {
            if ($flags & self::INTEGER) {
                throw new InvalidArgumentException('The argument flags BOOLEAN and INTEGER cannot be combined.');
            }

            if ($flags & self::FLOAT) {
                throw new InvalidArgumentException('The argument flags BOOLEAN and FLOAT cannot be combined.');
            }
        } elseif ($flags & self::INTEGER) {
            if ($flags & self::FLOAT) {
                throw new InvalidArgumentException('The argument flags INTEGER and FLOAT cannot be combined.');
            }
        }
    }

    private function addDefaultFlags(&$flags)
    {
        if (!($flags & (self::REQUIRED | self::OPTIONAL))) {
            $flags |= self::OPTIONAL;
        }

        if (!($flags & (self::STRING | self::BOOLEAN | self::INTEGER | self::FLOAT))) {
            $flags |= self::STRING;
        }
    }
}