Класс ServerCommand

Встроенная команда сервера

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

Константы

int

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

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

DEFAULT_HOST
```
'localhost'
```
Хост сервера по умолчанию
int

DEFAULT_PORT
```
8765
```
Порт прослушивания по умолчанию

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

$_documentRoot protected

string

корень документа
$_host protected

string

хост сервера
$_iniPath protected

string

путь к ini
$_modelFactories protected

(callableCake\Datasource\Locator\LocatorInterface)[]

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

string

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

int

порт прослушивания
$_tableLocator protected

Cake\ORM\Locator\LocatorInterface|null

Экземпляр локализации таблиц
$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

Выполнить другую команду с предоставленным набором аргументов.
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

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

Запускает команду и отображает приветственное сообщение. Позволяет проверять и настраивать перед выполнением команды или основного выполнения.

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 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|null

Выполнить.

Параметры

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

Возвращает

int|null

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

getModelType() public

getModelType(): string

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

Возвращает

string

getName() public

getName(): string

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

Возвращает

string

getOptionParser() public

getOptionParser(): Cake\Console\ConsoleOptionParser

Получить парсер параметров.

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

initialize(): void

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

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

Возвращает

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 пустое.

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

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

startup() protected

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

Запускает команду и отображает приветственное сообщение. Позволяет проверить и настроить параметры перед выполнением команды или основного действия.

Параметры

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

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

void

Ссылки

https://book.cakephp.org/4/en/console-and-shells.html#hook-methods

Основной класс модели этого объекта. Должен быть в множественном числе. 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.ServerCommand.html