Абстрактный класс yii\base\Application
| Наследование | yii\base\Application » yii\base\Module » yii\di\ServiceLocator » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Подклассы | yii\console\Application, yii\web\Application |
| Доступно с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/base/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 |
| $charset | строка | Кодировка символов, используемая в приложении. | yii\base\Application |
| $components | массив | Список определений компонентов или загруженных экземпляров компонентов (ID => определение или экземпляр). | yii\di\ServiceLocator |
| $container | массив | Значения, заданные в виде пар имя-значение | yii\base\Application |
| $controller | yii\base\Controller | Текущий активный экземпляр контроллера | yii\base\Application |
| $controllerMap | массив | Сопоставление идентификатора контроллера с конфигурациями контроллера. | yii\base\Module |
| $controllerNamespace | строка | Пространство имен, в котором находятся классы контроллеров. | yii\base\Application |
| $controllerPath | строка | Каталог, содержащий классы контроллеров. | yii\base\Module |
| $db | yii\db\Connection | Подключение к базе данных. | yii\base\Application |
| $defaultRoute | строка | Маршрут по умолчанию этого модуля. | yii\base\Module |
| $errorHandler | yii\web\ErrorHandler|yii\console\ErrorHandler | Компонент приложения для обработки ошибок. | yii\base\Application |
| $extensions | массив | Список установленных расширений Yii. | yii\base\Application |
| $formatter | yii\i18n\Formatter | Компонент приложения для форматирования. | yii\base\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\console\Request | Компонент запроса. | yii\base\Application |
| $requestedAction | yii\base\Action | Запрашиваемое действие. | yii\base\Application |
| $requestedParams | массив | Параметры, переданные запрошенному действию. | yii\base\Application |
| $requestedRoute | строка | Запрашиваемый маршрут | yii\base\Application |
| $response | yii\web\Response|yii\console\Response | Компонент ответа. | yii\base\Application |
| $runtimePath | строка | Каталог для хранения временных файлов. | yii\base\Application |
| $security | yii\base\Security | Компонент приложения для безопасности. | yii\base\Application |
| $sourceLanguage | строка | Язык, на котором написано приложение. | yii\base\Application |
| $state | целое число | Текущее состояние приложения во время обработки запроса. | yii\base\Application |
| $timeZone | string | Часовой пояс, используемый этим приложением. | yii\base\Application |
| $uniqueId | string | Уникальный идентификатор модуля. | yii\base\Application |
| $urlManager | yii\web\UrlManager | Менеджер URL для этого приложения. | yii\base\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\base\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\base\Application |
| getFormatter() | Возвращает компонент форматирования. | yii\base\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\base\Application |
| getResponse() | Возвращает компонент ответа. | yii\base\Application |
| getRuntimePath() | Возвращает директорию, в которой хранятся временные файлы. | yii\base\Application |
| getSecurity() | Возвращает компонент безопасности. | yii\base\Application |
| getTimeZone() | Возвращает часовой пояс, используемый этим приложением. | yii\base\Application |
| getUniqueId() | Возвращает идентификатор, уникально идентифицирующий данный модуль среди всех модулей в текущем приложении. | yii\base\Application |
| getUrlManager() | Возвращает менеджер URL для данного приложения. | yii\base\Application |
| getVendorPath() | Возвращает директорию, в которой хранятся файлы вендоров. | yii\base\Application |
| getVersion() | Возвращает текущую версию модуля. | yii\base\Module |
| getView() | Возвращает объект представления. | yii\base\Application |
| getViewPath() | Возвращает каталог, содержащий файлы представлений для данного модуля. | yii\base\Module |
| handleRequest() | Обрабатывает указанный запрос. | yii\base\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 |
| 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 |
Защищённые методы
| Метод | Описание | Определено в |
|---|---|---|
| bootstrap() | Инициализирует расширения и выполняет компоненты загрузки. | yii\base\Application |
| defaultVersion() | Возвращает версию модуля по умолчанию. | yii\base\Module |
| registerErrorHandler() | Регистрирует компонент errorHandler как обработчик ошибок PHP. | yii\base\Application |
События
| Событие | Тип | Описание | Определено в |
|---|---|---|---|
| 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 |
Константы
| Константа | Значение | Описание | Определено в |
|---|---|---|---|
| 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 |
Подробное описание свойств
$assetManager общедоступное только для чтения свойство
Компонент менеджера активов приложения.
public yii\web\AssetManager getAssetManager ( )
$authManager общедоступное только для чтения свойство
Компонент менеджера авторизации приложения. Возвращает Null, если менеджер авторизации не настроен.
public yii\rbac\ManagerInterface getAuthManager ( )
$bootstrap общедоступное свойство
Список компонентов, которые должны быть запущены во время процесса загрузки приложения bootstrap.
Каждый компонент может быть указан в одном из следующих форматов:
- идентификатор компонента приложения, указанный в $components.
- идентификатор модуля, указанный в $modules.
- имя класса.
- массив конфигурации.
Во время процесса загрузки каждый компонент будет создан. Если класс компонента реализует yii\base\BootstrapInterface, также будет вызван его метод bootstrap().
public array $bootstrap = []
$cache общедоступное только для чтения свойство
Компонент кэширования приложения. Нулевой, если компонент не включен.
public yii\caching\CacheInterface getCache ( )
$charset общедоступное свойство
Кодировка символов, используемая в настоящее время для приложения.
public string $charset = 'UTF-8'
$container общедоступное свойство (только для записи)
Значения, заданные в виде пар имя-значение
public void setContainer ( $config )
$controller общедоступное свойство
Текущая активная инстанция контроллера
public yii\base\Controller $controller = null
$controllerNamespace общедоступное свойство
Пространство имён, в котором находятся классы контроллеров. Это пространство имён будет использоваться для загрузки классов контроллеров путём добавления его к имени класса контроллера. По умолчанию пространство имён равно app\controllers.
Для получения более подробной информации обратитесь к руководству по автоматической загрузке классов.
public string $controllerNamespace = 'app\\controllers'
$db общедоступное только для чтения свойство
Подключение к базе данных.
public yii\db\Connection getDb ( )
$errorHandler общедоступное только для чтения свойство
Компонент обработчика ошибок приложения.
public yii\web\ErrorHandler|yii\console\ErrorHandler getErrorHandler ( )
$extensions общедоступное свойство
Список установленных расширений Yii. Каждый элемент массива представляет собой отдельное расширение со следующей структурой:
[
'name' => 'extension name',
'version' => 'version number',
'bootstrap' => 'BootstrapClassName', // optional, may also be a configuration array
'alias' => [
'@alias1' => 'to/path1',
'@alias2' => 'to/path2',
],
]
Класс «bootstrap», указанный выше, будет создан во время процесса загрузки приложения процесса загрузки приложения. Если класс реализует yii\base\BootstrapInterface, также будет вызван его метод bootstrap().
Если этот параметр не задан явно в конфигурации приложения, он будет заполнен содержимым @vendor/yiisoft/extensions.php.
public array $extensions = null
$formatter общедоступное только для чтения свойство
Компонент форматирования приложения.
public yii\i18n\Formatter getFormatter ( )
$i18n общедоступное только для чтения свойство
Компонент интернационализации приложения.
public yii\i18n\I18N getI18n ( )
$language общедоступное свойство
Язык, который должен использоваться для конечных пользователей. Рекомендуется использовать теги языка IETF. Например, en означает английский язык, а en-US означает английский язык (США).
См. также $sourceLanguage.
public string $language = 'en-US'
$layout общедоступное свойство
Макет, который должен применяться для представлений в этом приложении. По умолчанию — «main». Если значение ложь, макет будет отключён.
public string|boolean $layout = 'main'
$loadedModules общедоступное свойство
Список загруженных модулей, индексированных по их именам классов.
public array $loadedModules = []
$log общедоступное только для чтения свойство
Компонент диспетчера логов приложения.
public yii\log\Dispatcher getLog ( )
$mailer общедоступное только для чтения свойство
Компонент почтовой рассылки приложения.
public yii\mail\MailerInterface getMailer ( )
$name общедоступное свойство
Имя приложения.
public string $name = 'My Application'
$request общедоступное только для чтения свойство
Компонент запроса.
public yii\web\Request|yii\console\Request getRequest ( )
$requestedAction общедоступное свойство
Запрошенное действие. Если null, это означает, что запрос не может быть разрешен в действие.
public yii\base\Action $requestedAction = null
$requestedParams общедоступное свойство
Параметры, переданные запрошенному действию.
public array $requestedParams = null
$requestedRoute общедоступное свойство
Запрошенный маршрут
public string $requestedRoute = null
$response общедоступное только для чтения свойство
Компонент ответа.
public yii\web\Response|yii\console\Response getResponse ( )
$runtimePath общедоступное свойство
Директория, в которой хранятся временные файлы. По умолчанию — подкаталог «runtime» в $basePath.
public string getRuntimePath ( )
public void setRuntimePath ( $path )
$security общедоступное только для чтения свойство
Компонент безопасности приложения.
public yii\base\Security getSecurity ( )
$sourceLanguage общедоступное свойство
Язык, на котором написано приложение. В основном это язык, на котором написаны сообщения и файлы представлений.
См. также $language.
public string $sourceLanguage = 'en-US'
$state общедоступное свойство
Текущее состояние приложения во время обработки запроса. Это свойство управляется приложением. Не изменяйте это свойство.
public integer $state = null
$timeZone общедоступное свойство
Часовой пояс, используемый этим приложением.
public string getTimeZone ( )
public void setTimeZone ( $value )
$uniqueId общедоступное только для чтения свойство
Уникальный идентификатор модуля.
public string getUniqueId ( )
$urlManager общедоступное только для чтения свойство
Менеджер URL для этого приложения.
public yii\web\UrlManager getUrlManager ( )
$vendorPath общедоступное свойство
Директория, в которой хранятся файлы поставщиков. По умолчанию — директория «vendor» в $basePath.
public string getVendorPath ( )
public void setVendorPath ( $path )
$view общедоступное только для чтения свойство
Компонент представления приложения, используемый для рендеринга различных файлов представления.
public yii\base\View|yii\web\View getView ( )
Подробное описание методов
__construct() public method
Конструктор.
| public void __construct ( $config = [] ) | ||
|---|---|---|
| $config | массив |
Параметры в формате «имя-значение», которые будут использованы для инициализации свойств объекта. Обратите внимание, что конфигурация должна содержать как $id, так и $basePath. |
| throws | yii\base\InvalidConfigException | |
bootstrap() protected method
Инициализирует расширения и выполняет компоненты инициализации.
Этот метод вызывается методом init() после полной настройки приложения. Если вы переопределяете этот метод, убедитесь, что вы также вызываете родительскую реализацию.
| protected void bootstrap ( ) |
|---|
coreComponents() public method
Возвращает конфигурацию основных компонентов приложения.
См. также set().
| public void coreComponents ( ) |
|---|
end() public method
Завершает работу приложения.
Этот метод заменяет exit() функцию, гарантируя, что жизненный цикл приложения завершится перед завершением приложения.
| public void end ( $status = 0, $response = null ) | ||
|---|---|---|
| $status | целое число |
Код завершения (значение 0 означает нормальное завершение, другие значения — аномальное завершение). |
| $response | yii\base\Response |
Ответ, который нужно отправить. Если не задано, будет использован компонент ответа $response по умолчанию. |
| throws | yii\base\ExitException |
если приложение находится в тестовом режиме |
getAssetManager() public method
Возвращает менеджер ресурсов.
| public yii\web\AssetManager getAssetManager ( ) | ||
|---|---|---|
| return | yii\web\AssetManager |
Компонент менеджера ресурсов приложения. |
getAuthManager() public method
Возвращает менеджер авторизации для этого приложения.
| public yii\rbac\ManagerInterface getAuthManager ( ) | ||
|---|---|---|
| return | yii\rbac\ManagerInterface |
Компонент менеджера авторизации приложения. Возвращает Null, если менеджер авторизации не настроен. |
getCache() public method
Возвращает компонент кэша.
| public yii\caching\CacheInterface getCache ( ) | ||
|---|---|---|
| return | yii\caching\CacheInterface |
Компонент кэша приложения. Null, если компонент не включен. |
getDb() public method
Возвращает компонент подключения к базе данных.
| public yii\db\Connection getDb ( ) | ||
|---|---|---|
| return | yii\db\Connection |
Подключение к базе данных. |
getErrorHandler() public method
Возвращает компонент обработки ошибок.
| public yii\web\ErrorHandler|yii\console\ErrorHandler getErrorHandler ( ) | ||
|---|---|---|
| return | yii\web\ErrorHandler|yii\console\ErrorHandler |
Компонент обработки ошибок приложения. |
getFormatter() public method
Возвращает компонент форматирования.
| public yii\i18n\Formatter getFormatter ( ) | ||
|---|---|---|
| return | yii\i18n\Formatter |
Компонент форматирования приложения. |
getI18n() public method
Возвращает компонент интернационализации (i18n)
| public yii\i18n\I18N getI18n ( ) | ||
|---|---|---|
| return | yii\i18n\I18N |
Компонент интернационализации приложения. |
getLog() public method
Возвращает компонент диспетчера логов.
| public yii\log\Dispatcher getLog ( ) | ||
|---|---|---|
| return | yii\log\Dispatcher |
Компонент диспетчера логов приложения. |
getMailer() public method
Возвращает компонент почтовой рассылки.
| public yii\mail\MailerInterface getMailer ( ) | ||
|---|---|---|
| return | yii\mail\MailerInterface |
Компонент почтовой рассылки приложения. |
getRequest() public method
Возвращает компонент запроса.
| public yii\web\Request|yii\console\Request getRequest ( ) | ||
|---|---|---|
| return | yii\web\Request|yii\console\Request |
Компонент запроса. |
getResponse() public method
Возвращает компонент ответа.
| public yii\web\Response|yii\console\Response getResponse ( ) | ||
|---|---|---|
| return | yii\web\Response|yii\console\Response |
Компонент ответа. |
getRuntimePath() public method
Возвращает каталог, в котором хранятся временные файлы.
| public строка getRuntimePath ( ) | ||
|---|---|---|
| return | строка |
Каталог, в котором хранятся временные файлы. По умолчанию — подкаталог "runtime" в $basePath. |
getSecurity() public method
Возвращает компонент безопасности.
| public yii\base\Security getSecurity ( ) | ||
|---|---|---|
| return | yii\base\Security |
Компонент безопасности приложения. |
getTimeZone() public method
Возвращает часовой пояс, используемый этим приложением.
Это простой обертка функции PHP date_default_timezone_get(). Если часовой пояс не настроен в php.ini или конфигурации приложения, он будет установлен по умолчанию в UTC.
См. также http://php.net/manual/en/function.date-default-timezone-get.php.
| public строка getTimeZone ( ) | ||
|---|---|---|
| return | строка |
Часовой пояс, используемый этим приложением. |
getUniqueId() public method
Возвращает идентификатор, уникально определяющий этот модуль среди всех модулей текущего приложения.
Поскольку это экземпляр приложения, он всегда будет возвращать пустую строку.
| public строка getUniqueId ( ) | ||
|---|---|---|
| return | строка |
Уникальный идентификатор модуля. |
getUrlManager() public method
Возвращает менеджер URL для этого приложения.
| public yii\web\UrlManager getUrlManager ( ) | ||
|---|---|---|
| return | yii\web\UrlManager |
Менеджер URL для данного приложения. |
getVendorPath() public method
Возвращает директорию, в которой хранятся файлы vendor.
| public string getVendorPath ( ) | ||
|---|---|---|
| return | string |
Директория, в которой хранятся файлы vendor. По умолчанию — директория "vendor" в поддиректории $basePath. |
getView() public method
Возвращает объект view.
| public yii\base\View|yii\web\View getView ( ) | ||
|---|---|---|
| return | yii\base\View|yii\web\View |
Компонент приложения view, используемый для рендеринга различных файлов представлений. |
handleRequest() public abstract method
Обрабатывает указанный запрос.
Этот метод должен возвращать экземпляр yii\base\Response или его дочерний класс, представляющий результат обработки запроса.
| public abstract yii\base\Response handleRequest ( $request ) | ||
|---|---|---|
| $request | yii\base\Request |
Запрос для обработки |
| return | yii\base\Response |
Полученный ответ |
init() public method
Инициализирует модуль.
Этот метод вызывается после создания и инициализации модуля значениями свойств, заданными в конфигурации. По умолчанию он инициализирует $controllerNamespace, если он не задан.
Если вы переопределяете этот метод, убедитесь, что вызываете родительскую реализацию.
| public void init ( ) |
|---|
preInit() public method
Предварительная инициализация приложения.
Этот метод вызывается в начале конструктора приложения. Он инициализирует несколько важных свойств приложения. Если вы переопределяете этот метод, убедитесь, что вызываете родительскую реализацию.
| public void preInit ( &$config ) | ||
|---|---|---|
| $config | array |
Конфигурация приложения |
| throws | yii\base\InvalidConfigException |
если отсутствуют конфигурационные параметры $id или $basePath. |
registerErrorHandler() protected method
Регистрирует компонент errorHandler как обработчик ошибок PHP.
| protected void registerErrorHandler ( &$config ) | ||
|---|---|---|
| $config | array |
Конфигурация приложения |
run() public method
Запуск приложения.
Это главный входной пункт приложения.
| public integer run ( ) | ||
|---|---|---|
| return | integer |
Код завершения (0 означает нормальное завершение, ненулевые значения — аномальное) |
setBasePath() public method
Устанавливает корневую директорию приложения и псевдоним @app.
Этот метод можно вызывать только в начале конструктора.
| public void setBasePath ( $path ) | ||
|---|---|---|
| $path | string |
Корневая директория приложения. |
| throws | yii\base\InvalidParamException |
если директория не существует. |
setContainer() public method (доступно с версии 2.0.11)
Настраивает Yii::$container с помощью $config
| public void setContainer ( $config ) | ||
|---|---|---|
| $config | array |
Значения, заданные в виде пар имя-значение |
setRuntimePath() public method
Устанавливает директорию для хранения файлов runtime.
| public void setRuntimePath ( $path ) | ||
|---|---|---|
| $path | string |
Директория для хранения файлов runtime. |
setTimeZone() public method
Устанавливает часовой пояс, используемый этим приложением.
Это простой обертка над функцией PHP date_default_timezone_set(). Обратитесь к справке PHP для доступных часовых поясов.
См. также http://php.net/manual/en/function.date-default-timezone-set.php.
| public void setTimeZone ( $value ) | ||
|---|---|---|
| $value | string |
Часовой пояс, используемый этим приложением. |
setVendorPath() public method
Устанавливает директорию для хранения файлов vendor.
| public void setVendorPath ( $path ) | ||
|---|---|---|
| $path | string |
Директория для хранения файлов vendor. |
Подробное описание событий
EVENT_AFTER_REQUEST событие типа yii\base\Event
Событие, срабатывающее после успешной обработки запроса приложением (перед отправкой ответа).
EVENT_BEFORE_REQUEST событие типа yii\base\Event
Событие, срабатывающее перед началом обработки запроса приложением.
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-base-application.html