• Главная
• Webmozart
• Console
• Api
• Args
• Format
• ArgsFormat

PHP Класс Webmozart\Console\Api\Args\Format\ArgsFormat

This class is a container for {@link CommandName}, {@link CommandOption}, {@link Option} and {@link Argument} objects. The format is used to interpret a given {@link RawArgs} instance. You can pass the options and arguments to the constructor of the class: php $format = new ArgsFormat(array( new CommandName('server'), new CommandName('add'), new Argument('host', Argument::REQUIRED), new Option('port', 'p', Option::VALUE_OPTIONAL, null, 80), )); The previous example configures a command that can be called like this: $ console server add localhost $ console server add localhost --port 8080 If the "add" command should be called via an option, change the format to: php $format = new ArgsFormat(array( new CommandName('server'), new CommandOption('add', 'a'), new Argument('host', Argument::REQUIRED), new Option('port', 'p', Option::VALUE_OPTIONAL, null, 80), )); The command is then called like this: $ console server --add localhost $ console server --add localhost --port 8080 The format is immutable after its construction. This is necessary to maintain consistency when one format inherits from another. For example, adding a required argument to the base format of a format that already contains optional arguments is an illegal operation that cannot be prevented if the formats are mutable. If you want to create a format stepwisely, use an {@link ArgsFormatBuilder}. If multiple formats share a common set of options and arguments, extract these options and arguments into a base format and let the other formats inherit from this base format: php $baseFormat = new ArgsFormat(array( new Option('verbose', 'v'), )); $format = new ArgsFormat(array( new CommandName('server'), new CommandName('add'), new Argument('host', Argument::REQUIRED), new Option('port', 'p', Option::VALUE_OPTIONAL, null, 80), ), $baseFormat); Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
__construct ( array | ArgsFormatBuilder $elements = [], ArgsFormat $baseFormat = null )	Creates a new format.
build ( ArgsFormat $baseFormat = null ) : ArgsFormatBuilder	Returns a format builder.
getArgument ( string | integer $name, boolean $includeBase = true ) : Argument	Returns an argument by its name or position.
getArguments ( boolean $includeBase = true ) : Argument[]	Returns all arguments of the format.
getBaseFormat ( ) : ArgsFormat	Returns the base format.
getCommandNames ( boolean $includeBase = true ) : CommandName[]	Returns the command names.
getCommandOption ( string $name, boolean $includeBase = true ) : CommandOption	Returns a command option by its long or short name.
getCommandOptions ( boolean $includeBase = true ) : CommandOption[]	Returns all command options of the format.
getNumberOfArguments ( boolean $includeBase = true ) : integer	Returns the number of arguments.
getNumberOfRequiredArguments ( boolean $includeBase = true ) : integer	Returns the number of required arguments.
getOption ( string $name, boolean $includeBase = true ) : Option	Returns an option by its long or short name.
getOptions ( boolean $includeBase = true ) : Option[]	Returns all options of the format.
hasArgument ( string | integer $name, boolean $includeBase = true ) : boolean	Returns whether the format contains a specific argument.
hasArguments ( boolean $includeBase = true ) : boolean	Returns whether the format contains any argument.
hasCommandNames ( boolean $includeBase = true ) : boolean	Returns whether the format contains any command names.
hasCommandOption ( string $name, boolean $includeBase = true ) : boolean	Returns whether the format contains a specific command option.
hasCommandOptions ( boolean $includeBase = true ) : boolean	Returns whether the format contains command options.
hasMultiValuedArgument ( boolean $includeBase = true ) : boolean	Returns whether the format contains a multi-valued argument.
hasOption ( string $name, boolean $includeBase = true ) : boolean	Returns whether the format contains a specific option.
hasOptionalArgument ( boolean $includeBase = true ) : boolean	Returns whether the format contains an optional argument.
hasOptions ( boolean $includeBase = true ) : boolean	Returns whether the format contains options.
hasRequiredArgument ( boolean $includeBase = true ) : boolean	Returns whether the format contains a required argument.

Приватные методы

Метод	Описание
createBuilderForElements ( array $elements, ArgsFormat $baseFormat = null ) : ArgsFormatBuilder	Creates a format builder for a set of arguments and options.

Описание методов