Класс ConsoleOptionParser

__construct()source public

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

Создание OptionParser для определения его поведения

Параметры

строка $command необязательно null

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

логическое значение $defaultOptions необязательно true

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

_nextToken()source protected

_nextToken( )

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

Возвращает

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

_optionExists()source protected

_optionExists( string $name )

Проверка наличия опции (короткой/длинной) для $name.

Параметры

строка $name

Имя опции.

Возвращает

логическое значение

_parseArg()source protected

_parseArg( string $argument , array $args )

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

Параметры

строка $argument

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

массив $args

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

Возвращает

массив
Аргументы

Исключения

ConsoleException

_parseLongOption()source protected

_parseLongOption( string $option , array $params )

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

Параметры

строка $option

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

массив $params

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

Возвращает

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

_parseOption()source protected

_parseOption( string $name , array $params )

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

Параметры

строка $name

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

массив $params

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

Возвращает

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

Исключения

ConsoleException

_parseShortOption()source protected

_parseShortOption( string $option , array $params )

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

Параметры

строка $option

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

массив $params

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

Возвращает

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

Исключения

ConsoleException
При встрече неизвестных коротких параметров.

addArgument()source public

addArgument( ConsoleInputArgument|string $name , array $params array() )

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

Параметры

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

Параметры

ConsoleInputArgument|строка $name

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

массив $params необязательно массив()

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

Возвращает

ConsoleOptionParser

addArguments()source public

addArguments( array $args )

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

Параметры

массив $args

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

Возвращает

ConsoleOptionParser

См. также

ConsoleOptionParser::addArgument()

addOption()source public

addOption( ConsoleInputOption|string $name , array $options array() )

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

Параметры

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

Параметры

ConsoleInputOption|строка $name

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

массив $options необязательно массив()

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

Возвращает

ConsoleOptionParser

addOptions()source public

addOptions( array $options )

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

Параметры

массив $options

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

Возвращает

ConsoleOptionParser

См. также

ConsoleOptionParser::addOption()

addSubcommand()source public

addSubcommand( ConsoleInputSubcommand|string $name , array $options array() )

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

Параметры

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

Параметры

ConsoleInputSubcommand|строка $name

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

массив $options необязательно массив()

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

Возвращает

ConsoleOptionParser

addSubcommands()source public

addSubcommands( array $commands )

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

Параметры

массив $commands

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

Возвращает

ConsoleOptionParser

arguments()source public

arguments( )

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

Возвращает

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

buildFromArray()source public static

buildFromArray( array $spec )

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

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

Параметры

массив $spec

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

Возвращает

ConsoleOptionParser

command()source public

command( string $text null )

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

Параметры

строка $text необязательно null

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

Возвращает

строка|ConsoleOptionParser
Если считывается, значение команды. Если устанавливается, возвращается $this.

create()source public static

create( string $command , boolean $defaultOptions true )

Статический фабричный метод для создания новых OptionParser, чтобы вы могли вызывать методы из них.

Параметры

строка $command

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

логическое значение $defaultOptions необязательно true

Требуется ли установка параметров verbose и quiet.

Возвращает

ConsoleOptionParser

description()source public

description( string|array $text null )

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

Параметры

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

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

Возвращает

string|ConsoleOptionParser
При чтении, значение описания. При установке возвращается $this.

epilog()source public

epilog( string|array $text null )

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

Параметры

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

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

Возвращает

string|ConsoleOptionParser
При чтении, значение эпилога. При установке возвращается $this.

help()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

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

options()source public

options( )

Получить определённые опции в анализаторе.

Возвращает

array

parse()source public

parse( array $argv , string $command null )

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

Параметры

array $argv

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

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

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

Возвращает

array
Массив ($params, $args)

Выбрасывает

ConsoleException
При встрече недопустимого параметра.

removeSubcommand()source public

removeSubcommand( string $name )

Удалить подкоманду из анализатора опций.

Параметры

string $name

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

Возвращает

ConsoleOptionParser

subcommands()source public

subcommands( )

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

Возвращает

array

array()

''

null

null

array()

array()

array()