Spec-Zone.ru › CakePHP 4.3

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

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

  • modifyApplication() protected

    Модифицировать класс приложения

  • run() public

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

  • setModelType() public

    Установить тип модели, используемый этим классом

  • setName() public

    Установить имя, используемое этой командой в коллекции.

  • setOutputLevel() protected

    Установить уровень вывода на основе аргументов.

  • setTableLocator() public

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

END_OF_DOCUMENT_MARKER

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

__construct() public 

__construct()

Конструктор

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

_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

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

Установить имя, которое использует эта команда в коллекции.

Обычно вызывается коллекцией команд при добавлении команды. Требуется иметь хотя бы один пробел в имени, чтобы можно было вычислить корневую команду.

Параметры

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

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

Тип

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 deprecated

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

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

Spec-Zone.ru

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