Класс CommandTask
Базовый класс для отражения команд командной строки.
Константы
-
intCODE_ERROR1
Код ошибки по умолчанию
-
intCODE_SUCCESS0
Код успеха по умолчанию
-
intNORMALConsoleIo::NORMAL
Константа вывода для создания обычных оболочек.
-
intQUIETConsoleIo::QUIET
Константы вывода для создания тихих оболочек.
-
intVERBOSEConsoleIo::VERBOSE
Константа вывода для создания подробных оболочек.
Краткое описание свойств
- $OptionParser public
Cake\Console\ConsoleOptionParserЭкземпляр ConsoleOptionParser, настроенный для этого класса.
- $Tasks public
Cake\Console\TaskRegistryКоллекция задач для команды, используемая для создания задач.
- $_io protected
Cake\Console\ConsoleIoЭкземпляр ConsoleIo.
- $_modelFactories protected
array<callableCake\Datasource\Locator\LocatorInterface>Список переопределенных функций фабрики моделей.
- $_modelType protected
stringТип модели для использования.
- $_tableLocator protected
Cake\ORM\Locator\LocatorInterface|nullЭкземпляр локатора таблиц
- $_taskMap protected
array<string, array>Нормализованная карта задач.
- $args public
arrayСодержит аргументы, проанализированные из командной строки.
- $command public
string|nullКоманда (метод/задача), которая выполняется.
- $defaultTable protected
string|nullПсевдоним по умолчанию таблицы этого объекта.
- $interactive public
boolЕсли true, скрипт запросит разрешение на выполнение действий.
- $modelClass protected deprecated
string|nullОсновное имя класса модели этого объекта. Должно быть в множественном числе. CakePHP не будет изменять имя.
- $name public
stringИмя оболочки в camelCase.
- $params public
arrayСодержит параметры команд, проанализированные из командной строки.
- $plugin public
stringИмя плагина, к которому принадлежит оболочка. Автоматически устанавливается ShellDispatcher при создании оболочки.
- $rootName protected
stringКорневое имя команды, используемое при генерации вывода справки.
- $taskNames public
array<string>Содержит загруженные задачи
- $tasks public
array|boolСодержит задачи для загрузки и инициализации
Краткое описание методов
-
__construct() public
Создаёт экземпляр Shell.
-
__debugInfo() public
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
-
__get() public
Перегрузка get для ленивого создания задач
-
_appendShells() protected
Сканирует указанные пути для оболочек и добавляет их в $shellList
-
_displayHelp() protected
Отображает справку в правильном формате
-
_findShells() protected
Находит оболочки в $path и добавляет их в $shellList
-
_mergeProperty() protected
Объединяет одно свойство со значениями, объявленными во всех родительских классах.
-
_mergePropertyData() protected
Объединяет каждый из ключей в свойстве вместе.
-
_mergeVars() protected
Объединяет список $properties со всеми родительскими классами текущего класса.
-
_scanDir() protected
Сканирует директорию на наличие файлов .php и возвращает имена классов, которые должны быть в них.
-
_setModelClass() protected
Устанавливает свойство modelClass на основе соглашений.
-
_setOutputLevel() protected
Устанавливает уровень вывода на основе параметров.
-
_stop() protected
Останавливает выполнение текущего скрипта. Вызывает StopException для остановки выполнения.
-
_validateTasks() protected
Проверяет, что задачи в карте задач действительно доступны
-
_welcome() protected
Отображает заголовок для оболочки
-
abort() public
Отображает отформатированное сообщение об ошибке и завершает приложение с кодом ошибки.
-
clear() public
Очистить консоль
-
createFile() public
Создаёт файл по заданному пути
-
dispatchShell() public
Перенаправляет команду в другую оболочку. Аналогично Object::requestAction(), но предназначено для запуска оболочек из других оболочек.
-
err() public
Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не переданы, выводит только символ новой строки.
-
fetchTable() public
Удобный метод для получения экземпляра таблицы.
-
getIo() public
Получить объект io для этой оболочки.
-
getModelType() public
Получить тип модели, который будет использоваться этим классом
-
getOptionParser() public
Получает экземпляр парсера опций и настраивает его.
-
getShellList() public
Получить список команд оболочки.
-
getTableLocator() public
Получить локатор таблицы.
-
hasMethod() public
Проверить, есть ли у этой оболочки вызываемый метод с заданным именем.
-
hasTask() public
Проверить, есть ли у этой оболочки задача с заданным именем.
-
helper() public
Отобразить помощника консоли
-
hr() public
Выводит ряд символов минус в стандартный вывод, служит разделителем.
-
in() public
Запрашивает у пользователя ввод и возвращает его.
-
info() public
Удобный метод для out(), который оборачивает сообщение тегами
-
initialize() public
Инициализирует оболочку, выступает в роли конструктора для подклассов, позволяет настроить задачи до запуска оболочки.
-
loadModel() public deprecated
Загружает и создаёт объекты репозитория, необходимые этому объекту
-
loadTasks() public
Загружает задачи, определённые в public $tasks
-
log() public
Удобный метод для записи сообщения в журнал. См. Log::write() для получения дополнительной информации о записи в журналы.
-
main() public @method
Основной метод входа для оболочки.
-
modelFactory() public
Переопределить существующую вызываемую функцию для генерации репозиториев заданного типа.
-
nl() public
Возвращает последовательность из одной или нескольких символов новой строки.
-
out() public
Выводит одно или несколько сообщений в stdout. Если параметры не переданы, выводит только символ новой строки.
-
param() public
Безопасно получить значения из $this->params.
-
parseDispatchArguments() public
Парсит аргументы для метода dispatchShell().
-
quiet() public
Вывод на всех уровнях.
-
runCommand() public
Запускает оболочку с предоставленным argv.
-
setIo() public
Установить объект io для этой оболочки.
-
setModelType() public
Установить тип модели, который будет использоваться этим классом
-
setRootName() public
Установить имя корневой команды для вывода справки.
-
setTableLocator() public
Устанавливает локатор таблицы.
-
shortPath() public
Делает абсолютный путь к файлу более читабельным
-
startup() public
Запускает Shell и отображает приветственное сообщение. Позволяет проверить и настроить параметры перед выполнением команды или основной программы.
-
success() public
Удобный метод для out(), который оборачивает сообщение тегами .
-
verbose() public
Вывод на уровне подробности.
-
warn() public
Удобный метод для err(), который оборачивает сообщение тегами .
-
wrapText() public
Обернуть блок текста. Позволяет установить ширину и отступы в блоке текста.
Подробное описание методов
__construct() public
__construct(Cake\Console\ConsoleIo|null $io = null, Cake\ORM\Locator\LocatorInterface|null $locator = null)
Создает этот экземпляр Shell.
Параметры
-
Cake\Console\ConsoleIo|null$io optional Экземпляр io.
-
Cake\ORM\Locator\LocatorInterface|null$locator optional Экземпляр локатора таблиц.
Ссылки
__debugInfo() public
__debugInfo(): array<string, mixed>
Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
Возвращает
array<string, mixed>__get() public
__get(string $name): Cake\Console\Shell
Перегрузка get для ленивого построения задач
Параметры
-
string$name Задача для получения.
Возвращает
Cake\Console\Shell_appendShells() protected
_appendShells(string $type, array<string> $shells, array<string, mixed> $shellList, array<string> $skip): array<string, mixed>
Сканирует указанные пути на наличие шеллов и добавляет их в $shellList
Параметры
-
string$type Тип объекта.
-
array<string>$shells Имена шеллов.
-
array<string, mixed>$shellList Список шеллов.
-
array<string>$skip Список имен команд, которые нужно пропустить.
Возвращает
array<string, mixed>_displayHelp() protected
_displayHelp(string|null $command = null): int|null
Отображает справку в правильном формате
Параметры
-
string|null$command optional Команда, для которой нужно получить справку.
Возвращает
int|null_findShells() protected
_findShells(array<string, mixed> $shellList, string $path, string $key, array<string> $skip): array<string, mixed>
Находит шеллы в $path и добавляет их в $shellList
Параметры
-
array<string, mixed>$shellList Массив списка шеллов.
-
string$path Путь для поиска.
-
string$key Ключ для добавления шеллов
-
array<string>$skip Список команд для исключения.
Возвращает
array<string, mixed>_mergeProperty() protected
_mergeProperty(string $property, array<string> $parentClasses, array<string, mixed> $options): void
Объединяет одно свойство со значениями, объявленными во всех родительских классах.
Параметры
-
string$property Имя объединяемого свойства.
-
array<string>$parentClasses Массив классов, с которыми нужно объединить.
-
array<string, mixed>$options Параметры для объединения свойства, см. _mergeVars()
Возвращает
void_mergePropertyData() protected
_mergePropertyData(array $current, array $parent, bool $isAssoc): array
Объединяет каждый из ключей в свойстве.
Параметры
-
array$current Текущее объединенное значение.
-
array$parent Значение родительского класса.
-
bool$isAssoc Следует ли выполнять слияние в ассоциативном режиме.
Возвращает
array_mergeVars() protected
_mergeVars(array<string> $properties, array<string, mixed> $options = []): void
Объединяет список $properties со всеми родительскими классами текущего класса.
Параметры:
-
associative- Список свойств, которые должны обрабатываться как ассоциативные массивы. Свойства в этом списке будут переданы через Hash::normalize() перед слиянием.
Параметры
-
array<string>$properties Массив свойств и стратегия их слияния.
-
array<string, mixed>$options optional Параметры, используемые при объединении свойств.
Возвращает
void_scanDir() protected
_scanDir(string $dir): array<string>
Сканирует директорию на наличие файлов .php и возвращает имена классов, которые должны находиться внутри них.
Параметры
-
string$dir Директория для чтения.
Возвращает
array<string>_setModelClass() protected
_setModelClass(string $name): void
Устанавливает свойство modelClass на основе соглашений.
Если свойство уже установлено, оно не будет перезаписано
Параметры
-
string$name Имя класса.
Возвращает
void_setOutputLevel() protected
_setOutputLevel(): void
Устанавливает уровень вывода на основе параметров.
Это перенастраивает как уровень вывода для out(), так и настроенное журналирование stdout/stderr
Возвращает
void_stop() protected
_stop(int $status = self::CODE_SUCCESS): void
Остановить выполнение текущего скрипта. Поднимает исключение StopException, чтобы попытаться остановить выполнение.
Параметры
-
int$status optional см. https://secure.php.net/exit для значений
Возвращает
voidВызывает исключение
Cake\Console\Exception\StopException_validateTasks() protected
_validateTasks(): void
Проверяет, действительно ли доступны задачи в карте задач
Возвращает
voidВызывает исключение
RuntimeException_welcome() protected
_welcome(): void
Отображает заголовок для шелла
Возвращает
voidabort() public
abort(string $message, int $exitCode = self::CODE_ERROR): void
Отображает отформатированное сообщение об ошибке и завершает работу приложения с кодом ошибки.
Параметры
-
string$message Сообщение об ошибке
-
int$exitCode optional Код выхода для задачи шелла.
Возвращает
voidВызывает исключение
Cake\Console\Exception\StopExceptionСсылки
clear() public
clear(): void
Очистить консоль
Возвращает
voidСсылки
createFile() public
createFile(string $path, string $contents): bool
Создает файл по указанному пути
Параметры
-
string$path Куда поместить файл.
-
string$contents Содержимое для размещения в файле.
Возвращает
boolСсылки
dispatchShell() public
dispatchShell(): int
Отправить команду в другой Shell. Аналогично Object::requestAction(), но предназначено для запуска оболочек из других оболочек.
Использование:
С текстовой командой:
return $this->dispatchShell('schema create DbAcl'); Избегайте использования этого формата, если у вас есть строковые аргументы с пробелами в них. Отправленная команда будет вызвана неправильно. Используйте этот формат только для простого управления отправкой команд.
С массивом команд:
return $this->dispatchShell('schema', 'create', 'i18n', '--dry'); С массивом, содержащим две пары ключ/значение:
-
commandможет принимать строку или массив. Представляет команду для отправки-
extraможет принимать массив дополнительных параметров для передачи диспетчеру. Эти параметры будут доступны в свойствеparamвызываемогоShell
-
return $this->dispatchShell([ 'command' => 'schema create DbAcl', 'extra' => ['param' => 'value'] ]);
или
return $this->dispatchShell([ 'command' => ['schema', 'create', 'DbAcl'], 'extra' => ['param' => 'value'] ]);
Возвращает
intСсылки
err() public
err(array<string>|string $message, int $newlines = 1): int
Выводит одно или несколько сообщений об ошибках в stderr. Если параметры не переданы, выводит просто символ новой строки.
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Количество символов новой строки для добавления
Возвращает
intfetchTable() public
fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table
Удобный метод для получения экземпляра таблицы.
Параметры
-
string|null$alias optional Имя псевдонима, которое вы хотите получить. Должно быть в формате CamelCase. Если
nullиспользуется значение свойства $defaultTable.-
array<string, mixed>$options optional Параметры, которые вы хотите использовать для построения таблицы. Если таблица уже загружена, параметры реестра будут проигнорированы.
Возвращает
Cake\ORM\TableИсключения
Cake\Core\Exception\CakeExceptionЕсли аргумент `$alias` и свойство `$defaultTable` оба равны `null`.
См. также
getIo() public
getIo(): Cake\Console\ConsoleIo
Получить объект io для этой оболочки.
Возвращает
Cake\Console\ConsoleIogetModelType() public
getModelType(): string
Получить тип модели, который будет использоваться этим классом
Возвращает
stringgetOptionParser() public
getOptionParser(): Cake\Console\ConsoleOptionParser
Получает экземпляр анализатора параметров и настраивает его.
Переопределяя этот метод, вы можете настроить ConsoleOptionParser перед его возвращением.
Возвращает
Cake\Console\ConsoleOptionParserСсылки
getShellList() public
getShellList(): array
Получает список команд оболочки.
Возвращает
arraygetTableLocator() public
getTableLocator(): Cake\ORM\Locator\LocatorInterface
Получает локатор таблиц.
Возвращает
Cake\ORM\Locator\LocatorInterfacehasMethod() public
hasMethod(string $name): bool
Проверяет, имеет ли эта оболочка вызываемый метод с указанным именем.
Параметры
-
string$name Имя метода для проверки.
Возвращает
boolСсылки
hasTask() public
hasTask(string $task): bool
Проверяет, содержит ли эта оболочка задачу с указанным именем.
Параметры
-
string$task Имя задачи для проверки.
Возвращает
boolСсылки
helper() public
helper(string $name, array<string, mixed> $config = []): Cake\Console\Helper
Отображение помощника Console
Создайте и отобразите вывод для объекта помощника. Если объект помощника еще не загружен, он будет загружен и создан.
Параметры
-
string$name Имя помощника для отображения
-
array<string, mixed>$config optional Данные конфигурации для помощника.
Возвращает
Cake\Console\Helperhr() public
hr(int $newlines = 0, int $width = 63): void
Выводит ряд символов минус в стандартный вывод, служит визуальным разделителем.
Параметры
-
int$newlines optional Количество символов новой строки для предварительного и последующего добавления
-
int$width optional Ширина линии, по умолчанию 63
Возвращает
voidСсылки
in() public
in(string $prompt, array<string>|string|null $options = null, string|null $default = null): string|null
Запрашивает у пользователя ввод и возвращает его.
Параметры
-
string$prompt Текст приглашения.
-
array<string>|string|null$options optional Массив или строка вариантов.
-
string|null$default optional Значение ввода по умолчанию.
Возвращает
string|nullСсылки
info() public
info(array<string>|string $message, int $newlines = 1, int $level = Shell::NORMAL): int|null
Удобный метод для out(), который оборачивает сообщение тегами
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Количество символов новой строки для добавления
-
int$level optional Уровень вывода сообщения, см. выше.
Возвращает
int|nullСм. также
initialize() public
initialize(): void
Инициализирует оболочку, действует как конструктор для подклассов, позволяет настроить задачи перед выполнением оболочки
Возвращает
voidСсылки
loadModel() public
loadModel(string|null $modelClass = null, string|null $modelType = null): Cake\Datasource\RepositoryInterface
Загружает и создает объекты репозитория, необходимые этому объекту
Обычно используется для загрузки объектов таблиц ORM по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, которые использует ваше приложение.
Если поставщик репозитория не возвращает объект, будет выброшено исключение 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 пустое.
loadTasks() public
loadTasks(): true
Загружает задачи, определенные в public $tasks
Возвращает
truelog() public
log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool
Удобный метод для записи сообщения в журнал. Для получения дополнительной информации о записи в журналы, см. Log::write().
Параметры
-
string$message Сообщение журнала.
-
string|int$level optional Уровень ошибки.
-
array|string$context optional Дополнительные данные журнала, относящиеся к этому сообщению.
Возвращает
boolmain() public @method
main(mixed ...$args): int|bool|null|void
Основной метод входа для оболочки.
Параметры
- ...$args
Возвращает
int|bool|null|voidmodelFactory() public
modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void
Переопределить существующее вызываемое значение для генерации репозиториев заданного типа.
Параметры
-
string$type Имя типа репозитория, для которого предназначена функция-фабрика.
-
Cake\Datasource\Locator\LocatorInterface|callable$factory Функция-фабрика, используемая для создания экземпляров.
Возвращает
voidnl() public
nl(int $multiplier = 1): string
Возвращает одну или несколько последовательностей символов новой строки.
Параметры
-
int$multiplier optional Число повторений последовательности новой строки.
Возвращает
stringСсылки
out() public
out(array<string>|string $message, int $newlines = 1, int $level = Shell::NORMAL): int|null
Выводит одно или несколько сообщений в стандартный вывод. Если параметры не переданы, выводит только символ новой строки.
Уровни вывода
Существует 3 встроенных уровня вывода. Shell::QUIET, Shell::NORMAL, Shell::VERBOSE. Уровни вывода verbose и quiet соответствуют параметрам вывода verbose и quiet в большинстве оболочек. Использование Shell::QUIET для сообщения означает, что оно всегда будет отображаться. Использование Shell::VERBOSE означает, что оно будет отображаться только при включенном подробном выводе.
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Число добавляемых символов новой строки
-
int$level optional Уровень вывода сообщения, см. выше.
Возвращает
int|nullСсылки
param() public
param(string $name): string|bool|null
Безопасный доступ к значениям в $this->params.
Параметры
-
string$name Имя параметра для получения.
Возвращает
string|bool|nullparseDispatchArguments() public
parseDispatchArguments(array $args): array
Парсит аргументы для метода dispatchShell().
Параметры
-
array$args Аргументы, полученные из метода dispatchShell() с помощью func_get_args()
Возвращает
arrayquiet() public
quiet(array<string>|string $message, int $newlines = 1): int|null
Вывод на всех уровнях.
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Число добавляемых символов новой строки
Возвращает
int|nullrunCommand() public
runCommand(array $argv, bool $autoMethod = false, array $extra = []): int|bool|null
Выполняет оболочку с предоставленным argv.
Делегирует вызовы задачам и разрешает методы внутри класса. Команды ищутся в следующем порядке:
- Метод в оболочке.
- Соответствующее имя задачи.
-
main()метод.
Если оболочка реализует метод main(), все отсутствующие вызовы методов будут отправлены в main() с исходным именем метода в argv.
Для вызова задач они должны быть представлены как подкоманды. Если вы определяете подкоманды, вы должны определить все подкоманды, которые необходимы вашей оболочке, независимо от того, являются ли они методами этого класса или методами задач.
Параметры
-
array$argv Массив аргументов для запуска оболочки. В этом массиве должно отсутствовать имя оболочки.
-
bool$autoMethod optional Устанавливается в true, чтобы позволить вызывать любой публичный метод, даже если он не был определен как подкоманда. Это используется ShellDispatcher для упрощения создания простых оболочек.
-
array$extra optional Дополнительные параметры, которые можно вручную передать оболочке для обработки. Встроенный дополнительный параметр:
Возвращает
int|bool|nullСсылки
setIo() public
setIo(Cake\Console\ConsoleIo $io): void
Установить объект io для этой оболочки.
Параметры
-
Cake\Console\ConsoleIo$io Объект ConsoleIo для использования.
Возвращает
voidsetModelType() public
setModelType(string $modelType): $this
Установить тип модели, который будет использоваться этим классом
Параметры
-
string$modelType Тип модели
Возвращает
$thissetRootName() public
setRootName(string $name): $this
Установить имя корневой команды для вывода справки.
Параметры
-
string$name Имя корневой команды.
Возвращает
$thissetTableLocator() public
setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this
Устанавливает локатор таблицы.
Параметры
-
Cake\ORM\Locator\LocatorInterface$tableLocator Экземпляр LocatorInterface.
Возвращает
$thisshortPath() public
shortPath(string $file): string
Делает абсолютный путь к файлу более читабельным
Параметры
-
string$file Абсолютный путь к файлу
Возвращает
stringСсылки
startup() public
startup(): void
Запускает оболочку и отображает приветственное сообщение. Позволяет проверять и настраивать перед выполнением команды или основным выполнением
Переопределите этот метод, если хотите удалить приветственную информацию или иным образом изменить предварительный поток команды.
Возвращает
voidСсылки
success() public
success(array<string>|string $message, int $newlines = 1, int $level = Shell::NORMAL): int|null
Удобный метод для out(), который оборачивает сообщение тегами
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Число добавляемых символов новой строки
-
int$level optional Уровень вывода сообщения, см. выше.
Возвращает
int|nullСм. также
verbose() public
verbose(array<string>|string $message, int $newlines = 1): int|null
Вывод на уровне подробности.
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Количество добавляемых новых строк
Возвращает
int|nullwarn() public
warn(array<string>|string $message, int $newlines = 1): int
Метод-обёртка для err(), заключающий сообщение в тег .
Параметры
-
array<string>|string$message Строка или массив строк для вывода
-
int$newlines optional Количество добавляемых новых строк
Возвращает
intСм. также
wrapText() public
wrapText(string $text, array<string, mixed>|int $options = []): string
Обёртка для блока текста. Позволяет задать ширину и отступы для блока текста.
Параметры
-
widthШирина обёртки. По умолчанию 72 -
wordWrapОбёртка только на границах слов (пробелах). По умолчанию true. -
indentОтступ текста с указанной строкой. По умолчанию null.
Параметры
-
string$text Текст для форматирования.
-
array<string, mixed>|int$options optional Массив параметров или целое число для ширины обёртки.
Возвращает
stringСм. также
Ссылки
Подробное описание свойств
$OptionParser public
Экземпляр ConsoleOptionParser, настроенный для данного класса.
Тип
Cake\Console\ConsoleOptionParser$Tasks public
Коллекция задач для команды, используется для создания задач.
Тип
Cake\Console\TaskRegistry$_io protected
Экземпляр ConsoleIo.
Тип
Cake\Console\ConsoleIo$_modelFactories protected
Список переопределённых функций фабрики моделей.
Тип
array<callableCake\Datasource\Locator\LocatorInterface>$_modelType protected
Тип модели для использования.
Тип
string$_tableLocator protected
Экземпляр локатора таблиц.
Тип
Cake\ORM\Locator\LocatorInterface|null$_taskMap protected
Нормализованная карта задач.
Тип
array<string, array>$args public
Содержит аргументы, разобранные из командной строки.
Тип
array$command public
Команда (метод/задача), которая выполняется.
Тип
string|null$defaultTable protected
Alias таблицы по умолчанию для этого объекта.
Тип
string|null$interactive public
Если true, скрипт запросит разрешение на выполнение действий.
Тип
bool$modelClass protected deprecated
Имя основного класса модели для этого объекта. Должно быть во множественном числе. CakePHP не будет склонять имя.
Пример: Для объекта 'Comments', modelClass будет 'Comments'. Плагин классы должны использовать Plugin.Comments стиль имён для правильной загрузки моделей из соответствующего плагина.
Используйте пустую строку, чтобы не использовать автоматическую загрузку для этого объекта. Null автоматически определяет на основе имени контроллера.
Тип
string|null$name public
Имя командной оболочки в camelized формате.
Тип
string$params public
Содержит параметры команд, разобранные из командной строки.
Тип
array$plugin public
Имя плагина, к которому принадлежит оболочка. Автоматически устанавливается ShellDispatcher при создании оболочки.
Тип
string$rootName protected
Корневое имя команды, используемое при генерации вывода справки.
Тип
string$taskNames public
Содержит загруженные задачи.
Тип
array<string>$tasks public
Содержит задачи для загрузки и инициализации.
Тип
array|bool
© 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.Shell.Task.CommandTask.html