Краткая информация о фреймворке Yii2

Краткая информация о фреймворке Yii2, проект "Большая Библиотека". Приложения. Свойства приложений. Обязательные свойства. Свойство basePath указывает на корневую директорию приложения. Важные свойства: aliases, bootstrap, catchAll, components, controllerMap, controllerNamespace, language, modules, params и др.


Версия фреймворка Yii на которой выполнен проект: 2.0.49

Для справки:
Yii – это высокопроизводительный компонентный PHP фреймворк, предназначенный для быстрой разработки современных веб-приложений. Слово Yii (произносится как Йи [ji:]) в китайском языке означает «простой и эволюционирующий». Также Yii может расшифровываться как акроним Yes It Is!

Файлы для настроек находятся в этой папке:
\config\

Главный файл для настроек:
\config\web.php

Приложения

Приложения это объекты, которые управляют всей структурой и жизненным циклом прикладной системы Yii. Каждая прикладная система Yii включает в себя один объект приложения, который создается во входном скрипте и глобально доступен через \Yii::$app.

Рассмотрим кратко некоторые свойства объекта приложения текущей прикладной системы.

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

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

Обязательные свойства

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

id

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

Пример получения значения свойства:
Yii::$app->id

Результат:
string(5) "basic"


basePath

Свойство basePath указывает на корневую директорию приложения. Эта директория содержит весь защищенный исходный код приложения. В данной директории обычно могут находиться поддиректории models, views, controllers, содержащие код, соответствующий шаблону проектирования MVC.

Вы можете задать свойство basePath используя путь к директории или используя псевдоним пути. В обоих случаях, указанная директория должна существовать, иначе будет выброшено исключение. Путь будет нормализован функцией realpath().

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

Пример получения значения свойства:
Yii::$app->basePath

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

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

aliases

Это свойство позволяет настроить вам множество псевдонимов в рамках массива. Ключами массива являются имена псевдонимов, а значениями массива - соответствующие значения пути. Например: 

[
    'aliases' => [
        '@name1' => 'path/to/path1',
        '@name2' => 'path/to/path2',
    ],
]

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

bootstrap

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

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

  • ID, указанный в компонентах;
  • ID модуля, указанный в модулях;
  • название класса;
  • массив конфигурации;
  • анонимная функция, которая создаёт и возвращает компонент.


Пример получения значения свойства:
Yii::$app->bootstrap

Результат:
array(3) {
  [0]=>
  string(3) "log"
  [1]=>
  string(5) "debug"
  [2]=>
  string(3) "gii"
}


catchAll

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

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

Пример получения значения свойства:
Yii::$app->catchAll

Результат:
NULL


components

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

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

Вы можете зарегистрировать любой компонент в приложении, позже этот компонент будет глобально доступен через выражение \Yii::$app->componentID.

Пример получения значения свойства:
Yii::$app->db
Yii::$app->request

controllerMap

Данное свойство позволяет вам задавать соответствия(mapping) между ID контроллера и произвольным классом контроллера. По умолчанию, Yii задает соответствие между ID контроллера и его классом согласно данному соглашению (таким образом, ID post будет соответствовать app\controllers\PostController ). Задавая эти свойства вы можете переопределить соответствия для необходимых контроллеров. В приведенном ниже примере, account будет соответствовать контроллеру app\controllers\UserController, в то время как article будет соответствовать контроллеру app\controllers\PostController.

Пример получения значения свойства:
Yii::$app->controllerMap

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

controllerNamespace

Данное свойство указывает пространство имен, в котором по умолчанию должны находится названия классов контроллеров. По умолчанию значение равно app\controllers. Если ID контроллера post, то согласно соглашению, соответствующий класс контроллера (без пространства имен) будет равен PostController, а полное название класса будет равно app\controllers\PostController.

Класс контроллера может также находиться в поддиректории директории, соответствующей этому пространству имен. Например, ID контроллера admin/post, будет соответствовать полное имя класса контроллера app\controllers\admin\PostController.

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

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

Пример получения значения свойства:
Yii::$app->controllerNamespace

Результат:
string(15) "app\controllers"


language

Данное свойство указывает язык приложения, на котором содержимое страницы должно быть отображено конечному пользователю. По умолчанию значение данного свойства равно en, что означает "Английский". Если ваше приложение должно поддерживать несколько языков, вы должны настроить данное свойство.

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

Рекомендуется что вы будете указывать язык в рамках стандарта IETF. Например, для английского языка используется en, в то время как для английского в США - en-US.

Пример получения значения свойства:
Yii::$app->language

Результат:
string(2) "ru"


modules

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

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

Пример получения значения свойства:
Yii::$app->modules

name

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

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

Пример получения значения свойства:
Yii::$app->name

Результат:
string(35) "Большая Библиотека"


params

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

Пример получения значения свойства:
Yii::$app->params
Yii::$app->params["adminEmail"]

Результат:
string(17) "admin@bb.inumo.ru"


sourceLanguage

Данное свойство указывает язык на котором написан код приложения. По умолчанию значение равно 'en-US', что означает "Английский" (США). Вы должны настроить данное свойство соответствующим образом, если содержимое в вашем коде является не английским языком.

Аналогично свойству language, вы должны указать данное свойство в рамках стандарта IETF. Например, для английского языка используется en, в то время как для английского в США - en-US.

