yii2 что такое app

Applications ¶

Info: Depending on the context, when we say «an application», it can mean either an application object or an application system.

There are two types of applications: Web applications and console applications. As the names indicate, the former mainly handles Web requests, while the latter handles console command requests.

Application Configurations ¶

When an entry script creates an application, it will load a configuration and apply it to the application, as follows:

Like normal configurations, application configurations specify how to initialize properties of application objects. Because application configurations are often very complex, they usually are kept in configuration files, like the web.php file in the above example.

Application Properties ¶

There are many important application properties that you should configure in application configurations. These properties typically describe the environment that applications are running in. For example, applications need to know how to load controllers, where to store temporary files, etc. In the following, we will summarize these properties.

Required Properties ¶

In any application, you should at least configure two properties: id and basePath.

The id property specifies a unique ID that differentiates an application from others. It is mainly used programmatically. Although not a requirement, for best interoperability it is recommended that you use only alphanumeric characters when specifying an application ID.

basePath ¶

You may configure the basePath property using a directory path or a path alias. In both forms, the corresponding directory must exist, or an exception will be thrown. The path will be normalized by calling the realpath() function.

The basePath property is often used to derive other important paths (e.g. the runtime path). For this reason, a path alias named @app is predefined to represent this path. Derived paths may then be formed using this alias (e.g. @app/runtime to refer to the runtime directory).

Important Properties ¶

The properties described in this subsection often need to be configured because they differ across different applications.

aliases ¶

This property allows you to define a set of aliases in terms of an array. The array keys are alias names, and the array values are the corresponding path definitions. For example:

This property is provided so that you can define aliases in terms of application configurations instead of by calling the Yii::setAlias() method.

bootstrap ¶

This is a very useful property. It allows you to specify an array of components that should be run during the application bootstrapping process. For example, if you want a module to customize the URL rules, you may list its ID as an element in this property.

Each component listed in this property may be specified in one of the following formats:

Info: If a module ID is the same as an application component ID, the application component will be used during the bootstrapping process. If you want to use the module instead, you may specify it using an anonymous function like the following:

During the bootstrapping process, each component will be instantiated. If the component class implements yii\base\BootstrapInterface, its bootstrap() method will also be called.

Another practical example is in the application configuration for the Basic Project Template, where the debug and gii modules are configured as bootstrapping components when the application is running in the development environment:

Note: Putting too many components in bootstrap will degrade the performance of your application because for each request, the same set of components need to be run. So use bootstrapping components judiciously.

catchAll ¶

This property is supported by Web applications only. It specifies a controller action which should handle all user requests. This is mainly used when the application is in maintenance mode and needs to handle all incoming requests via a single action.

The configuration is an array whose first element specifies the route of the action. The rest of the array elements (key-value pairs) specify the parameters to be bound to the action. For example:

Info: Debug panel on development environment will not work when this property is enabled.

components ¶

This is the single most important property. It allows you to register a list of named components called application components that you can use in other places. For example:

Each application component is specified as a key-value pair in the array. The key represents the component ID, while the value represents the component class name or configuration.

Please read the Application Components section for details.

controllerMap ¶

The array keys of this property represent the controller IDs, while the array values represent the corresponding controller class names or configurations.

controllerNamespace ¶

It is important that the fully qualified controller classes should be autoloadable and the actual namespace of your controller classes match the value of this property. Otherwise, you will receive a «Page Not Found» error when accessing the application.

In case you want to break the convention as described above, you may configure the controllerMap property.

language ¶

The value of this property determines various internationalization aspects, including message translation, date formatting, number formatting, etc. For example, the yii\jui\DatePicker widget will use this property value by default to determine in which language the calendar should be displayed and how the date should be formatted.

It is recommended that you specify a language in terms of an IETF language tag. For example, en stands for English, while en-US stands for English (United States).

More details about this property can be found in the Internationalization section.

modules ¶

This property specifies the modules that the application contains.

The property takes an array of module classes or configurations with the array keys being the module IDs. For example:

Please refer to the Modules section for more details.

This property specifies the application name that may be displayed to end users. Unlike the id property, which should take a unique value, the value of this property is mainly for display purposes; it does not need to be unique.

You do not always need to configure this property if none of your code is using it.

params ¶

