Класс Arguments
Обеспечивает интерфейс для взаимодействия с параметрами и аргументами команды.
Краткое описание свойств
Краткое описание методов
-
__construct() public
Конструктор
-
getArgument() public
Проверка наличия позиционного аргумента по имени
-
getArgumentAt() public
Получение позиционных аргументов по индексу.
-
getArguments() public
Получение всех позиционных аргументов.
-
getOption() public
Получение значения параметра или null
-
getOptions() public
Получение массива всех параметров
-
hasArgument() public
Проверка наличия позиционного аргумента по имени
-
hasArgumentAt() public
Проверка наличия позиционного аргумента
-
hasOption() public
Проверка, определён ли параметр и не равен ли null.
Подробное описание методов
__construct() public
__construct(array<int, string> $args, array<string, string|int|bool|null> $options, array<int, string> $argNames)
Конструктор
Параметры
-
array<int, string>$args Позиционные аргументы
-
array<string, string|int|bool|null>$options Именованные аргументы
-
array<int, string>$argNames Список имён аргументов. Порядок должен совпадать с $args.
getArgument() public
getArgument(string $name): string|null
Проверка наличия позиционного аргумента по имени
Параметры
-
string$name Имя аргумента для проверки.
Возвращает
string|nullgetArgumentAt() public
getArgumentAt(int $index): string|null
Получение позиционных аргументов по индексу.
Параметры
-
int$index Индекс аргумента для доступа.
Возвращает
string|nullgetArguments() public
getArguments(): array<int, string>
Получение всех позиционных аргументов.
Возвращает
array<int, string>getOption() public
getOption(string $name): string|int|bool|null
Получение значения параметра или null
Параметры
-
string$name Имя параметра для проверки.
Возвращает
string|int|bool|nullgetOptions() public
getOptions(): array<string, string|int|bool|null>
Получение массива всех параметров
Возвращает
array<string, string|int|bool|null>hasArgument() public
hasArgument(string $name): bool
Проверка наличия позиционного аргумента по имени
Параметры
-
string$name Имя аргумента для проверки.
Возвращает
boolhasArgumentAt() public
hasArgumentAt(int $index): bool
Проверка наличия позиционного аргумента
Параметры
-
int$index Индекс аргумента для проверки.
Возвращает
boolhasOption() public
hasOption(string $name): bool
Проверка, определён ли параметр и не равен ли null.
Параметры
-
string$name Имя параметра для проверки.
Возвращает
boolПодробное описание свойств
$argNames protected
Отображение имен позиционных аргументов
Тип
array<int, string>$args protected
Позиционные аргументы.
Тип
array<int, string>$options protected
Именованные параметры
Тип
array<string, string|int|bool|null>
© 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/4.3/class-Cake.Console.Arguments.html
