Класс yii\web\Application
| Наследование | yii\web\Application » yii\base\Application » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/web/Application.php |
Application — базовый класс для всех классов веб-приложений.
Для получения более подробной информации и использования Application, см. статью руководства по приложениям.
Открытые свойства
| Свойство | Тип | Описание | Определено в |
|---|---|---|---|
| $aliases | массив | Список псевдонимов путей для определения. | yii\base\Module |
| $assetManager | yii\web\AssetManager | Компонент приложения для управления активами. | yii\base\Application |
| $authManager | yii\rbac\ManagerInterface | Компонент приложения для управления аутентификацией. | yii\base\Application |
| $basePath | строка | Корневой каталог модуля. | yii\base\Module |
| $behaviors | yii\base\Behavior[] | Список поведений, прикрепленных к этому компоненту. | yii\base\Component |
| $bootstrap | массив | Список компонентов, которые должны быть запущены во время процесса загрузки приложения. | yii\base\Application |
| $cache | yii\caching\CacheInterface | Компонент приложения для кэширования. | yii\base\Application |
| $catchAll | массив | Конфигурация, указывающая действие контроллера, которое должно обрабатывать все запросы пользователей. | yii\web\Application |
| $charset | строка | Кодировка символов, используемая в приложении. | yii\base\Application |
| $components | массив | Список определений компонентов или загруженных экземпляров компонентов (ID => определение или экземпляр). | yii\di\ServiceLocator |
| $container | массив | Значения, заданные в виде пар имя-значение | yii\base\Application |
| $controller | yii\web\Controller | Текущий активный экземпляр контроллера | yii\web\Application |
| $controllerMap | массив | Сопоставление идентификатора контроллера с конфигурациями контроллера. | yii\base\Module |
| $controllerNamespace | строка | Пространство имен, в котором находятся классы контроллеров. | yii\base\Application |
| $controllerPath | строка | Директория, содержащая классы контроллеров. | yii\base\Module |
| $db | yii\db\Connection | Подключение к базе данных. | yii\base\Application |
| $defaultRoute | строка | Маршрут по умолчанию этого приложения. | yii\web\Application |
| $errorHandler | yii\web\ErrorHandler | Компонент приложения для обработки ошибок. | yii\web\Application |
| $extensions | массив | Список установленных расширений Yii. | yii\base\Application |
| $formatter | yii\i18n\Formatter | Компонент приложения для форматирования. | yii\base\Application |
| $homeUrl | строка | URL домашней страницы | yii\web\Application |
| $i18n | yii\i18n\I18N | Компонент приложения для интернационализации. | yii\base\Application |
| $id | строка | Идентификатор, уникально определяющий этот модуль среди других модулей с тем же родительским модулем. | yii\base\Module |
| $language | строка | Язык, который должен использоваться для конечных пользователей. | yii\base\Application |
| $layout | строка|логическое значение | Макет, который должен применяться для представлений в этом приложении. | yii\base\Application |
| $layoutPath | строка | Корневой каталог файлов макета. | yii\base\Module |
| $loadedModules | массив | Список загруженных модулей, индексированных по их именам классов. | yii\base\Application |
| $log | yii\log\Dispatcher | Компонент приложения для управления логами. | yii\base\Application |
| $mailer | yii\mail\MailerInterface | Компонент приложения для отправки почты. | yii\base\Application |
| $module | yii\base\Module | Родительский модуль этого модуля. | yii\base\Module |
| $modules | массив | Модули (индексированные по их идентификаторам). | yii\base\Module |
| $name | строка | Имя приложения. | yii\base\Application |
| $params | массив | Пользовательские параметры модуля (имя => значение). | yii\base\Module |
| $request | yii\web\Request | Компонент запроса. | yii\web\Application |
| $requestedAction | yii\base\Action | Запрошенное действие. | yii\base\Application |
| $requestedParams | массив | Параметры, предоставленные запрошенному действию. | yii\base\Application |
| $requestedRoute | строка | Запрошенный маршрут | yii\base\Application |
| $response | yii\web\Response | Компонент ответа. | yii\web\Application |
| $runtimePath | строка | Директория для хранения временных файлов. | yii\base\Application |
| $security | yii\base\Security | Компонент приложения для безопасности. | yii\base\Application |
| $session | yii\web\Session | Компонент сессии. | yii\web\Application |
| $sourceLanguage | string | Язык, на котором написан приложение. | yii\base\Application |
| $state | integer | Текущее состояние приложения во время обработки запроса. | yii\base\Application |
| $timeZone | string | Часовой пояс, используемый этим приложением. | yii\base\Application |
| $uniqueId | string | Уникальный идентификатор модуля. | yii\base\Application |
| $urlManager | yii\web\UrlManager | Менеджер URL для этого приложения. | yii\base\Application |
| $user | yii\web\User | Компонент пользователя. | yii\web\Application |
| $vendorPath | string | Директория, в которой хранятся файлы вендоров. | yii\base\Application |
| $version | string | Версия этого модуля. | yii\base\Module |
| $view | yii\base\View|yii\web\View | Компонент приложения для отображения различных файлов представления. | yii\base\Application |
| $viewPath | string | Корневая директория файлов представления. | yii\base\Module |
Публичные методы
| Метод | Описание | Определено в |
|---|---|---|
| __call() | Вызывает именованный метод, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путём клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Application |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| afterAction() | Этот метод вызывается сразу после выполнения действия в рамках данного модуля. | yii\base\Module |
| attachBehavior() | Присоединяет поведение к данному компоненту. | yii\base\Component |
| attachBehaviors() | Присоединяет список поведений к компоненту. | yii\base\Component |
| beforeAction() | Этот метод вызывается сразу перед выполнением действия в рамках данного модуля. | yii\base\Module |
| behaviors() | Возвращает список поведений, по которым должен вести себя этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное имя этого класса. | yii\base\Object |
| clear() | Удаляет компонент из локатора. | yii\di\ServiceLocator |
| coreComponents() | Возвращает конфигурацию основных компонентов приложения. | yii\web\Application |
| createController() | Создаёт экземпляр контроллера на основе заданного маршрута. | yii\base\Module |
| createControllerByID() | Создаёт контроллер на основе заданного идентификатора контроллера. | yii\base\Module |
| detachBehavior() | Отсоединяет поведение от компонента. | yii\base\Component |
| detachBehaviors() | Отсоединяет все поведения от компонента. | yii\base\Component |
| end() | Завершает работу приложения. | yii\base\Application |
| ensureBehaviors() | Убеждается, что поведения, объявленные в behaviors(), присоединены к этому компоненту. | yii\base\Component |
| get() | Возвращает экземпляр компонента с указанным идентификатором. | yii\di\ServiceLocator |
| getAssetManager() | Возвращает менеджер активов. | yii\base\Application |
| getAuthManager() | Возвращает менеджер авторизации для этого приложения. | yii\base\Application |
| getBasePath() | Возвращает корневой каталог модуля. | yii\base\Module |
| getBehavior() | Возвращает объект именованного поведения. | yii\base\Component |
| getBehaviors() | Возвращает все присоединенные к этому компоненту поведения. | yii\base\Component |
| getCache() | Возвращает компонент кеша. | yii\base\Application |
| getComponents() | Возвращает список определений компонентов или загруженных экземпляров компонентов. | yii\di\ServiceLocator |
| getControllerPath() | Возвращает каталог, содержащий классы контроллеров в соответствии с $controllerNamespace. | yii\base\Module |
| getDb() | Возвращает компонент подключения к базе данных. | yii\base\Application |
| getErrorHandler() | Возвращает компонент обработки ошибок. | yii\web\Application |
| getFormatter() | Возвращает компонент форматирования. | yii\base\Application |
| getHomeUrl() | yii\web\Application | |
| getI18n() | Возвращает компонент интернационализации (i18n). | yii\base\Application |
| getInstance() | Возвращает текущий запрашиваемый экземпляр данного класса модуля. | yii\base\Module |
| getLayoutPath() | Возвращает каталог, содержащий файлы представления макета для этого модуля. | yii\base\Module |
| getLog() | Возвращает компонент диспетчера логов. | yii\base\Application |
| getMailer() | Возвращает компонент почтовой рассылки. | yii\base\Application |
| getModule() | Извлекает дочерний модуль с указанным идентификатором. | yii\base\Module |
| getModules() | Возвращает дочерние модули в этом модуле. | yii\base\Module |
| getRequest() | Возвращает компонент запроса. | yii\web\Application |
| getResponse() | Возвращает компонент ответа. | yii\web\Application |
| getRuntimePath() | Возвращает каталог, в котором хранятся временные файлы. | yii\base\Application |
| getSecurity() | Возвращает компонент безопасности. | yii\base\Application |
| getSession() | Возвращает компонент сессии. | yii\web\Application |
| getTimeZone() | Возвращает часовой пояс, используемый этим приложением. | yii\base\Application |
| getUniqueId() | Возвращает идентификатор, уникально определяющий этот модуль среди всех модулей в текущем приложении. | yii\base\Application |
| getUrlManager() | Возвращает менеджер URL для этого приложения. | yii\base\Application |
| getUser() | Возвращает компонент пользователя. | yii\web\Application |
| getVendorPath() | Возвращает директорию, в которой хранятся файлы vendor. | yii\base\Application |
| getVersion() | Возвращает текущую версию модуля. | yii\base\Module |
| getView() | Возвращает объект представления. | yii\base\Application |
| getViewPath() | Возвращает директорию, содержащую файлы представлений для данного модуля. | yii\base\Module |
| handleRequest() | Обрабатывает указанный запрос. | yii\web\Application |
| has() | Возвращает значение, указывающее, содержит ли локализуемый компонент указанное определение компонента или был ли компонент инициализирован. | yii\di\ServiceLocator |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли какой-либо обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasModule() | Проверяет, существует ли дочерний модуль с указанным идентификатором. | yii\base\Module |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| init() | Инициализирует модуль. | yii\base\Application |
| off() | Открепляет существующий обработчик событий от данного компонента. | yii\base\Component |
| on() | Прикрепляет обработчик событий к событию. | yii\base\Component |
| preInit() | Предварительная инициализация приложения. | yii\base\Application |
| run() | Запускает приложение. | yii\base\Application |
| runAction() | Запускает действие контроллера, заданное маршрутом. | yii\base\Module |
| set() | Регистрирует определение компонента в этом локаторе. | yii\di\ServiceLocator |
| setAliases() | Определяет псевдонимы путей. | yii\base\Module |
| setBasePath() | Устанавливает корневую директорию приложения и псевдоним @app. | yii\base\Application |
| setComponents() | Регистрирует набор определений компонентов в этом локаторе. | yii\di\ServiceLocator |
| setContainer() | Конфигурирует Yii::$container с помощью $config. | yii\base\Application |
| setHomeUrl() | yii\web\Application | |
| setInstance() | Устанавливает текущую запрошенную инстанцию этого класса модуля. | yii\base\Module |
| setLayoutPath() | Устанавливает директорию, содержащую файлы макетов. | yii\base\Module |
| setModule() | Добавляет подмодуль к этому модулю. | yii\base\Module |
| setModules() | Регистрирует подмодули в текущем модуле. | yii\base\Module |
| setRuntimePath() | Устанавливает директорию для хранения файлов runtime. | yii\base\Application |
| setTimeZone() | Устанавливает часовой пояс, используемый этим приложением. | yii\base\Application |
| setVendorPath() | Устанавливает директорию для хранения файлов vendor. | yii\base\Application |
| setVersion() | Устанавливает текущую версию модуля. | yii\base\Module |
| setViewPath() | Устанавливает директорию, содержащую файлы представлений. | yii\base\Module |
| trigger() | Вызывает событие. | yii\base\Component |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| bootstrap() | Инициализирует расширения и выполняет компоненты bootstrap. | yii\web\Application |
| defaultVersion() | Возвращает значение по умолчанию для версии модуля. | yii\base\Module |
| registerErrorHandler() | Регистрирует компонент errorHandler в качестве обработчика ошибок PHP. | yii\base\Application |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_AFTER_ACTION | yii\base\ActionEvent | Событие, генерируемое после выполнения действия контроллера. | yii\base\Module |
| EVENT_AFTER_REQUEST | yii\base\Event | Событие, генерируемое после успешной обработки запроса приложением (перед отправкой ответа). | yii\base\Application |
| EVENT_BEFORE_ACTION | yii\base\ActionEvent | Событие, генерируемое перед выполнением действия контроллера. | yii\base\Module |
| EVENT_BEFORE_REQUEST | yii\base\Event | Событие, генерируемое перед началом обработки запроса приложением. | yii\base\Application |
Constants
| Constant | Value | Description | Defined By |
|---|---|---|---|
| STATE_AFTER_REQUEST | 4 | Состояние приложения, используемое $state: приложение инициирует EVENT_AFTER_REQUEST. | yii\base\Application |
| STATE_BEFORE_REQUEST | 2 | Состояние приложения, используемое $state: приложение инициирует EVENT_BEFORE_REQUEST. | yii\base\Application |
| STATE_BEGIN | 0 | Состояние приложения, используемое $state: приложение только что запущено. | yii\base\Application |
| STATE_END | 6 | Состояние приложения, используемое $state: приложение завершено. | yii\base\Application |
| STATE_HANDLING_REQUEST | 3 | Состояние приложения, используемое $state: приложение обрабатывает запрос. | yii\base\Application |
| STATE_INIT | 1 | Состояние приложения, используемое $state: приложение инициализируется. | yii\base\Application |
| STATE_SENDING_RESPONSE | 5 | Состояние приложения, используемое $state: приложение готово к отправке ответа. | yii\base\Application |
Property Details
$catchAll общественное свойство
Конфигурация, определяющая действие контроллера, которое должно обрабатывать все запросы пользователя. В основном используется, когда приложение находится в режиме технического обслуживания и нужно обработать все входящие запросы через одно действие. Конфигурация представляет собой массив, первый элемент которого определяет маршрут действия. Остальные элементы массива (пары ключ-значение) определяют параметры, которые нужно привязать к действию. Например,
[
'offline/notice',
'param1' => 'value1',
'param2' => 'value2',
]
По умолчанию равно null, что означает, что catch-all не используется.
public array $catchAll = null
$controller общественное свойство
Текущая активная инстанция контроллера
public yii\web\Controller $controller = null
$defaultRoute общественное свойство
Маршрут по умолчанию этого приложения. По умолчанию равен 'site'.
public string $defaultRoute = 'site'
$errorHandler общественное только для чтения свойство
Компонент обработчик ошибок приложения.
public yii\web\ErrorHandler getErrorHandler ( )
$homeUrl общественное свойство
URL домашней страницы
public string getHomeUrl ( )
public void setHomeUrl ( $value )
$request общественное только для чтения свойство
Компонент запроса.
public yii\web\Request getRequest ( )
$response общественное только для чтения свойство
Компонент ответа.
public yii\web\Response getResponse ( )
$session общественное только для чтения свойство
Компонент сессии.
public yii\web\Session getSession ( )
$user общественное только для чтения свойство
Компонент пользователя.
public yii\web\User getUser ( )
Подробное описание методов
bootstrap() защищённый метод
Инициализирует расширения и выполняет компоненты загрузки.
Этот метод вызывается методом init() после того, как приложение было полностью сконфигурировано. Если вы переопределяете этот метод, убедитесь, что вы также вызываете родительскую реализацию.
| защищённый void bootstrap ( ) |
|---|
coreComponents() общественный метод
Возвращает конфигурацию основных компонентов приложения.
| public void coreComponents ( ) |
|---|
getErrorHandler() общественный метод
Возвращает компонент обработчика ошибок.
| public yii\web\ErrorHandler getErrorHandler ( ) | ||
|---|---|---|
| return | yii\web\ErrorHandler |
Компонент обработчик ошибок приложения. |
getHomeUrl() общественный метод
| public string getHomeUrl ( ) | ||
|---|---|---|
| return | string |
URL домашней страницы |
getRequest() общественный метод
Возвращает компонент запроса.
| public yii\web\Request getRequest ( ) | ||
|---|---|---|
| return | yii\web\Request |
Компонент запроса. |
getResponse() общественный метод
Возвращает компонент ответа.
| public yii\web\Response getResponse ( ) | ||
|---|---|---|
| return | yii\web\Response |
Компонент ответа. |
getSession() общественный метод
Возвращает компонент сессии.
| public yii\web\Session getSession ( ) | ||
|---|---|---|
| return | yii\web\Session |
Компонент сессии. |
getUser() общественный метод
Возвращает компонент пользователя.
| public yii\web\User getUser ( ) | ||
|---|---|---|
| return | yii\web\User |
Компонент пользователя. |
handleRequest() общественный метод
Обрабатывает указанный запрос.
| public yii\web\Response handleRequest ( $request ) | ||
|---|---|---|
| $request | yii\web\Request |
Запрос, который необходимо обработать |
| return | yii\web\Response |
Полученный ответ |
| throws | yii\web\NotFoundHttpException |
если указанный маршрут недействителен |
setHomeUrl() общественный метод
| public void setHomeUrl ( $value ) | ||
|---|---|---|
| $value | string |
URL домашней страницы |
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-web-application.html
