Spec-Zone.ru › CakePHP 4.3

Класс PluginAssetsSymlinkCommand

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

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

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

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

__construct() public 

__construct()

Конструктор

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

_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.PluginAssetsSymlinkCommand.html

Spec-Zone.ru

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