Класс Arguments

Предоставляет интерфейс для взаимодействия с опциями и аргументами команды.

Пространство имён: Cake\Console
Расположение: Console/Arguments.php

Краткое описание свойств

$argNames protected

string[]
Карта имен позиционных аргументов
$args protected

string[]
Позиционные аргументы.
$options protected

array
Именованные опции

Краткое описание методов

__construct() public
Конструктор
getArgument() public
Проверка наличия позиционного аргумента по имени
getArgumentAt() public
Получение позиционных аргументов по индексу.
getArguments() public
Получение всех позиционных аргументов.
getOption() public
Получение значения опции или null
getOptions() public
Получение массива всех опций
hasArgument() public
Проверка наличия позиционного аргумента по имени
hasArgumentAt() public
Проверка наличия позиционного аргумента
hasOption() public
Проверка, определена ли опция и не равна ли null.

Подробное описание методов

__construct()source public

__construct( array $args , array $options , array $argNames )

Конструктор

Параметры

массив $args: Позиционные аргументы
массив $options: Именованные аргументы
массив $argNames: Список имён аргументов. Порядок должен совпадать с $args.

getArgument()source public

getArgument( string $name )

Проверка наличия позиционного аргумента по имени

Параметры

строка $name: Имя аргумента для проверки.

Возвращает

строка|null

getArgumentAt()source public

getArgumentAt( integer $index )

Получение позиционных аргументов по индексу.

Параметры

целое число $index: Индекс аргумента для доступа.

Возвращает

строка|null
Значение аргумента или null

getArguments()source public

getArguments( )

Получение всех позиционных аргументов.

Возвращает

массив строк

getOption()source public

getOption( string $name )

Получение значения опции или null

Параметры

строка $name: Имя опции для проверки.

Возвращает

строка|целое число|логическое значение|null
Значение опции или null.

getOptions()source public

getOptions( )

Получение массива всех опций

Возвращает

массив

hasArgument()source public

hasArgument( string $name )

Проверка наличия позиционного аргумента по имени

Параметры

строка $name: Имя аргумента для проверки.

Возвращает

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

hasArgumentAt()source public

hasArgumentAt( integer $index )

Проверка наличия позиционного аргумента

Параметры

целое число $index: Индекс аргумента для проверки.

Возвращает

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

hasOption()source public

hasOption( string $name )

Проверка, определена ли опция и не равна ли null.

Параметры

строка $name: Имя опции для проверки.

Возвращает

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

Подробное описание свойств

$argNamessource

protected массив строк

Карта имен позиционных аргументов

$argssource

protected массив строк

Позиционные аргументы.

$optionssource

protected массив

Именованные опции

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.6/class-Cake.Console.Arguments.html