Класс CompletionCommand

Предоставление оболочек командного завершения, таких как bash.

Пространство имён: Cake\Command

Константы

int

CODE_ERROR
```
1
```
Код ошибки по умолчанию
int

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

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

$_modelFactories protected

(callableCake\Datasource\Locator\LocatorInterface)[]

Список переопределённых функций фабрики моделей.
$_modelType protected

string

Тип модели для использования.
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локализации таблиц
$commands protected

Cake\Console\CommandCollection
$modelClass protected

string|null

Имя основного класса модели данного объекта. Должен быть во множественном числе. CakePHP не будет склонять имя.
$name protected

string

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

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

__construct() public

Конструктор
_setModelClass() protected

Установка свойства modelClass на основе соглашений.
abort() public

Прекращение текущего процесса с исключением StopException.
buildOptionParser() public

Получение экземпляра анализатора параметров и его конфигурация.
defaultName() public static

Получение имени команды.
displayHelp() protected

Вывод содержимого справки
execute() public

Основная функция Выводит список команд.
executeCommand() public

Выполнение другой команды с заданным набором аргументов.
getCommands() protected

Получение списка определённых команд.
getModelType() public

Получение типа модели, который будет использоваться данным классом
getName() public

Получение имени команды.
getOptionParser() public

Получение анализатора параметров.
getOptions() protected

Получение параметров команды или подкоманды
getRootName() public

Получение имени корневой команды.
getSubcommands() protected

Получение списка определённых подкоманд.
getTableLocator() public

Получение локализации таблиц.
initialize() public

Метод-обработчик, вызываемый CakePHP, когда команда собирается быть выполнена.
loadModel() public

Загрузка и создание объектов репозитория, необходимых для данного объекта
log() public

Удобный метод для записи сообщения в журнал. Для получения дополнительной информации о записи в журналы см. Log::write().
modelFactory() public

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

Выполнение команды.
setCommandCollection() public

Установка коллекции команд, используемых для получения данных о завершении.
setModelType() public

Установка типа модели, который будет использоваться данным классом
setName() public

Установка имени, которое эта команда использует в коллекции.
setOutputLevel() protected

Установка уровня вывода на основе аргументов.
setTableLocator() public

Установка локализации таблиц.
shellSubcommands() protected

Отражение имён подкоманд из оболочки.

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct()

Конструктор

По умолчанию CakePHP создает объекты команд при построении коллекции команд для вашего приложения.

_setModelClass() protected

_setModelClass(string $name): void

Устанавливает свойство modelClass на основе соглашений.

Если свойство уже задано, оно не будет перезаписано

Параметры

string $name: Имя класса.

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

void

abort() public

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

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

Параметры

int $code optional: Код завершения.

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

void

Исключения

Cake\Console\Exception\StopException

buildOptionParser() public

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() public

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

Основная функция Выводит список команд.

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Ввод/вывод консоли

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

int

executeCommand() public

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

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

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

Параметры

stringCake\Console\CommandInterface $command: Имя класса команды или экземпляр команды.
array $args optional: Аргументы для вызова команды.
Cake\Console\ConsoleIo $io optional: Экземпляр ConsoleIo, используемый для выполняемой команды.

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

int|null

getCommands() protected

getCommands(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int

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

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Ввод/вывод консоли

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

int

getModelType() public

getModelType(): string

Получить тип модели, используемый этим классом

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

string

getName() public

getName(): string

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

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

string

getOptionParser() public

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить анализатор опций.

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

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

Cake\Console\ConsoleOptionParser

Исключения

RuntimeException
При невалидном анализаторе

getOptions() protected

getOptions(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int

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

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Ввод/вывод консоли

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

int

getRootName() public

getRootName(): string

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

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

string

getSubcommands() protected

getSubcommands(Cake\Console\Arguments $args, Cake\Console\ConsoleIo $io): int

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

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Ввод/вывод консоли

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

int

getTableLocator() public

getTableLocator(): Cake\ORM\Locator\LocatorInterface

Получить локатор таблиц.

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

Cake\ORM\Locator\LocatorInterface

initialize() public

initialize(): void

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

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

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

void

loadModel() public

loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface

Загружает и строит объекты репозитория, необходимые для этого объекта

Обычно используется для загрузки объектов ORM Table, если они нужны. Также может быть использован для загрузки других типов объектов репозитория, которые использует ваше приложение.

Если поставщик репозитория не возвращает объект, будет выброшено исключение MissingModelException.

Параметры

string|null $modelClass optional: Имя класса модели для загрузки. По умолчанию равно $this->modelClass. Имя может быть псевдонимом, например 'Post' или FQCN, например App\Model\Table\PostsTable::class.
string|null $modelType optional: Тип репозитория для загрузки. По умолчанию соответствует значению getModelType().

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

Cake\Datasource\RepositoryInterface

Исключения

Cake\Datasource\Exception\MissingModelException
Если класс модели не может быть найден.
UnexpectedValueException
Если аргумент $modelClass не предоставлен, а свойство ModelAwareTrait::$modelClass пустое.

log() public

log(string $message, int|string $level = LogLevel::ERROR, string|array $context = []): bool

Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.

Параметры

string $message: Сообщение в журнал.
int|string $level optional: Уровень ошибки.
string|array $context optional: Дополнительные данные журнала, относящиеся к этому сообщению.

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

bool

modelFactory() public

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

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

Параметры

string $type: Имя типа репозитория, для которого предназначена функция-фабрика.
callableCake\Datasource\Locator\LocatorInterface $factory: Функция-фабрика, используемая для создания экземпляров.

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

void

run() public

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

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

Параметры

array $argv
Cake\Console\ConsoleIo $io

Возвращает

int|null

setCommandCollection() public

setCommandCollection(Cake\Console\CommandCollection $commands): void

Установить коллекцию команд, используемых для получения данных завершения.

Параметры

Cake\Console\CommandCollection $commands: Коллекция команд

Возвращает

void

setModelType() public

setModelType(string $modelType): $this

Установить тип модели, который будет использоваться этим классом

Параметры

string $modelType: Тип модели

Возвращает

$this

setName() public

setName(string $name): $this

Установить имя, используемое этой командой в коллекции.

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

Параметры

string $name

Возвращает

$this

setOutputLevel() protected

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

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

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Ввод-вывод консоли

Возвращает

void

setTableLocator() public

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

Устанавливает локатор таблицы.

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator: Экземпляр LocatorInterface.

Возвращает

$this

shellSubcommands() protected

shellSubcommands(Cake\Console\Shell $shell): string[]

Отображает имена подкоманд из оболочки.

Параметры

Cake\Console\Shell $shell: Оболочка, для которой нужно получить команды

Возвращает

string[]

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

`$_modelFactories` protected

Список переопределённых функций фабрики моделей.

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

`$_modelType` protected

Тип используемой модели.

Тип

string

`$_tableLocator` protected

Экземпляр локатора таблицы.

Тип

Cake\ORM\Locator\LocatorInterface|null

`$commands` protected

Тип

Cake\Console\CommandCollection

`$modelClass` protected

Основной класс модели данного объекта. Должен быть в множественном числе. CakePHP не будет склонять имя.

Пример: Для объекта с именем 'Комментарии' modelClass будет 'Комментарии'. Плагиновые классы должны использовать имена в стиле Plugin.Comments для правильной загрузки моделей из соответствующего плагина.

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

Тип

string|null

`$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.2/class-Cake.Command.CompletionCommand.html