Spec-Zone.ru › CakePHP 4.2

Класс PluginAssetsCopyCommand

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

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

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

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

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

Если поставщик репозитория не возвращает объект, будет брошено исключение 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, 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

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

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

Параметры

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 не будет склонять имя.

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

Spec-Zone.ru

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