This property specifies an array of globally accessible application parameters. Instead of using hardcoded numbers and strings everywhere in your code, it is a good practice to define them as application parameters in a single place and use the parameters in places where needed. For example, you may define the thumbnail image size as a parameter like the following:

Then in your code where you need to use the size value, you can simply use code like the following:

Later if you decide to change the thumbnail size, you only need to modify it in the application configuration; you don’t need to touch any dependent code.

sourceLanguage ¶

Like the language property, you should configure this property in terms of an IETF language tag. For example, en stands for English, while en-US stands for English (United States).

More details about this property can be found in the Internationalization section.

timeZone ¶

This property is provided as an alternative way of setting the default time zone of the PHP runtime. By configuring this property, you are essentially calling the PHP function date_default_timezone_set(). For example:

For more details on the implications of setting the time zone, please check the section on date formatting.

version ¶

Useful Properties ¶

The properties described in this subsection are not commonly configured because their default values derive from common conventions. However, you may still configure them in case you want to break the conventions.

charset ¶

defaultRoute ¶

extensions ¶

In the special case when you want to maintain extensions manually, you may configure this property as follows:

As you can see, the property takes an array of extension specifications. Each extension is specified with an array consisting of name and version elements. If an extension needs to run during the bootstrap process, a bootstrap element may be specified with a bootstrapping class name or a configuration array. An extension may also define a few aliases.

layout ¶

You may configure this property to be false if you want to disable layout by default, although this is very rare.

layoutPath ¶

You may configure it as a directory or a path alias.

runtimePath ¶

You may configure it as a directory or a path alias. Note that the runtime path must be writable by the process running the application. And the path should be protected from being accessed by end users, because the temporary files under it may contain sensitive information.

To simplify access to this path, Yii has predefined a path alias named @runtime for it.

viewPath ¶

vendorPath ¶

You may configure this property as a directory or a path alias. When you modify this property, make sure you also adjust the Composer configuration accordingly.

To simplify access to this path, Yii has predefined a path alias named @vendor for it.

enableCoreCommands ¶

Application Events ¶

An application triggers several events during the lifecycle of handling a request. You may attach event handlers to these events in application configurations as follows:

The use of the on eventName syntax is described in the Configurations section.

Alternatively, you may attach event handlers during the bootstrapping process after the application instance is created. For example:

EVENT_BEFORE_REQUEST ¶

When this event is triggered, the application instance has been configured and initialized. So it is a good place to insert your custom code via the event mechanism to intercept the request handling process. For example, in the event handler, you may dynamically set the yii\base\Application::$language property based on some parameters.

EVENT_AFTER_REQUEST ¶

When this event is triggered, the request handling is completed and you may take this chance to do some postprocessing of the request or customize the response.

Note that the response component also triggers some events while it is sending out response content to end users. Those events are triggered after this event.

EVENT_BEFORE_ACTION ¶

The event parameter is an instance of yii\base\ActionEvent. An event handler may set the yii\base\ActionEvent::$isValid property to be false to stop running the action. For example:

EVENT_AFTER_ACTION ¶

The event parameter is an instance of yii\base\ActionEvent. Through the yii\base\ActionEvent::$result property, an event handler may access or modify the action result. For example:

Application Lifecycle ¶

When an entry script is being executed to handle a request, an application will undergo the following lifecycle:

Источник

Есть два типа приложений: веб-приложения и консольные приложения. Как следует из названия, первый обрабатывает веб-запросы, в то время как последний обрабатывает запросы команд в консоли.

Конфигурация приложений

Когда входной скрипт создает приложение, он загружает конфигурацию и применяет ее следующим образом:

Конфигурация приложения определяет, как инициализировать свойства объектов приложения. Поскольку конфигурация приложения очень часто сложна, она обычно сохраняется в конфигурационных файлах, таких как web.php.

Свойства приложений

Существует много важных свойств приложения, которые должны быть сконфигурированы. Эти свойства обычно описывают среду, в которой работают приложения. Например, приложения должны знать, как загрузить контроллеры, где хранить временные файлы и т.д.

Необходимые свойства:

В любом приложении, вы должны сконфигурировать хотя бы по крайней мере два свойства: id и basePath

