Класс PluginAssetsRemoveCommand

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

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

Постоянные значения

int

CODE_ERROR
```
1
```
Значение ошибки по умолчанию
int

CODE_SUCCESS
```
0
```
Значение успеха по умолчанию

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

$_modelFactories protected

(callableCake\Datasource\Locator\LocatorInterface)[]

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

string

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

Cake\ORM\Locator\LocatorInterface|null

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

Cake\Console\Arguments

Аргументы
$io protected

Cake\Console\ConsoleIo

Ввод-вывод консоли
$modelClass protected

string|null

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

string

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

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

__construct() public

Конструктор
_copyDirectory() protected

Копирование каталога
_createDirectory() protected

Создание каталога
_createSymlink() protected

Создание символической ссылки
_list() protected

Получить список плагинов для обработки. Плагины без каталога webroot пропускаются.
_process() protected

Обработка плагинов
_remove() protected

Удаление папки/символической ссылки.
_setModelClass() protected

Установить свойство modelClass на основе соглашений.
abort() public

Прекращение текущего процесса с исключением StopException.
buildOptionParser() public

Получить парсер параметров.
defaultName() public static

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

Вывод содержимого справки
execute() public

Выполнение команды
executeCommand() public

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

Получить тип модели, используемый этим классом
getName() public

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

Получить парсер параметров.
getRootName() public

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

Получить локализу таблиц.
initialize() public

Метод обработчика, вызываемый CakePHP, когда команда собирается быть выполнена.
loadModel() public

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

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

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

Запустить команду.
setModelType() public

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

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

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

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

END_OF_DOCUMENT_MARKER

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

__construct() public

__construct()

Конструктор

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

_copyDirectory() protected

_copyDirectory(string $source, string $destination): bool

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

Параметры

string $source: Исходная директория
string $destination: Директория назначения

Возвращает

bool

_createDirectory() protected

_createDirectory(string $dir): bool

Создание директории

Параметры

string $dir: Имя директории

Возвращает

bool

_createSymlink() protected

_createSymlink(string $target, string $link): bool

Создание символической ссылки

Параметры

string $target: Целевая директория
string $link: Имя ссылки

Возвращает

bool

_list() protected

_list(string|null $name = null): array

Получение списка плагинов для обработки. Плагины без директории webroot пропускаются.

Параметры

string|null $name optional: Имя плагина, для которого необходимо создать символьную ссылку на ресурсы. Если null, будут обработаны все плагины.

Возвращает

array

_process() protected

_process(array $plugins, bool $copy = false, bool $overwrite = false): void

Обработка плагинов

Параметры

array $plugins: Список плагинов для обработки
bool $copy optional: Принудительный режим копирования. По умолчанию false.
bool $overwrite optional: Перезапись существующих файлов.

Возвращает

void

_remove() protected

_remove(array $config): bool

Удаление папки/символической ссылки.

Параметры

array $config: Конфигурация плагина.

Возвращает

bool

_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

Выполнение команды

Удаление ресурсов плагинов из webroot приложения.

Параметры

Cake\Console\Arguments $args: Аргументы команды.
Cake\Console\ConsoleIo $io: Консольный ввод/вывод

Возвращает

int|null

executeCommand() public

executeCommand(stringCake\Console\CommandInterface $command, array $args = [], Cake\Console\ConsoleIo $io = null): int|null

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

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

Параметры

stringCake\Console\CommandInterface $command: Имя класса команды или экземпляр команды.
array $args optional: Аргументы для вызова команды.
Cake\Console\ConsoleIo $io optional: Экземпляр ConsoleIo для использования в выполняемой команде.

Возвращает

int|null

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', или 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, int|string $level = LogLevel::ERROR, string|array $context = []): bool

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

Параметры

string $message: Сообщение для журнала.
int|string $level необязательный: Уровень ошибки.
string|array $context необязательный: Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public

modelFactory(string $type, callableCake\Datasource\Locator\LocatorInterface $factory): void

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

Параметры

string $type: Имя типа репозитория, для которого предназначена функция-фабрика.
callableCake\Datasource\Locator\LocatorInterface $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

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

`$_modelFactories` protected

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

Тип

(callableCake\Datasource\Locator\LocatorInterface)[]

`$_modelType` protected

Тип используемой модели.

Тип

string

`$_tableLocator` protected

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

Тип

Cake\ORM\Locator\LocatorInterface|null

`$args` protected

Аргументы

Тип

Cake\Console\Arguments

`$io` protected

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

Тип

Cake\Console\ConsoleIo

`$modelClass` protected

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