Spec-Zone.ru › CakePHP 4.4

Класс BaseCommand

Базовый класс для команд консоли.

Предоставляет хуки для общих функций команд:

  • initialize Выступает в качестве хука после построения.
  • buildOptionParser Создайте/настройте парсер опций для вашей команды.
  • execute Выполните вашу команду с распарсенными аргументами и ConsoleIo
Абстрактный
Пространство имен: Cake\Console

Константы

  • int
    CODE_ERROR 
    1

    Код ошибки по умолчанию

  • int
    CODE_SUCCESS 
    0

    Код успеха по умолчанию

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

  • $name protected
    string

    Имя этой команды.

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

  • abort() public

    Прекратить текущий процесс с исключением StopException.

  • buildOptionParser() protected

    Метод-обработчик для определения парсера опций для этой команды.

  • defaultName() public static

    Получить имя команды.

  • displayHelp() protected

    Вывести содержимое справки

  • execute() abstract public

    Реализуйте этот метод с логикой вашей команды.

  • executeCommand() public

    Выполнить другую команду с предоставленным набором аргументов.

  • getDescription() public static

    Получить описание команды.

  • getName() public

    Получить имя команды.

  • getOptionParser() public

    Получить парсер опций.

  • getRootName() public

    Получить имя корневой команды.

  • initialize() public

    Метод-обработчик, вызываемый CakePHP перед выполнением команды.

  • run() public

    Запустить команду.

  • setName() public

    Установить имя этой команды в коллекции.

  • setOutputLevel() protected

    Установить уровень вывода на основе аргументов.

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

abort() public 

abort(int $code = self::CODE_ERROR): void

Прекратить текущий процесс с исключением StopException.

Параметры

int $code optional

Код завершения, который необходимо использовать.

Возвращаемое значение

void

Исключения

Cake\Console\Exception\StopException

buildOptionParser() protected 

buildOptionParser(Cake\Console\ConsoleOptionParser $parser): Cake\Console\ConsoleOptionParser

Метод-обработчик для определения парсера опций для этой команды.

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер для определения

Возвращаемое значение

Cake\Console\ConsoleOptionParser

defaultName() public static 

defaultName(): string

Получить имя команды.

Возвращает имя команды на основе имени класса. Например, для команды с именем класса UpdateTableCommand возвращаемое значение по умолчанию будет 'update_table'.

Возвращаемое значение

string

displayHelp() protected 

displayHelp(Cake\Console\ConsoleOptionParser $parser, Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Вывести содержимое справки

Параметры

Cake\Console\ConsoleOptionParser $parser

Парсер опций.

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

Возвращаемое значение

void

execute() abstract public 

execute(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int|null|void

Реализуйте этот метод с логикой вашей команды.

Параметры

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

Возвращаемое значение

int|null|void

executeCommand() public 

executeCommand(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

Выполнить другую команду с предоставленным набором аргументов.

Если вы используете строку с именем команды, зависимости этой команды не будут разрешены с помощью контейнера приложения. Вместо этого вам необходимо передать команду в виде объекта со всеми её зависимостями.

Параметры

Cake\Console\CommandInterface|string $command

Имя класса команды или экземпляр команды.

array $args optional

Аргументы для вызова команды.

Cake\Console\ConsoleIo|null $io optional

Экземпляр ConsoleIo, который следует использовать для выполняемой команды.

Возвращаемое значение

int|null

getDescription() public static 

getDescription(): string

Получить описание команды.

Возвращаемое значение

string

getName() public 

getName(): string

Получить имя команды.

Возвращаемое значение

string

getOptionParser() public 

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить парсер опций.

Вы можете переопределить buildOptionParser(), чтобы определить свои опции и аргументы.

Возвращаемое значение

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При невалидности парсера

getRootName() public 

getRootName(): string

Получить имя корневой команды.

Возвращаемое значение

string

initialize() public 

initialize(): void

Метод-обработчик, вызываемый CakePHP перед выполнением команды.

Переопределите этот метод и реализуйте дорогостоящие/важные шаги настройки, которые не должны выполняться при каждом запуске команды. Этот метод будет вызван *перед* валидацией и обработкой опций и аргументов.

Возвращаемое значение

void

run() public 

run(array $argv, Cake\Console\ConsoleIo $io): int|null

Запустить команду.

Параметры

array $argv
Cake\Console\ConsoleIo $io

Возвращаемое значение

int|null

setName() public 

setName(string $name): $this

Установить имя этой команды в коллекции.

Обычно вызывается коллекцией команд при добавлении команды. Требуется иметь хотя бы один пробел в имени, чтобы можно было вычислить корневую команду.

Параметры

string $name

Возвращаемое значение

$this

setOutputLevel() protected 

setOutputLevel(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): void

Установить уровень вывода на основе аргументов.

Параметры

Cake\Console\Arguments $args

Аргументы команды.

Cake\Console\ConsoleIo $io

Ввод-вывод консоли

Возвращаемое значение

void

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

$name protected

Имя этой команды.

Тип

string

© 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.4/class-Cake.Console.BaseCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API