Класс ConsoleOptionParser

$parser->addArgument('model', ['required' => false]);

__construct()source public

__construct( string|null $command null , boolean $defaultOptions true )

Конструктор OptionParser, позволяющий определить его поведение

Параметры

string|null $command необязательно null

Имя команды, для которой предназначен этот парсер. Имя команды используется для генерации справки.

boolean $defaultOptions необязательно true

Указывает, хотите ли вы задать опции verbose и quiet. Установка этого значения в false предотвратит добавление опций --verbose и --quiet.

_nextToken()source protected

_nextToken( )

Найти следующий токен в наборе argv.

Возвращает

string
следующий токен или ''

_optionExists()source protected

_optionExists( string $name )

Проверить, определён ли для $name параметр (короткий/длинный).

Параметры

string $name

Имя параметра.

Возвращает

boolean

_parseArg()source protected

_parseArg( string $argument , array $args )

Обработать аргумент и убедиться, что аргумент не превышает количество аргументов и что аргумент является допустимым выбором.

Параметры

string $argument

Аргумент для добавления

array $args

Массив обработанных аргументов для добавления.

Возвращает

array
Аргументы

Выбрасывает

Cake\Console\Exception\ConsoleException

_parseLongOption()source protected

_parseLongOption( string $option , array $params )

Обработать значение для длинного параметра из $this->_tokens. Обработает параметры с = в них.

Параметры

string $option

Параметр для обработки.

array $params

Параметры для добавления обработанного значения

Возвращает

array
Параметры с добавленным $option

_parseOption()source protected

_parseOption( string $name , array $params )

Обработать параметр по его индексу имени.

Параметры

string $name

Имя для обработки.

array $params

Параметры для добавления обработанного значения

Возвращает

array
Параметры с добавленным $option

Выбрасывает

Cake\Console\Exception\ConsoleException

_parseShortOption()source protected

_parseShortOption( string $option , array $params )

Обработать значение для короткого параметра из $this->_tokens Если $option является комбинацией нескольких сокращений, таких как -otf, они будут перемещены в стек токенов и обработаны индивидуально.

Параметры

string $option

Параметр для обработки.

array $params

Параметры для добавления обработанного значения

Возвращает

array
Параметры с добавленным $option

Выбрасывает

Cake\Console\Exception\ConsoleException
При обнаружении неизвестных коротких параметров.

addArgument()source public

addArgument( Cake\Console\ConsoleInputArgument|string $name , array $params [] )

Добавить позиционный аргумент к парсеру параметров.

Параметры

• help Текст справки для отображения для этого аргумента.
• required Является ли этот параметр обязательным.
• index Индекс аргумента, если он не определен, аргумент будет добавлен в конец аргументов. Если вы определите один и тот же индекс дважды, первый параметр будет перезаписан.
• choices Список допустимых вариантов для этого аргумента. Если оставлено пустым, все значения допустимы. При встрече недопустимого значения будет возбуждено исключение.

Параметры

Cake\Console\ConsoleInputArgument|string $name

Название аргумента. Также принимает экземпляр ConsoleInputArgument.

array $params optional []

Параметры для аргумента, см. выше.

Возвращает

$this

addArguments()source public

addArguments( array $args )

Добавить сразу несколько аргументов. Принимает массив определений аргументов. Ключи используются как имена аргументов, а значения — как параметры аргумента.

Параметры

array $args

Массив аргументов для добавления.

Возвращает

$this

См. также

\Cake\Console\ConsoleOptionParser::addArgument()

addOption()source public

addOption( Cake\Console\ConsoleInputOption|string $name , array $options [] )

Добавить параметр к парсеру параметров. Параметры позволяют определять необязательные или обязательные параметры для вашего консольного приложения. Параметры определяются используемыми ими параметрами.

Параметры

• short - Однобуквенный вариант этого параметра, оставьте не определённым для отсутствия.
• help - Текст справки для этого параметра. Используется при генерации справки по параметру.
• default - Значение по умолчанию для этого параметра. Значения по умолчанию добавляются в обработанные параметры, когда прикреплённый параметр не указан или не имеет значения. Использование значения по умолчанию и булевого типа вместе не сработает. добавляются в обработанные параметры, когда параметр не определён. По умолчанию null.
• boolean - Параметр не использует значение, это просто булевая переключатель. По умолчанию false. Если параметр определён как булевый, он всегда будет добавлен в обработанные параметры. Если его нет, он будет false, если есть, он будет true.
• multiple - Параметр может быть указан несколько раз. Обработанный параметр будет массивом значений, когда этот параметр включен.
• choices Список допустимых вариантов для этого параметра. Если оставлено пустым, все значения допустимы. При встрече недопустимого значения будет возбуждено исключение.

Параметры

Cake\Console\ConsoleInputOption|string $name

Длинное имя, которое вы хотите, чтобы значение было обработано при обработке параметров. Также принимает экземпляр ConsoleInputOption

array $options optional []

Массив параметров, определяющих поведение параметра

Возвращает

$this

addOptions()source public

addOptions( array $options )

Добавить сразу несколько параметров. Принимает массив определений параметров. Ключи используются как имена параметров, а значения — как параметры параметра.

Параметры

array $options

Массив параметров для добавления.

