Spec-Zone.ru › CakePHP 4.3

Класс Плагин

Плагин используется для загрузки и поиска плагинов.

Он также может извлекать пути к плагинам и загружать их файлы bootstrap и маршрутизации.

Пространство имен: Cake\Core
Ссылка: https://book.cakephp.org/4/ru/plugins.html

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

  • $plugins protected static
    Cake\Core\PluginCollection|null

    Содержит список всех загруженных плагинов и их конфигурацию

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

  • classPath() public static

    Возвращает файловый путь к папке плагина, содержащей файлы классов.

  • configPath() public static

    Возвращает файловый путь к папке плагина, содержащей файлы конфигурации.

  • getCollection() public static

    Получить общую коллекцию плагинов.

  • isLoaded() public static

    Возвращает true, если плагин $plugin уже загружен.

  • loaded() public static

    Возвращает список загруженных плагинов.

  • path() public static

    Возвращает файловый путь к плагину

  • templatePath() public static

    Возвращает файловый путь к папке плагина, содержащей шаблоны.

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

classPath() public static

classPath(string $name): string

Возвращает файловый путь к папке плагина, содержащей файлы классов.

Параметры

string $name

имя плагина в формате CamelCase.

Возвращает

string

Исключения

Cake\Core\Exception\MissingPluginException
Если плагин не загружен.

configPath() public static

configPath(string $name): string

Возвращает файловый путь к папке плагина, содержащей файлы конфигурации.

Параметры

string $name

имя плагина в формате CamelCase.

Возвращает

string

Исключения

Cake\Core\Exception\MissingPluginException
Если плагин не загружен.

getCollection() public static

getCollection(): Cake\Core\PluginCollection

Получить общую коллекцию плагинов.

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

Возвращает

Cake\Core\PluginCollection

isLoaded() public static

isLoaded(string $plugin): bool

Возвращает true, если плагин $plugin уже загружен.

Параметры

string $plugin

Имя плагина.

Возвращает

bool

loaded() public static

loaded(): array<string>

Возвращает список загруженных плагинов.

Возвращает

array<string>

path() public static

path(string $name): string

Возвращает файловый путь к плагину

Параметры

string $name

имя плагина в формате CamelCase

Возвращает

string

Исключения

Cake\Core\Exception\MissingPluginException
Если папка плагина не найдена или плагин не загружен.

templatePath() public static

templatePath(string $name): string

Возвращает файловый путь к папке плагина, содержащей файлы шаблонов.

Параметры

string $name

имя плагина в формате CamelCase.

Возвращает

string

Исключения

Cake\Core\Exception\MissingPluginException
Если плагин не загружен.

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

$plugins protected static

Содержит список всех загруженных плагинов и их конфигурацию

Тип

Cake\Core\PluginCollection|null

© 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.Core.Plugin.html

Spec-Zone.ru

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