Свойство basePath часто используется, чтобы получить другие важные пути (например, путь во время выполнения). Поэтому псевдоним пути, названный @app, предопределен, чтобы представлять этот путь. Полученные пути могут тогда быть сформированы, используя этот псевдоним (например, @app/runtime, чтобы обратиться к каталогу во время выполнения).

Важные свойства:

Описанные здесь свойства должны быть настроены, так как они различаются в различных приложениях.

Эта свойство обеспечено так, чтобы вы могли определить псевдоним в условиях конфигурации приложения, а не при помощи вызова метода Yii::setAlias().

Каждый компонент, перечисленный в этом свойстве, может быть указан в одном из следующих форматов:

Во время процесса самонастройки, каждый компонент будет экземпляром. Если класс реализует компонент yii\base\BootstrapInterface, его метод bootstrap() также будет называться.

Другим практическим примером может служить конфигурация приложения для Basic Project Template, где модули debug и gii сконфигурированы как загружающиеся компоненты, когда приложение работает в среде разработки:

Конфигурация представляет собой массив, первый элемент определяет маршрут действия. Остальные элементы массива (пара ключ-значение) задают параметры, которые будут связаны с действием. Например:

Каждый компонент приложения задается в виде пары ключ-значение в массиве. Ключ представляет идентификатор компонента, а значение представляет собой имя класса компонента или конфигурации.

Ключи массива этого свойства представляют идентификаторы контроллеров, в то время как значения массива представляют соответствующие имена классов контроллера или конфигурации.

Важно, чтобы полностью определенные классы контроллера были автозагружаемыми, а пространство имен классов контроллера соответствовало значению этого свойства. В противном случае вы получите ошибку «Page Not Found» при обращении к приложению.

Затем в коде, где вам нужно использовать значение размера, вы можете просто использовать следующее:

Это свойство определяет язык, код приложения записывается в. Значение по умолчанию, что означает по-английски (Соединенные Штаты Америки). Вы должны настроить это свойство, если содержание текста в коде не на английском языке.

Полезные свойства

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

События приложений

Приложение запускает несколько событий в течение всего жизненного цикла обработки запроса. Вы можете прикрепить обработчики событий к этим событиям в конфигурации приложения следующим образом:

Кроме того, вы можете прикрепить обработчики событий во время процесса самонастройки после создания экземпляра приложения. Например:

EVENT_BEFORE_REQUEST

Это событие вызывается, прежде чем приложение обработает запрос. Актуальное имя события beforeRequest.

Когда это событие срабатывает, то экземпляр приложения сформирован и инициализирован. Так что, это хорошее место, чтобы вставить свой код перехвата процесса обработки запросов через механизм событий. Например, в обработчике событий вы можете динамически установить yii\base\Application::$language событие основанное на некоторых параметров.

EVENT_AFTER_REQUEST

Это событие инициируется после того, как приложение завершит обработку запроса, но перед отправкой ответа. Актуальное имя события afterRequest. Когда это событие срабатывает, обработка запроса будет завершена, и вы можете воспользоваться этой возможностью, чтобы сделать некоторые постобработки запроса или настроить ответ.

Обратите внимание, что компонент response также вызывает некоторые события, в то время как он посылает содержимое ответа конечным пользователям. Эти события вызываются после этого события.

EVENT_BEFORE_ACTION

Это событие инициируется перед запуском каждого действия контроллера. Актуальное имя событие beforeAction.

EVENT_AFTER_ACTION

Это событие инициируется после выполнения каждого действия контроллера. Актуальное имя события afterAction.

Источник

Как работает Yii::app()?

1. Инициализация Yii::app()

Смотри, в файле www/index.php такие строки

При отработке строки 2 выполняется код

В строке 12 с учётом динамического связывания выполняется return new CWebApplication($config);

Это была инициализация

2. Использование Yii::app()->module или Yii::app()->component

Ещё раз посмотри на класс CApplication

В методе configure($config) происходит подготовка данных, которые понадобятся позже для таких вызовов как (к примеру) Yii::app()->db

Давай посмотрим на класс Module, в котором и реализуется логика таких вызовов

Попробуем расшифровать вызов Yii::app()->db

Посмотрим, что делает Yii::createComponent($config)