Возвращает

$this

См. также

\Cake\Console\ConsoleOptionParser::addOption()

addSubcommand()source public

addSubcommand( Cake\Console\ConsoleInputSubcommand|string $name , array $options [] )

Добавить подкоманду к списку подкоманд. Подкоманды обычно являются методами в вашем Shell, но также могут использоваться для документирования задач.

Параметры

• help - Текст справки для подкоманды.
• parser - ConsoleOptionParser для подкоманды. Это позволяет создавать специфичные для метода парсеры параметров. При генерации справки по подкоманде, если парсер присутствует, он будет использоваться.

Параметры

Cake\Console\ConsoleInputSubcommand|string $name

Имя подкоманды. Также принимает экземпляр ConsoleInputSubcommand

array $options optional []

Массив параметров, см. выше.

Возвращает

$this

addSubcommands()source public

addSubcommands( array $commands )

Добавить сразу несколько подкоманд.

Параметры

array $commands

Массив подкоманд.

Возвращает

$this

arguments()source public

arguments( )

Получить аргументы, определённые в парсере.

Возвращает

array
Массив описаний аргументов

buildFromArray()source public static

buildFromArray( array $spec , boolean $defaultOptions true )

Создать парсер из массива. Использует массив, подобный

$spec = [
     'description' => 'text',
     'epilog' => 'text',
     'arguments' => [
         // list of arguments compatible with addArguments.
     ],
     'options' => [
         // list of options compatible with addOptions
     ],
     'subcommands' => [
         // list of subcommands to add.
     ]
];

Параметры

array $spec

Спецификация для создания OptionParser.

boolean $defaultOptions optional true

Нужно ли установить параметры verbose и quiet.

Возвращает

$this

command()source public

command( string|null $text null )

Получает или задаёт имя команды для командной оболочки/задачи.

Параметры

string|null $text необязательно null

Текст для задания или null, если нужно прочитать

Возвращает

string|Cake\Console\ConsoleOptionParser
$this Если чтение, значение команды. Если установка, будет возвращён $this

create()source public static

create( string|null $command , boolean $defaultOptions true )

Статический фабричный метод для создания новых парсеров опций, позволяющий цепочку вызовов методов.

Параметры

string|null $command

Имя команды, для которой предназначен этот парсер. Имя команды используется для генерации справки.

boolean $defaultOptions необязательно true

Указывает, нужно ли устанавливать опции verbose и quiet.

Возвращает

$this

description()source public

description( string|array|null $text null )

Получение или установка текстового описания для командной оболочки/задачи.

Параметры

string|array|null $text необязательно null

Текст для установки или null, если нужно прочитать. Если массив, текст будет объединён с помощью "\n".

Возвращает

string|Cake\Console\ConsoleOptionParser
$this Если чтение, значение описания. Если установка, будет возвращён $this

epilog()source public

epilog( string|array|null $text null )

Получение или установка эпилога парсера. Эпилог добавляется в конец списка опций и аргументов при генерации справки.

Параметры

string|array|null $text необязательно null

Текст при установке или null при чтении. Если массив, текст будет объединён с помощью "\n".

Возвращает

string|Cake\Console\ConsoleOptionParser
$this Если чтение, значение эпилога. Если установка, будет возвращён $this

help()source public

help( string|null $subcommand null , string $format 'text' , integer $width 72 )

Получает отформатированную справку для этого объекта парсера. Генерирует текст справки на основе описания, опций, аргументов, подкоманд и эпилога в парсере.

Параметры

string|null $subcommand необязательно null

Если задано и является действительной подкомандой, имеющей связанный парсер. Будет показана справка по подкоманде вместо справки по парсеру.

string $format необязательно 'text'

Определяет формат вывода, может быть text или xml

integer $width необязательно 72

Ширина для форматирования пользовательского контента. По умолчанию 72

Возвращает

string
Сгенерированная справка.

merge()source public

merge( array|Cake\Console\ConsoleOptionParser $spec )

Получение или установка имени команды для командной оболочки/задачи.

Параметры

array|Cake\Console\ConsoleOptionParser $spec

ConsoleOptionParser или спецификация для слияния.

Возвращает

$this

options()source public

options( )

Получение определённых опций в парсере.

Возвращает

array

parse()source public

parse( array $argv )

Разбор массива argv в набор параметров и аргументов. Если $command не null и $command равен подкоманде, имеющей парсер, будет использован этот парсер для разбора $argv.

Параметры

array $argv

Массив аргументов (argv) для разбора.

Возвращает

array
[$params, $args]

Выбрасывает

Cake\Console\Exception\ConsoleException
При обнаружении недопустимого параметра.

removeOption()source public

removeOption( string $name )

Удаление опции из парсера опций.

Параметры

string $name

Имя опции для удаления.

Возвращает

$this

removeSubcommand()source public

removeSubcommand( string $name )

Удаление подкоманды из парсера опций.

Параметры

string $name

Имя подкоманды для удаления.

Возвращает

$this

subcommands()source public

subcommands( )

Получение массива определённых подкоманд

Возвращает

array

toArray()source public

toArray( )

Возвращает массив, представляющий этот парсер.

Возвращает

array

[]

''

null

null

[]

[]

[]

[]