Класс CakePlugin

_includeFile()source protected static

_includeFile( string $file , boolean $ignoreMissing false )

Включение файла, игнорируя ошибку включения, если файл отсутствует

Параметры

строка $file

Файл для включения

логическое значение $ignoreMissing необязательно false

Игнорировать ошибку включения при отсутствии файла

Возвращает

смешанный тип

bootstrap()source public static

bootstrap( string $plugin )

Загружает файлы инициализации для плагина или вызывает настройку инициализации в конфигурации

Параметры

строка $plugin

имя плагина

Возвращает

смешанный тип

См. также

CakePlugin::load() для примеров конфигурации bootstrap

load()source public static

load( string|array $plugin , array $config array() )

Загружает плагин и, по желанию, загружает файлы инициализации, маршрутизации или выполняет функцию инициализации

Примеры:

CakePlugin::load('DebugKit')

Загружает плагин DebugKit, не загружая файлы bootstrap и маршрутизации

CakePlugin::load('DebugKit', array('bootstrap' => true, 'routes' => true))

загрузит файлы bootstrap.php и routes.php

CakePlugin::load('DebugKit', array('bootstrap' => false, 'routes' => true))

загрузит файл routes.php, но не bootstrap.php

CakePlugin::load('DebugKit', array('bootstrap' => array('config1', 'config2')))

загрузит файлы config1.php и config2.php

CakePlugin::load('DebugKit', array('bootstrap' => 'aCallableMethod'))

выполнит функцию aCallableMethod для инициализации

Функции инициализации bootstrap могут быть выражены как обратные вызовы PHP, включая замыкания. Обратные вызовы будут принимать два параметра (имя плагина, конфигурация плагина)

Также возможно загрузить несколько плагинов одновременно. Примеры:

CakePlugin::load(array('DebugKit', 'ApiGenerator'))

загрузит плагины DebugKit и ApiGenerator

CakePlugin::load(array('DebugKit', 'ApiGenerator'), array('bootstrap' => true))

загрузит файл bootstrap для обоих плагинов

CakePlugin::load(array(
        'DebugKit' => array('routes' => true),
        'ApiGenerator'
        ), array('bootstrap' => true))

Загрузит только bootstrap для ApiGenerator и только routes для DebugKit. Используя параметр path, можно указать абсолютный путь к плагину. Убедитесь, что путь оканчивается слешем, иначе плагин не будет найден должным образом.

Параметры

строка/массив $plugin

имя плагина в формате CamelCase или массив плагинов для загрузки

массив $config необязательно array()

параметры конфигурации для плагина

Исключения

MissingPluginException
если папка для загружаемого плагина не найдена

loadAll()source public static

loadAll( array $options array() )

Загружает все плагины, расположенные в папках плагинов, настроенных в конфигурации. Если передаётся массив параметров, он используется как общее значение по умолчанию для всех загружаемых плагинов. Можно задать специфичные значения по умолчанию для каждого плагина в массиве параметров. Примеры:

CakePlugin::loadAll(array(
        array('bootstrap' => true),
        'DebugKit' => array('routes' => true, 'bootstrap' => false),
    ))

Приведённый пример загрузит файл bootstrap для всех плагинов, но для DebugKit он загрузит только файл маршрутов и не будет искать скрипт bootstrap. Если вы загружаете много плагинов, которые несовместимо поддерживают файлы маршрутов/bootstrap, вместо подробного описания каждого плагина можно использовать параметр ignoreMissing.

CakePlugin::loadAll(array(
  'ignoreMissing' => true,
  'bootstrap' => true,
  'routes' => true,
));

Параметр ignoreMissing выполняет дополнительные проверки file_exists(), но проще в использовании.

Параметры

массив $options необязательно array()

Список параметров. См. CakePlugin::load() для допустимых параметров.

loaded()source public static

loaded( string $plugin null )

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

Параметры

строка $plugin необязательно null

Имя плагина для проверки.

Возвращает

смешанный тип

булево значение true, если $plugin уже загружен. Если $plugin равен null, возвращает список загруженных плагинов

path()source public static

path( string $plugin )

Возвращает путь к файловой системе для плагина

Параметры

строка $plugin

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

Возвращает

строка
путь к папке плагина

Исключения

MissingPluginException
если папка для плагина не найдена или плагин не загружен

routes()source public static

routes( string $plugin null )

Загружает файл маршрутов для плагина или всех плагинов, настроенных для загрузки своих файлов маршрутов

Параметры

строка $plugin необязательно null

имя плагина, если null, выполняет операцию для всех плагинов, разрешивших загрузку файлов маршрутов

Возвращает

логическое значение

unload()source public static

unload( string $plugin null )

Удаляет загруженный плагин или все плагины, если первый параметр равен null

Параметры

строка $plugin необязательно null

имя плагина для удаления

array()