Cложный метод. Суть его в инстанциировании новой сущности какого-то класса, 5 или 6 способов. Дело в том, что этот метод CModule::createComponent() может быть вызван откуда угодно и у него куча вариантов передачи параметров.

Итак, CModule::createComponent() создал и вернул новую сущность. И на выходе из метода CModule::getComponent() полученная сущность записывается в массив CModule->_components под именем ‘db’.

Все последующие вызовы Yii::app()->db будут проверять наличие инстанциинованной сущности в массиве CModule->_components[‘db’] и использовать его, если он там найден

Вызов Yii::app()->db
А. Динамически инициализирует компоненту, по мере необходимости
Б. Настраивает её данными, которые в частновти можно определить через файл конфигурации protected/config/main.php
В. Инициализируют компоненту только один раз за цикл работы PHP приложения

Надеюсь я понятно изложил механизм ленивой инициализации компонент

Источник

Yii2 что такое app

Info: В зависимости от контекста, когда мы говорим «приложение», это может означать как объект приложения так и приложение как прикладную систему в целом.

Когда входной скрипт создаёт приложение, он загрузит конфигурацию и применит её к приложению, например:

Существует много важных свойств приложения, которые вы настраиваете в конфигурациях приложения. Эти свойства обычно описывают окружение, в котором работает приложение. Например, приложение должно знать каким образом загружать контроллеры, где хранить временные файлы, и т. д. Ниже мы рассмотрим данные свойства.

В любом приложении, вы должны настроить минимум два свойства: [[yii\base\Application::id|id]] и [[yii\base\Application::basePath|basePath]].

Свойство [[yii\base\Application::id|id]] это уникальный индекс приложения, который отличает его от других приложений. В основном это используется внутрисистемно. Хоть это и не обязательно, но для лучшей совместимости рекомендуется использовать буквенно-цифровые символы при указании индекса приложения.

Свойство [[yii\base\Application::basePath|basePath]] часто используется для указания других важных путей (например, путь к директории runtime, используемой приложением). По этой причине, псевдоним пути @app предустановлен и содержит данный путь. Производные пути могут быть получены с использованием этого псевдонима пути (например, @app/runtime указывает на временную директорию runtime).

Свойства, указанные в этом подразделе, часто нуждаются в предварительной настройке т.к. они разнятся от приложения к приложению.

Это свойство доступно таким образом, чтобы вы могли указывать псевдонимы в рамках конфигурации приложения, а не вызовов метода [[Yii::setAlias()]].

Данное свойство является очень удобным, оно позволяет указать массив компонентов, которые должны быть загружены в процессе [[yii\base\Application::bootstrap()|начальной загрузки]] приложения. Например, если вы хотите, чтобы модуль производил тонкую настройку URL правил, вы можете указать его ID в качестве элемента данного свойства.

Каждый из элементов данного свойства, может быть указан в одном из следующих форматов:

Info: Если ID модуля такой же, как идентификатор компонента приложения, то в процессе начальной загрузки будет использован компонент приложения. Если Вы вместо этого хотите использовать модуль, то можете указать его при помощи анонимной функции похожей на эту:

В процессе начальной загрузки, каждый компонент будет создан. Если класс компонента имеет интерфейс [[yii\base\BootstrapInterface]], то также будет вызван метод [[yii\base\BootstrapInterface::bootstrap()|bootstrap()]].

Еще одним практическим примером является конфигурация базового шаблона приложения, в котором модули debug и gii указаны как bootstrap компоненты, когда приложение находится в отладочном режиме.

Note: Указывание слишком большого количества компонентов в bootstrap приведет к снижению производительности приложения, потому что для каждого запроса одно и то же количество компонентов должно быть загружено. Таким образом вы должны использовать начальную загрузку разумно.

Данное свойство поддерживается только [[yii\web\Application|веб приложениями]]. Оно указывает действие контроллера, которое должно обрабатывать все входящие запросы от пользователя. В основном это используется, когда приложения находится в режиме обслуживания и должно обрабатывать все запросы через одно действие.

Конфигурация это массив, первый элемент которого, определяет маршрут действия. Остальные элементы в формате пара ключ-значение задают дополнительные параметры, которые должны быть переданы действию (методу контроллера actionXXX). Например,

Данное свойство является наиболее важным. Оно позволяет вам зарегистрировать список именованных компонентов, называемых компоненты приложения, которые Вы можете использовать в других местах. Например,

