Spec-Zone.ru › CakePHP 4.4

Класс 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

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

  • getDescription() public static

    Получение описания команды.

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

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

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

Параметры

Cake\Console\CommandInterface|string $command

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

array $args optional

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

Cake\Console\ConsoleIo|null $io optional

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

Возвращает

int|null

fetchTable() 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`.

См. также

\Cake\ORM\TableLocator::get()

getDescription() public static 

getDescription(): string

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

Возвращает

string

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 optional

Имя класса модели для загрузки. По умолчанию равно $this->modelClass. Имя может быть псевдонимом, например, 'Post' или полным именем класса, например, 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, string|int $level = LogLevel::ERROR, array|string $context = []): bool

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

Параметры

string $message

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

string|int $level optional

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

array|string $context optional

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

Возвращает

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.4/class-Cake.Command.ServerCommand.html

Spec-Zone.ru

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