Класс BaseApplication
Базовый класс для приложений.
Класс приложения отвечает за загрузку приложения и обеспечение подключения middleware. Он также вызывается как последняя часть middleware и делегирует обработку запроса/ответа соответствующему контроллеру.
- Cake\Http\BaseApplication реализует Cake\Core\ConsoleApplicationInterface, Cake\Core\HttpApplicationInterface, Cake\Core\PluginApplicationInterface использует Cake\Event\EventDispatcherTrait
Краткое описание свойств
-
$configDirprotectedСодержит путь к каталогу конфигурацииstring - Коллекция плагинов
$pluginsprotected
Наследованные свойства
Краткое описание методов
- __construct() publicКонструктор
- __invoke() publicВызов приложения.
- addPlugin() publicДобавление плагина в загруженный набор.
- bootstrap() publicЗагрузка всей конфигурации приложения и логики запуска.
- console() publicОпределение команд консоли для приложения.
- getDispatcher() protectedПолучение ActionDispatcher.
- getPlugins() publicПолучение используемой коллекции плагинов.
- makePlugin() protectedСоздание экземпляра плагина из имени класса и конфигурации
- 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\ActionDispatchergetPlugins()source public
getPlugins( )
Получение используемой коллекции плагинов.
Возвращает
Cake\Core\PluginCollectionmakePlugin()source protected
makePlugin( string $name , array $config )
Создание экземпляра плагина из имени класса и конфигурации
Параметры
- строка
$name - Имя класса плагина
- массив
$config - Параметры конфигурации плагина
Возвращает
Cake\Core\PluginInterfacemiddleware()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() 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\EventeventManager()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\EventManagergetEventManager()source public
getEventManager( )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации любых новых слушателей или обратных вызовов к событиям объекта, или создавать собственные события и вызывать их по своему желанию.
Возвращает
Cake\Event\EventManagersetEventManager()source public
setEventManager( Cake\Event\EventManager $eventManager )
Возвращает экземпляр менеджера Cake\Event\EventManager для этого объекта.
Вы можете использовать этот экземпляр для регистрации любых новых слушателей или обратных вызовов к событиям объекта, или создавать собственные события и вызывать их по своему желанию.
Параметры
-
Cake\Event\EventManager$eventManager - устанавливаемый eventManager
Возвращает
$this
Магические методы, унаследованные от Cake\Event\EventDispatcherInterface
getEventManager() |
Подробное описание свойств
© 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