Spec-Zone.ru › CakePHP 3.7

Класс BaseApplication

Базовый класс для приложений.

Класс приложения отвечает за загрузку приложения и подключение среднего слоя. Он также вызывается в качестве последнего элемента среднего слоя и делегирует обработку запросов/ответов соответствующему контроллеру.

Cake\Http\BaseApplication реализует Cake\Core\ConsoleApplicationInterface, Cake\Core\HttpApplicationInterface, Cake\Core\PluginApplicationInterface использует Cake\Event\EventDispatcherTrait
Абстрактный
Пространство имён: Cake\Http
Расположение: Http/BaseApplication.php

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

  • $configDir protected
    string
    Содержит путь к каталогу конфигурации
  • $plugins protected
    Cake\Core\PluginCollection
    Коллекция плагинов

Унаследованные свойства

  • _eventClass, _eventManager

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

  • __construct() public
    Конструктор
  • __invoke() public
    Вызов приложения.
  • addPlugin() public
    Добавление плагина к загруженному набору плагинов.
  • bootstrap() public
    Загрузка всей конфигурации приложения и логики загрузки.
  • console() public
    Определение команд консоли для приложения.
  • getDispatcher() protected
    Получение ActionDispatcher.
  • getPlugins() public
    Получение используемой коллекции плагинов.
  • makePlugin() protected
    Создание экземпляра плагина из имени класса и конфигурации
  • middleware() abstract public
  • pluginBootstrap() public
    Выполнение логики загрузки для загруженных плагинов.
  • pluginConsole() public
    Выполнение консольных хуков для плагинов
  • pluginMiddleware() public
    Выполнение хуков среднего слоя для плагинов
  • pluginRoutes() public
    Выполнение хуков маршрутов для загруженных плагинов
  • routes() public
    Определение маршрутов приложения.

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

__construct()source public

__construct( string $configDir , Cake\Event\EventManagerInterface $eventManager = null )

Конструктор

Параметры

строка $configDir
Каталог, в котором хранится конфигурация загрузки.
Cake\Event\EventManagerInterface $eventManager необязательно null
Экземпляр диспетчера событий приложения.

__invoke()source public

__invoke( Psr\Http\Message\ServerRequestInterface $request , Psr\Http\Message\ResponseInterface $response , callable $next )

Вызов приложения.

  • Преобразование PSR-ответа в эквиваленты CakePHP.
  • Создание контроллера, который будет обрабатывать этот запрос.
  • Вызов контроллера.

Параметры

Psr\Http\Message\ServerRequestInterface $request
Запрос
Psr\Http\Message\ResponseInterface $response
Ответ
вызываемый $next
Следующий middleware

Возвращает

Psr\Http\Message\ResponseInterface

Реализация

Cake\Core\HttpApplicationInterface::__invoke()

addPlugin()source public

addPlugin( string|Cake\Core\PluginInterface $name , array $config = [] )

Добавление плагина к загруженному набору плагинов.

Параметры

строка|Cake\Core\PluginInterface $name
Имя плагина или объект плагина.
массив $config необязательно []
Данные конфигурации плагина, если для $name используется строка

Возвращает


$this

Реализация

Cake\Core\PluginApplicationInterface::addPlugin()

bootstrap()source public

bootstrap( )

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

Реализация

Cake\Core\ConsoleApplicationInterface::bootstrap()

console()source public

console( Cake\Console\CommandCollection $commands )

Определение команд консоли для приложения.

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

Параметры

Cake\Console\CommandCollection $commands
CommandCollection для добавления команд.

Возвращает

Cake\Console\CommandCollection
Обновлённая коллекция.

Реализация

Cake\Core\ConsoleApplicationInterface::console()

getDispatcher()source protected

getDispatcher( )

Получение ActionDispatcher.

Возвращает

Cake\Http\ActionDispatcher

getPlugins()source public

getPlugins( )

Получение используемой коллекции плагинов.

Возвращает

