Spec-Zone.ru › CakePHP 4.4

Класс PluginUnloadCommand

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

Пространство имён: 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

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

  • $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

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

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

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

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

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()

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

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

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

Параметры

string $app

Путь к обновляемому приложению.

string $plugin

Имя плагина.

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

bool

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

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

$_modelFactories protected

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

Тип

array<callableCake\Datasource\Locator\LocatorInterface>

$_modelType protected

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

Тип

string

$_tableLocator protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

$defaultTable protected

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

Тип

string|null

$modelClass protected deprecated

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

Пример: Для объекта с именем 'Комментарии' моделью будет 'Комментарии'. Классы плагинов должны использовать имена в формате 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.PluginUnloadCommand.html

Spec-Zone.ru

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