Класс PluginAssetsSymlinkCommand

Команда для создания символических ссылок/копирования ресурсов плагинов в корень приложения.

Пространство имен: 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 приложения. Если создание символической ссылки не удается, происходит возврат к копированию ресурсов. Для плагинов с именем пространства имен vendor, родительская папка для имени vendor создается при необходимости.

Параметры

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', или полным именем класса, например 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 не будет склонять имя.

Пример: Для объекта с именем 'Comments', modelClass будет '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.2/class-Cake.Command.PluginAssetsSymlinkCommand.html