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: 

<?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\Config;

use LogicException;
use Webmozart\Assert\Assert;
use Webmozart\Console\Api\Args\Format\ArgsFormat;
use Webmozart\Console\Api\Args\Format\CommandOption;

/**
 * The configuration of an option command.
 *
 * @since  1.0
 *
 * @author Bernhard Schussek <bschussek@gmail.com>
 */
class OptionCommandConfig extends SubCommandConfig
{
    /**
     * @var string
     */
    private $shortName;

    /**
     * @var bool
     */
    private $longNamePreferred;

    /**
     * Creates a new configuration.
     *
     * @param string            $name              The long option name of the command.
     * @param string            $shortName         The short option name of the command.
     * @param CommandConfig     $parentConfig      The parent configuration.
     * @param ApplicationConfig $applicationConfig The application configuration.
     */
    public function __construct($name = null, $shortName = null, CommandConfig $parentConfig = null, ApplicationConfig $applicationConfig = null)
    {
        parent::__construct($name, $parentConfig, $applicationConfig);

        $this->setShortName($shortName);
    }

    /**
     * Sets the name of the command.
     *
     * Contrary to the base implementation, the name of an option command must
     * contain at least two characters.
     *
     * @param string $name The name of the command.
     *
     * @return static The current instance.
     */
    public function setName($name)
    {
        if (null !== $name) {
            Assert::string($name, 'The command name must be a string or null. Got: %s');
            Assert::notEmpty($name, 'The command name must not be empty.');
            Assert::greaterThan(strlen($name), 1, sprintf('The command name should contain at least two characters. Got: "%s"', $name));
        }

        parent::setName($name);

        return $this;
    }

    /**
     * Alias of {@link getName()}.
     *
     * @return string The command name.
     */
    public function getLongName()
    {
        return $this->getName();
    }

    /**
     * Alias of {@link setName()}.
     *
     * @param string $name The command name.
     *
     * @return static The current instance.
     */
    public function setLongName($name)
    {
        return $this->setName($name);
    }

    /**
     * Returns the short option name of the command.
     *
     * @return string The short option name.
     */
    public function getShortName()
    {
        return $this->shortName;
    }

    /**
     * Sets the short option name of the command.
     *
     * The short name must consist of a single letter. The short name is
     * preceded by a single dash "-" when calling the command:
     *
     * ```
     * $ server -d localhost
     * ```
     *
     * In the example above, "d" is the short name of the "server --delete"
     * command.
     *
     * @param string $shortName The short option name.
     *
     * @return static The current instance.
     */
    public function setShortName($shortName)
    {
        if (null !== $shortName) {
            Assert::string($shortName, 'The short command name must be a string or null. Got: %s');
            Assert::notEmpty($shortName, 'The short command name must not be empty.');
            Assert::regex($shortName, '~^[a-zA-Z]$~', 'The short command name must contain a single letter. Got: %s');
        }

        // Reset short name preference when unsetting the short name
        if (null === $shortName && false === $this->longNamePreferred) {
            $this->longNamePreferred = null;
        }

        $this->shortName = $shortName;

        return $this;
    }

    /**
     * Marks the long name to be preferred over the short name.
     *
     * This information is mainly used in the help where the preferred name is
     * listed before alternative names.
     *
     * @return static The current instance.
     *
     * @see isLongNamePreferred(), setPreferShortName()
     */
    public function setPreferLongName()
    {
        $this->longNamePreferred = true;

        return $this;
    }

    /**
     * Marks the short name to be preferred over the long name.
     *
     * This information is mainly used in the help where the preferred name is
     * listed before alternative names.
     *
     * @return static The current instance.
     *
     * @see isShortNamePreferred(), setPreferLongName()
     */
    public function setPreferShortName()
    {
        if (null === $this->shortName) {
            throw new LogicException('No short name is set.');
        }

        $this->longNamePreferred = false;

        return $this;
    }

    /**
     * Returns whether the long name should be preferred over the short name.
     *
     * If no preference was set, the short name is preferred by default if one
     * is set. If no short name is set, the long name is preferred by default.
     *
     * @return bool Returns `true` if the long name should be preferred over the
     *              short name.
     *
     * @see setPreferLongName(), isShortNamePreferred()
     */
    public function isLongNamePreferred()
    {
        if (null === $this->longNamePreferred) {
            // If no preference is set, prefer the short name (if one is set)
            return null === $this->shortName;
        }

        return $this->longNamePreferred;
    }

    /**
     * Returns whether the short name should be preferred over the long name.
     *
     * If no preference was set, the short name is preferred by default if one
     * is set. If no short name is set, the long name is preferred by default.
     *
     * @return bool Returns `true` if the short name should be preferred over
     *              the long name.
     *
     * @see setPreferShortName(), isLongNamePreferred()
     */
    public function isShortNamePreferred()
    {
        return !$this->isLongNamePreferred();
    }

    /**
     * {@inheritdoc}
     */
    public function buildArgsFormat(ArgsFormat $baseFormat = null)
    {
        $formatBuilder = ArgsFormat::build($baseFormat);

        if (!$this->isAnonymous()) {
            $flags = $this->isLongNamePreferred()
                ? CommandOption::PREFER_LONG_NAME
                : CommandOption::PREFER_SHORT_NAME;

            $formatBuilder->addCommandOption(new CommandOption(
                $this->getName(),
                $this->getShortName(),
                $this->getAliases(),
                $flags
            ));
        }

        $formatBuilder->addOptions($this->getOptions());
        $formatBuilder->addArguments($this->getArguments());

        return $formatBuilder->getFormat();
    }
}