Spec-Zone.ru › CakePHP 4.4

Класс PluginLoadCommand

Команда для загрузки плагинов.

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

Константы

  • int
    CODE_ERROR 
    1

    Код ошибки по умолчанию

  • int
    CODE_SUCCESS 
    0

    Код успешного выполнения по умолчанию

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

  • $_modelFactories protected
    array<callableCake\Datasource\Locator\LocatorInterface>

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

  • $_modelType protected
    string

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

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

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

  • $args protected
    Cake\Console\Arguments

    Аргументы

  • $defaultTable protected
    string|null

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

  • $io protected
    Cake\Console\ConsoleIo

    Ввод/вывод консоли

  • $modelClass protected устарело
    string|null

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

  • $name protected
    string

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

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

  • __construct() public

    Конструктор

  • _setModelClass() protected

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

  • abort() public

    Прекращает текущий процесс с исключением StopException.

  • buildOptionParser() public

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

  • defaultName() public статический

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

  • displayHelp() protected

    Вывод содержимого справки

  • execute() public

    Выполнить команду

  • executeCommand() public

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

  • fetchTable() public

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

  • getDescription() public статический

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

  • getModelType() public

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

  • getName() public

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

  • getOptionParser() public

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

  • getRootName() public

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

  • getTableLocator() public

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

  • initialize() public

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

  • loadModel() public устарело

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

  • log() public

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

  • modelFactory() public

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

  • modifyApplication() protected

    Изменить класс приложения

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

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

Удобный метод для записи сообщения в Log. См. 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

modifyApplication() protected 

modifyApplication(string $app, string $plugin): void

Изменить класс приложения

Параметры

string $app

Файл приложения, который нужно изменить.

string $plugin

Имя плагина, который нужно добавить.

Возвращает

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

IO консоли

Возвращает

void

setTableLocator() public 

setTableLocator(Cake\ORM\Locator\LocatorInterface $tableLocator): $this

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

Параметры

Cake\ORM\Locator\LocatorInterface $tableLocator

Экземпляр LocatorInterface.

Возвращает

$this

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

$_modelFactories protected

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

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

$_modelType protected

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

Тип

string

$_tableLocator protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

$args protected

Аргументы

Тип

Cake\Console\Arguments

$defaultTable protected

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

Тип

string|null

$io protected

IO консоли

Тип

Cake\Console\ConsoleIo

$modelClass protected deprecated

Имя основного класса модели этого объекта. Должен быть во множественном числе. 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.4/class-Cake.Command.PluginLoadCommand.html

Spec-Zone.ru

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