Каждый компонент приложения указан массивом в формате ключ-значение. Ключ представляет собой ID компонента приложения, в то время как значение представляет собой название класса или конфигурацию.

Более подробная информация приведена в разделе Компоненты приложения.

Ключами данного свойства являются ID контроллеров, а значениями являются соответствующие названия классов(полное название класса с пространством имен) контроллера или конфигурация.

Очень важно, чтобы полное имя класса контроллера могло быть использовано автозагрузкой и соответствующее пространство имен вашего контроллера соответствовало данному свойству. Иначе, Вы получите ошибку «Страница не найдена», при доступе к приложению.

В случае, если вы хотите переопределить соответствия как описано выше, вы можете настроить свойство controllerMap.

Значение данного свойства определяется различными аспектами интернационализации, в том числе переводом сообщений, форматированием дат, форматированием чисел, и т. д. Например, виджет [[yii\jui\DatePicker]] использует данное свойство для определения по умолчанию языка, на котором должен быть отображен календарь и формат данных для календаря.

Более детальная информация приведена в разделе Интернационализация.

Данное свойство указывает модули, которые содержатся в приложении.

Более детальная информация приведена в разделе Модули.

Свойство указывает название приложения, которое может быть показано конечным пользователям. В отличие от свойства [[yii\base\Application::id|id]], которое должно быть уникальным, значение данного свойства нужно в основном для отображения и не обязательно должно быть уникальным.

Если ваш код не использует данное свойство, то вы можете не настраивать его.

Данное свойство указывает массив глобально доступных параметров приложения. Вместо того, чтобы использовать жестко фиксированные числа и строки в вашем коде, лучше объявить их параметрами приложения в едином месте и использовать в нужных вам местах кода. Например, вы можете определить размер превью для изображений следующим образом:

Затем, когда вам нужно использовать данные значения в вашем коде, вы делаете это как представлено ниже:

Если позже вам понадобится изменить размер превью изображений, вам нужно только изменить это значение в настройке приложения, не касаясь зависимого кода.

Более детальная информация приведена в разделе Интернационализация.

Данное свойство предоставляет альтернативный способ установки временной зоны в процессе работы приложения. Путем указания данного свойства, вы по существу вызываете PHP функцию date_default_timezone_set(). Например,

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

В особых случаях, когда вы хотите обрабатывать расширения в ручную, вы можете указать данное свойство следующим образом:

Вы можете настроить данное свойство как папку так и как псевдоним.

Вы можете настроить данное свойство как папку или как псевдоним пути. Обратите внимание, что данная папка должна быть доступна для записи, процессом, который запускает приложение. Также папка должна быть защищена от доступа конечными пользователями, хранимые в ней временные файлы могут содержать важную информацию.

Вы можете настроить данное свойство как папку так и как псевдоним. При изменении данного свойства, убедитесь что вы также изменили соответствующим образом настройки Composer.

В течение жизненного цикла приложения, возникает несколько событий. Вы можете назначать обработчики событий в конфигурации приложения следующим образом:

Использование синтаксиса on eventName детально описано в разделе Конфигурации.

Также вы можете назначить обработчики событий в процессе начальной загрузки приложения, сразу после того как приложение будет создано. Например,

На момент возникновения данного события, объект приложения уже создан и проинициализирован. Таким образом, это является хорошим местом для вставки вашего кода с помощью событий, для перехвата управления обработкой запроса. Например, обработчик события, может динамически подставлять язык приложения [[yii\base\Application::language]] в зависимости от некоторых параметров.

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

Обратите внимание, что в компоненте [[yii\web\Response|response]] также возникают события в процессе отправки данных конечному пользователю. Эти события возникают после текущего события.

Событие является объектом [[yii\base\ActionEvent]]. Обработчик события может устанавливать свойство [[yii\base\ActionEvent::isValid]] равным false для предотвращения выполнения действия.

Событие является объектом [[yii\base\ActionEvent]]. Через свойство [[yii\base\ActionEvent::result]] обработчик события может получить доступ и изменить значение выполнения действия контроллера.

Жизненный цикл приложения

Когда входной скрипт выполняется для обработки запроса, приложение будет развиваться согласно следующему жизненному циклу:

Источник