Класс VersionCommand

Вывести версию CakePHP, используемую в данный момент.

Пространство имён: 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

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

string|null

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

string

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

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

__construct() public

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

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

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

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

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

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

Вывести версию CakePHP, используемую в данный момент.
executeCommand() public

Выполнение другой команды с заданными аргументами.
getModelType() public

Получение типа модели, используемой этим классом.
getName() public

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

Получение парсера опций.
getRootName() public

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

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

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

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

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

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

Запуск команды.
setModelType() public

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

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

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

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

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct()

Конструктор

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

_setModelClass() protected

_setModelClass(string $name): void

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

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

Параметры

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

Возвращает

void

abort() public

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

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

Параметры

int $code необязательно: Код завершения.

Возвращает

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

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

Выводит версию CakePHP.

Параметры

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 необязательно: Аргументы для вызова команды.
Cake\Console\ConsoleIo $io необязательно: Экземпляр ConsoleIo для использования с исполняемой командой.

Возвращает

int|null

getModelType() public

getModelType(): string

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

Возвращает

string

getName() public

getName(): string

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

Возвращает

string

getOptionParser() public

getOptionParser(): Cake\Console\ConsoleOptionParser

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

Вы можете переопределить buildOptionParser() для определения ваших опций и аргументов.

Возвращает

Cake\Console\ConsoleOptionParser

Использует

RuntimeException
При некорректном парсере

getRootName() public

getRootName(): string

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

Возвращает

string

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 по мере необходимости. Также может использоваться для загрузки других типов объектов репозитория, используемых вашим приложением.

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

Параметры

string|null $modelClass необязательно: Имя класса модели для загрузки. По умолчанию $this->modelClass. Имя может быть псевдонимом, как 'Post', или FQCN, как App\Model\Table\PostsTable::class.
string|null $modelType необязательно: Тип репозитория для загрузки. По умолчанию значение 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 необязательно: Уровень ошибки.
string|array $context необязательно: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

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

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

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

`$_modelFactories` protected

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

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

`$_modelType` protected

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

Тип

string

`$_tableLocator` protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

`$modelClass` protected

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

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

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

Тип

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.VersionCommand.html