Класс 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.8/class-Cake.Console.Arguments.html