Spec-Zone.ru › CakePHP 4.3

Класс PluginAssetsCopyCommand

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

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

    Конструктор

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

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

  • fetchTable() public

    Удобный метод для получения экземпляра таблицы.

  • getModelType() public

    Получение типа модели, используемого этим классом

  • getName() public

    Получение имени команды.

  • getOptionParser() public

    Получение парсера опций.

  • getRootName() public

    Получение имени корневой команды.

  • getTableLocator() public

    Получение локатора таблиц.

  • initialize() public

    Метод-обработчик, вызываемый CakePHP, когда команда должна быть выполнена.

  • loadModel() public deprecated

    Загрузка и построение объектов репозитория, необходимых этому объекту

  • 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<string, mixed>

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

Параметры

string|null $name optional

Имя плагина, для которого нужно создать символическую ссылку на ресурсы. Если null, будут обработаны все плагины.

Возвращает

array<string, mixed>

_process() protected 

_process(array<string, mixed> $plugins, bool $copy = false, bool $overwrite = false): void

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

Параметры

array<string, mixed> $plugins

Список плагинов для обработки

bool $copy optional

Принудительный режим копирования. По умолчанию false.

bool $overwrite optional

Перезапись существующих файлов.

Возвращает

void

_remove() protected 

_remove(array<string, mixed> $config): bool

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

Параметры

array<string, mixed> $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(Cake\Console\CommandInterface|string $command, array $args = [], Cake\Console\ConsoleIo|null $io = null): int|null

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

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

Параметры

Cake\Console\CommandInterface|string $command

Имя класса команды или экземпляр команды.

array $args optional

Аргументы для вызова команды.

Cake\Console\ConsoleIo|null $io optional

Экземпляр ConsoleIo для использования в исполняемой команде.

Возвращает

int|null

fetchTable() public 

fetchTable(string|null $alias = null, array<string, mixed> $options = []): Cake\ORM\Table

Удобный метод для получения экземпляра таблицы.

Параметры

string|null $alias optional

Имя псевдонима, который вы хотите получить. Должно быть в формате CamelCase. Если null, используется значение свойства $defaultTable.

array<string, mixed> $options optional

Опции, с которыми вы хотите создать таблицу. Если таблица уже загружена, опции реестра будут проигнорированы.

Возвращает

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

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

Параметры

string $message

Сообщение журнала.

string|int $level optional

Уровень ошибки.

array|string $context optional

Дополнительные данные журнала, относящиеся к этому сообщению.

Возвращает

bool

modelFactory() public 

modelFactory(string $type, Cake\Datasource\Locator\LocatorInterface|callable $factory): void

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

Параметры

string $type

Название типа репозитория, для которого предназначена функция фабрики.

Cake\Datasource\Locator\LocatorInterface|callable $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

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

Тип

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

Пример: для объекта с именем 'Комментарии', 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.3/class-Cake.Command.PluginAssetsCopyCommand.html

Spec-Zone.ru

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