Пример получения значения свойства:
Yii::$app->sourceLanguage

Результат:
string(5) "ru-RU"


timeZone

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

[
	// Europe/Moscow для России (прим. пер.)
    'timeZone' => 'America/Los_Angeles',
]


Пример получения значения свойства:
Yii::$app->timeZone

Результат:
string(13) "Europe/Moscow"


version

Данное свойство указывает версию приложения. По умолчанию значение равно '1.0'. Вы можете не настраивать это свойство, если ваш код не использует его.

Например:
Yii::$app->version

Результат:
string(3) "1.0"


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

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

charset

Свойство указывает кодировку, которую использует приложение. По умолчанию значение равно 'UTF-8' - должно быть оставлено как есть для большинства приложения, только если вы не работаете с устаревшим кодом, который использует большее количество данных не юникода.

Например:
Yii::$app->charset

Результат:
string(5) "UTF-8"


defaultRoute

Свойство указывает маршрут, который должно использовать приложение, когда он не указан во входящем запросе. Маршрут может состоять из ID модуля, ID контроллера и/или ID действия. Например, help, post/create, admin/post/create. Если действие не указано, то будет использовано значение по умолчанию указанное в yii\base\Controller::$defaultAction.

Для веб приложений, значение по умолчанию для данного свойства равно 'site', что означает контроллер SiteController и его действие по умолчанию должно быть использовано. Таким образом, если вы попытаетесь получить доступ к приложению не указав маршрут, оно покажет вам результат действия app\controllers\SiteController::actionIndex().

Для консольных приложений, значение по умолчанию равно 'help', означающее, что встроенная команда yii\console\controllers\HelpController::actionIndex() должна быть использована. Таким образом, если вы выполните команду yii без аргументов, вам будет отображена справочная информация.

Например:
Yii::$app->defaultRoute

Результат:
string(5) "index"


extensions

Данное свойство указывает список расширений, которые установлены и используются приложением. По-умолчанию, значением данного свойства будет массив, полученный из файла @vendor/yiisoft/extensions.php. Файл extensions.php генерируется и обрабатывается автоматически, когда вы используете Composer для установки расширений. Таким образом, в большинстве случаев вам не нужно настраивать данное свойство.

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

[
    'extensions' => [
        [
            'name' => 'extension name',
            'version' => 'version number',
            'bootstrap' => 'BootstrapClassName',  // опционально, может быть также массив конфигурации
            'alias' => [  // опционально
                '@alias1' => 'to/path1',
                '@alias2' => 'to/path2',
            ],
        ],

        // ... аналогично для остальных расширений ...

    ],
]


Свойство является массивом спецификаций расширений. Каждое расширение указано массивом, состоящим из элементов name и version. Если расширение должно быть выполнено в процессе начальной загрузки, то следует указать bootstrap элемент, который может являться именем класса или конфигурацией. Расширение также может определять несколько псевдонимов.

Например:
Yii::$app->extensions

Например:
Yii::$app->extensions["yiisoft/yii2-bootstrap5"]

Например:
Yii::$app->extensions["yiisoft/yii2-bootstrap5"]["name"]

Результат:
string(23) "yiisoft/yii2-bootstrap5"


layout

Данное свойство указывает имя шаблона по умолчанию, который должен быть использовать при формировании представлений. Значение по умолчанию равно 'main', означающее, что должен быть использован шаблон main.php в папке шаблонов. Если оба свойства папка шаблонов и папка представлений имеют значение по умолчанию, то файл шаблона по умолчанию может быть представлен псевдонимом пути как @app/views/layouts/main.php.

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

Пример получения значения свойства:
Yii::$app->layout

Результат:
string(4) "book"


layoutPath

Свойство указывает путь, по которому следует искать шаблоны. Значение по умолчанию равно layouts, означающее подпапку в папке представлений. Если значение папки представлений является значением по умолчанию, то папка шаблонов по умолчанию может быть представлена псевдонимом пути как @app/views/layouts.

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

Пример получения значения свойства:
Yii::$app->layoutPath

runtimePath

Свойство указывает путь, по которому хранятся временные файлы, такие как: лог файлы, кэш файлы. По умолчанию значение равно папке, которая представлена псевдонимом пути @app/runtime.

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

Для упрощения работы с данной папкой, Yii предоставляет предопределенный псевдоним пути @runtime.

Пример получения значения свойства:
Yii::$app->runtimePath

viewPath

Данное свойство указывает базовую папку, где содержаться все файлы представлений. Значение по умолчанию представляет собой псевдоним @app/views. Вы можете настроить данное свойство как папку так и как псевдоним.

Пример получения значения свойства:
Yii::$app->viewPath

vendorPath

Свойство указывает папку сторонних библиотек, которые используются и управляются Composer. Она содержит все сторонние библиотеки используемые приложением, включая Yii фреймворк. Значение по умолчанию представляет собой псевдоним @app/vendor.

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

Для упрощения работы с данной папкой, Yii предоставляет предопределенный псевдоним пути @vendor.

Пример получения значения свойства:
Yii::$app->vendorPath

enableCoreCommands

Данное свойство поддерживается только консольными приложениями. Оно указывает нужно ли использовать встроенные в Yii консольные команды. Значение по умолчанию равно true.

Здесь много ссылок на материалы для изучения Yii2:
Инструкция для Администратора


Спасибо за внимание!