Spec-Zone.ru › CakePHP 3.8

Класс BaseApplication

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

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

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
    Выполнение хуков middleware для плагинов
  • 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
Коллекция команд, в которую добавляются команды.

Возвращает

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
Коллекцию команд для использования.

Возвращает

Cake\Console\CommandCollection

Реализация

Cake\Core\PluginApplicationInterface::pluginConsole()

pluginMiddleware()source public

pluginMiddleware( Cake\Http\MiddlewareQueue $middleware )

Выполнение хуков 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()
END_OF_DOCUMENT_MARKER

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 )

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

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

Параметры

строка $name
Имя события.
массив|null $data необязательно null

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

объект|null $subject необязательно 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 необязательно 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 строка

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

$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.8/class-Cake.Http.BaseApplication.html

Spec-Zone.ru

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