Spec-Zone.ru › CakePHP 4.3

Класс 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
    array<callableCake\Datasource\Locator\LocatorInterface>

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

  • $_modelType protected
    string

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

  • $_port protected
    int

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

  • $_tableLocator protected
    Cake\ORM\Locator\LocatorInterface|null

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

  • $defaultTable protected
    string|null

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

  • $modelClass protected deprecated
    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

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

  • fetchTable() public

    Удобный метод для получения экземпляра таблицы.

  • getModelType() public

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

  • getName() public

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

  • getOptionParser() public

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

  • getRootName() public

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

  • getTableLocator() public

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

  • initialize() public

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

  • loadModel() public deprecated

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

  • 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 необязательно

Код завершения.

Возвращает

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(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

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

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

Параметры

Cake\Console\CommandInterface|string $command

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

array $args необязательно

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

Cake\Console\ConsoleIo|null $io необязательно

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

Возвращает

int|null

fetchTable() public 

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Удобный метод для получения экземпляра таблицы.

Параметры

string|null $alias необязательно

Имя псевдонима для получения. Должно быть в формате CamelCase. Если null то используется значение свойства $defaultTable.

array<string, mixed> $options необязательно

Параметры для построения таблицы. Если таблица уже загружена, параметры реестра будут проигнорированы.

Возвращает

Cake\ORM\Table

Исключения

Cake\Core\Exception\CakeException
Если аргумент `$alias` и свойство `$defaultTable` оба равны `null`.

См. также

\Cake\ORM\TableLocator::get()

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

Если поставщик репозитория не возвращает объект, будет выброшено исключение 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, string|int $level = LogLevel::ERROR, array|string $context = []): bool

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

Параметры

string $message

Сообщение журнала.

string|int $level необязательно

Уровень ошибки.

array|string $context необязательно

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public 

modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void

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

Параметры

string $type

Имя типа репозитория, для которого предназначена функция-фабрика.

Cake\Datasource\Locator\LocatorInterface|callable $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

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

$_documentRoot protected

корень документа

Тип

string

$_host protected

хост сервера

Тип

string

$_iniPath protected

путь к ini

Тип

string

$_modelFactories protected

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

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

$_modelType protected

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

Тип

string

$_port protected

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

Тип

int

$_tableLocator protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

$defaultTable protected

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

Тип

string|null

$modelClass protected deprecated

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

Пример: Для объекта «Comments» имя модели будет «Comments». Классы плагинов должны использовать имена в формате 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.3/class-Cake.Command.ServerCommand.html

Spec-Zone.ru

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