* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\Console\Attribute; use Symfony\Component\Console\Completion\CompletionInput; use Symfony\Component\Console\Completion\Suggestion; use Symfony\Component\Console\Exception\LogicException; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Input\InputOption; use Symfony\Component\String\UnicodeString; #[\Attribute(\Attribute::TARGET_PARAMETER)] class Option { private const ALLOWED_TYPES = ['string', 'bool', 'int', 'float', 'array']; private const ALLOWED_UNION_TYPES = ['bool|string', 'bool|int', 'bool|float']; private string|bool|int|float|array|null $default = null; private array|\Closure $suggestedValues; private ?int $mode = null; private string $typeName = ''; private bool $allowNull = false; private string $function = ''; /** * Represents a console command --option definition. * * If unset, the `name` value will be inferred from the parameter definition. * * @param array|string|null $shortcut The shortcuts, can be null, a string of shortcuts delimited by | or an array of shortcuts * @param array|callable(CompletionInput):list $suggestedValues The values used for input completion */ public function __construct( public string $description = '', public string $name = '', public array|string|null $shortcut = null, array|callable $suggestedValues = [], ) { $this->suggestedValues = \is_callable($suggestedValues) ? $suggestedValues(...) : $suggestedValues; } /** * @internal */ public static function tryFrom(\ReflectionParameter $parameter): ?self { /** @var self $self */ if (null === $self = ($parameter->getAttributes(self::class, \ReflectionAttribute::IS_INSTANCEOF)[0] ?? null)?->newInstance()) { return null; } if (($function = $parameter->getDeclaringFunction()) instanceof \ReflectionMethod) { $self->function = $function->class.'::'.$function->name; } else { $self->function = $function->name; } $name = $parameter->getName(); $type = $parameter->getType(); if (!$parameter->isDefaultValueAvailable()) { throw new LogicException(\sprintf('The option parameter "$%s" of "%s()" must declare a default value.', $name, $self->function)); } if (!$self->name) { $self->name = (new UnicodeString($name))->kebab(); } $self->default = $parameter->getDefaultValue(); $self->allowNull = $parameter->allowsNull(); if ($type instanceof \ReflectionUnionType) { return $self->handleUnion($type); } if (!$type instanceof \ReflectionNamedType) { throw new LogicException(\sprintf('The parameter "$%s" of "%s()" must have a named type. Untyped or Intersection types are not supported for command options.', $name, $self->function)); } $self->typeName = $type->getName(); if (!\in_array($self->typeName, self::ALLOWED_TYPES, true)) { throw new LogicException(\sprintf('The type "%s" on parameter "$%s" of "%s()" is not supported as a command option. Only "%s" types are allowed.', $self->typeName, $name, $self->function, implode('", "', self::ALLOWED_TYPES))); } if ('bool' === $self->typeName && $self->allowNull && \in_array($self->default, [true, false], true)) { throw new LogicException(\sprintf('The option parameter "$%s" of "%s()" must not be nullable when it has a default boolean value.', $name, $self->function)); } if ($self->allowNull && null !== $self->default) { throw new LogicException(\sprintf('The option parameter "$%s" of "%s()" must either be not-nullable or have a default of null.', $name, $self->function)); } if ('bool' === $self->typeName) { $self->mode = InputOption::VALUE_NONE; if (false !== $self->default) { $self->mode |= InputOption::VALUE_NEGATABLE; } } elseif ('array' === $self->typeName) { $self->mode = InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY; } else { $self->mode = InputOption::VALUE_REQUIRED; } if (\is_array($self->suggestedValues) && !\is_callable($self->suggestedValues) && 2 === \count($self->suggestedValues) && ($instance = $parameter->getDeclaringFunction()->getClosureThis()) && $instance::class === $self->suggestedValues[0] && \is_callable([$instance, $self->suggestedValues[1]])) { $self->suggestedValues = [$instance, $self->suggestedValues[1]]; } return $self; } /** * @internal */ public function toInputOption(): InputOption { $default = InputOption::VALUE_NONE === (InputOption::VALUE_NONE & $this->mode) ? null : $this->default; $suggestedValues = \is_callable($this->suggestedValues) ? ($this->suggestedValues)(...) : $this->suggestedValues; return new InputOption($this->name, $this->shortcut, $this->mode, $this->description, $default, $suggestedValues); } /** * @internal */ public function resolveValue(InputInterface $input): mixed { $value = $input->getOption($this->name); if (null === $value && \in_array($this->typeName, self::ALLOWED_UNION_TYPES, true)) { return true; } if ('array' === $this->typeName && $this->allowNull && [] === $value) { return null; } if ('bool' !== $this->typeName) { return $value; } if ($this->allowNull && null === $value) { return null; } return $value ?? $this->default; } private function handleUnion(\ReflectionUnionType $type): self { $types = array_map( static fn(\ReflectionType $t) => $t instanceof \ReflectionNamedType ? $t->getName() : null, $type->getTypes(), ); sort($types); $this->typeName = implode('|', array_filter($types)); if (!\in_array($this->typeName, self::ALLOWED_UNION_TYPES, true)) { throw new LogicException(\sprintf('The union type for parameter "$%s" of "%s()" is not supported as a command option. Only "%s" types are allowed.', $this->name, $this->function, implode('", "', self::ALLOWED_UNION_TYPES))); } if (false !== $this->default) { throw new LogicException(\sprintf('The option parameter "$%s" of "%s()" must have a default value of false.', $this->name, $this->function)); } $this->mode = InputOption::VALUE_OPTIONAL; return $this; } }