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:
<?php
namespace Webmozart\Console\Api\Args\Format;
use InvalidArgumentException;
use Webmozart\Assert\Assert;
abstract class AbstractOption
{
const PREFER_LONG_NAME = 1;
const PREFER_SHORT_NAME = 2;
protected $flags;
private $longName;
private $shortName;
private $description;
public function __construct($longName, $shortName = null, $flags = 0, $description = null)
{
$longName = $this->removeDoubleDashPrefix($longName);
$shortName = $this->removeDashPrefix($shortName);
Assert::nullOrString($description, 'The option description must be a string or null. Got: %s');
Assert::nullOrNotEmpty($description, 'The option description must not be empty.');
$this->assertFlagsValid($flags);
$this->assertLongNameValid($longName);
$this->assertShortNameValid($shortName, $flags);
$this->longName = $longName;
$this->shortName = $shortName;
$this->description = $description;
$this->addDefaultFlags($flags);
$this->flags = $flags;
}
public function getLongName()
{
return $this->longName;
}
public function isLongNamePreferred()
{
return (bool) (self::PREFER_LONG_NAME & $this->flags);
}
public function getShortName()
{
return $this->shortName;
}
public function isShortNamePreferred()
{
return (bool) (self::PREFER_SHORT_NAME & $this->flags);
}
public function getDescription()
{
return $this->description;
}
private function assertLongNameValid($longName)
{
Assert::string($longName, 'The long option name must be a string. Got: %s');
Assert::notEmpty($longName, 'The long option name must not be empty.');
Assert::greaterThan(strlen($longName), 1, sprintf('The long option name must contain more than one character. Got: "%s"', $longName));
Assert::startsWithLetter($longName, 'The long option name must start with a letter.');
Assert::regex($longName, '~^[a-zA-Z0-9\-]+$~', 'The long option name must contain letters, digits and hyphens only.');
}
private function assertShortNameValid($shortName, $flags)
{
if (null !== $shortName) {
Assert::string($shortName, 'The short option name must be a string or null. Got: %s');
Assert::notEmpty($shortName, 'The short option name must not be empty.');
Assert::regex($shortName, '~^[a-zA-Z]$~', 'The short option name must be exactly one letter. Got: "%s"');
}
if (null === $shortName && ($flags & self::PREFER_SHORT_NAME)) {
throw new InvalidArgumentException('The short option name must be given if the option flag PREFER_SHORT_NAME is selected.');
}
}
private function removeDoubleDashPrefix($string)
{
if ('--' === substr($string, 0, 2)) {
$string = substr($string, 2);
}
return $string;
}
private function removeDashPrefix($string)
{
if (isset($string[0]) && '-' === $string[0]) {
$string = substr($string, 1);
}
return $string;
}
private function assertFlagsValid($flags)
{
Assert::integer($flags, 'The option flags must be an integer. Got: %s');
if (($flags & self::PREFER_SHORT_NAME) && ($flags & self::PREFER_LONG_NAME)) {
throw new InvalidArgumentException('The option flags PREFER_SHORT_NAME and PREFER_LONG_NAME cannot be combined.');
}
}
private function addDefaultFlags(&$flags)
{
if (!($flags & (self::PREFER_LONG_NAME | self::PREFER_SHORT_NAME))) {
$flags |= ($this->shortName ? self::PREFER_SHORT_NAME : self::PREFER_LONG_NAME);
}
}
}