Parser

class Parser

A parser of CLI options

Instance Properties

Protected
Name	Type	Summary
`$options`	`OptionSet`

Public
Returns	Signature and Description
`void`	`__construct`(`OptionSet $options`) Creates a new Parser

Public
Returns	Signature and Description
`Command`	`parse`(`Traversable<string> $arguments`) Parses a list of arguments into a proper CLI command

Protected
Returns	Signature and Description
`void`	`addOption`(`string $label`, `mixed $value`, `Option $option`, `Map<string,mixed> $options`) Safely adds an option to the map, taking into account multiplicity.
`void`	`parseLong`(`string $arg`, `Vector<string> $args`, `Map<string,mixed> $options`) Parses a long option (e.g. `--dir`)
`void`	`parseShort`(`string $arg`, `Vector<string> $args`, `Map<string,mixed> $options`) Parses a short option (e.g. `-d`)

protected OptionSet $options

public function __construct(OptionSet $options)

Creates a new Parser

Parameters
Name	Type	Description
`$options`	`OptionSet`	The options to parse

protected function addOption(string $label, mixed $value, Option $option, Map<string,mixed> $options)

Safely adds an option to the map, taking into account multiplicity.

public function parse(Traversable<string> $arguments)

Parses a list of arguments into a proper CLI command

Parameters
Name	Type	Description
`$arguments`	`Traversable`<`string`>	The arguments

Returns
Type	Description
`Command`	A parsed command

Throws
Type	Conditions
`InvalidArgumentException`	if the arguments parameter is empty
`UnexpectedValueException`	if an unknown option is used or a required value is not supplied

protected function parseLong(string $arg, Vector<string> $args, Map<string,mixed> $options)

Parses a long option (e.g. --dir)

protected function parseShort(string $arg, Vector<string> $args, Map<string,mixed> $options)

Parses a short option (e.g. -d)