Cake\Core\PluginCollection

makePlugin()source protected

makePlugin( string $name , array $config )

Создание экземпляра плагина из имени класса и конфигурации

Параметры

строка $name
Имя класса плагина
массив $config
Параметры конфигурации плагина

Возвращает

Cake\Core\PluginInterface

middleware()source abstract public

middleware( Cake\Http\MiddlewareQueue $middleware )

Параметры

Cake\Http\MiddlewareQueue $middleware
Очередь middleware, которую нужно установить в вашем классе App

Возвращает

Cake\Http\MiddlewareQueue

Реализация

Cake\Core\HttpApplicationInterface::middleware()

pluginBootstrap()source public

pluginBootstrap( )

Выполнение логики загрузки для загруженных плагинов.

Реализация

Cake\Core\PluginApplicationInterface::pluginBootstrap()

pluginConsole()source public

pluginConsole( Cake\Console\CommandCollection $commands )

Выполнение консольных хуков для плагинов

Параметры

Cake\Console\CommandCollection $commands
CommandCollection для использования.

Возвращает

Cake\Console\CommandCollection

Реализация

Cake\Core\PluginApplicationInterface::pluginConsole()

pluginMiddleware()source public

pluginMiddleware( Cake\Http\MiddlewareQueue $middleware )

Выполнение хуков среднего слоя для плагинов

Параметры

Cake\Http\MiddlewareQueue $middleware
MiddlewareQueue для использования.

Возвращает

Cake\Http\MiddlewareQueue

Реализация

Cake\Core\PluginApplicationInterface::pluginMiddleware()

pluginRoutes()source public

pluginRoutes( Cake\Routing\RouteBuilder $routes )

Выполнение обработчиков маршрутов для загруженных плагинов

Параметры

Cake\Routing\RouteBuilder $routes
Используемый создатель маршрутов.

Возвращает

Cake\Routing\RouteBuilder

Реализация

Cake\Core\PluginApplicationInterface::pluginRoutes()

routes()source public

routes( Cake\Routing\RouteBuilder $routes )

Определение маршрутов для приложения.

По умолчанию, для удобства использования и обратной совместимости, загружаются config/routes.php.

Параметры

Cake\Routing\RouteBuilder $routes
Создатель маршрутов для добавления маршрутов.

Реализация

Cake\Core\HttpApplicationInterface::routes()

Используемые методы из Cake\Event\EventDispatcherTrait

dispatchEvent()source public

dispatchEvent( string $name , array|null $data = null , object|null $subject = null )

Обёртка для создания и отправки событий.

Возвращает отправленное событие.

Параметры

string $name
Название события.
array|null $data optional null

Любое значение, которое вы хотите передать с этим событием, чтобы его могли прочитать слушатели.

object|null $subject optional null

Объект, к которому относится это событие (по умолчанию $this).

Возвращает

Cake\Event\Event

eventManager()source public deprecated

eventManager( Cake\Event\EventManager $eventManager = null )

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.

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

Устарело

3.5.0 Используйте getEventManager()/setEventManager() вместо этого.

Параметры

Cake\Event\EventManager $eventManager optional null
устанавливаемый eventManager

Возвращает

Cake\Event\EventManager

getEventManager()source public

getEventManager( )

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.

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

Возвращает

Cake\Event\EventManager

setEventManager()source public

setEventManager( Cake\Event\EventManager $eventManager )

Возвращает экземпляр менеджера Cake\Event\EventManager для данного объекта.

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

Параметры

Cake\Event\EventManager $eventManager
устанавливаемый eventManager

Возвращает


$this

Магические методы, унаследованные от Cake\Event\EventDispatcherInterface

getEventManager()

Подробности свойств

$configDirsource

protected string

Содержит путь к каталогу конфигурации

$pluginssource

protected Cake\Core\PluginCollection

Коллекция плагинов

© 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/3.7/class-Cake.Http.BaseApplication.html

Spec-Zone.ru

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