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

Жизненный цикл приложения начинается с файла - index.php, который является единственной точкой входа (есть исключения такие как: Cron (Планировщик задач), запуск скриптов обновления), другими словами все запросы поступающие от клиентов направляются прямо в этот файл (реализация паттерна - Front controller). Такое поведение задано с помощью директив файла .htaccess который находится в корне приложения и имеет следующие настройки:

Options +FollowSymLinks
RewriteEngine On

RewriteCond %{REQUEST_URI} !^/index\.php
RewriteCond %{REQUEST_URI} !/ow_updates/index\.php
RewriteCond %{REQUEST_URI} !/ow_updates/
RewriteCond %{REQUEST_URI} !/ow_cron/run\.php
RewriteCond %{REQUEST_URI} !/e500\.php
RewriteCond %{REQUEST_URI} !/captcha\.php
#RewriteCond %{REQUEST_URI} (/|\.php|\.html|\.htm|\.xml|\.feed|robots\.txt|\.raw|/[^.]*)$  [NC]
RewriteCond %{REQUEST_FILENAME} (/|\.php|\.html|\.htm|\.xml|\.feed|robots\.txt|\.raw|/[^.]*)$  [NC]
RewriteRule (.*) index.php

Инициализация программного окружения¶

После того как запрос был передан в файл index.php в нем начинается серия инициализаций программного окружения.

Определение констант.
Инициализация автолоадеров.
Инициализация профайлера.
Инициализация логирования.
Инициализация сессий.

Инициализация приложения¶

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

Определение контекста приложения¶

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

Инициализация плагинов¶

На данном этапе у каждого установленного и активного плагина вызывается файл init.php (подробнее про структуру плагина - Структура плагина) который регистрирует ресурсы плагина, такие как : маршрутизация контроллеров (подробнее в разделе - Маршрутизация и контроллеры), системные события, регистрация автолоадеров итд). Внимание в файле инициализации плагинов не должны выполняться тяжелые операции, их лучше зарегистрировать в файле обработки системных событий.

После инициализации плагинов срабатывает системное событие которое оповещает приложение о том, что инициализация плагинов закончена:

<?php

$event = new OW_Event(OW_EventManager::ON_PLUGINS_INIT);
OW::getEventManager()->trigger($event);

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

<?php

class MYSUPERPLUGIN_CLASS_EventHandler
{
    public function genericInit()
    {
      OW::getEventManager()->bind(OW_EventManager::ON_PLUGINS_INIT, array($this, 'afterPluginsInit'));
    }

    public function afterPluginsInit()
    {
        // do something...
    }
}

Инициализация темы¶

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

<?php

$activeThemeName = OW::getEventManager()->call('base.get_active_theme_name');
$activeThemeName = $activeThemeName ? $activeThemeName : OW::getConfig()->getValue('base', 'selectedTheme');

Меняем дефолтную тему

<?php

class MYSUPERPLUGIN_CLASS_EventHandler
{
    public function genericInit()
    {
      OW::getEventManager()->bind(‘base.get_active_theme_name’, array($this, 'changeTheme'));
    }

    public function changeTheme()
    {
        return ‘new_theme_name’;
    }
}

Инициализация объекта ответа¶

В самом конце инициализации приложения, создается объект ответа “Response”, который и будет в последствии возвращен клиенту. В этом объекте содержаться заголовки ответа, которые можно менять по ходу жизненного цикла приложения. А также объект документ “Document”, который содержит непосредственно сгенерированный html (json, xml, итд. все зависит от контекста прилождения) код. Сторонние плагины имеют возможность изменять содержимое объекта документ, для этого существует ряд системных событий

Событие срабатывает, перед отправкой сгенерированного контента клиенту

<?php

$event = new OW_Event(OW_EventManager::ON_BEFORE_DOCUMENT_RENDER);
OW::getEventManager()->trigger($event);

Событие срабатывает, после отправки сгенерированного контента клиенту

<?php

$event = new OW_Event(OW_EventManager::ON_AFTER_DOCUMENT_RENDER);
OW::getEventManager()->trigger($event);

После инициализации приложения срабатывает событие:

<?php

$event = new OW_Event(OW_EventManager::ON_APPLICATION_INIT);
OW::getEventManager()->trigger($event);

Маршрутизация¶

После инициализации приложения, oxwall пытается определить название контроллера, и метода которому нужно передать управление. Для этого сравнивается URI объекта Request со списком зарегистрированных маршрутов. Если маршрут не найден то генерируется исключительная ситуация и идет перенаправление на контроллер отображающий 404 ошибку. После того, как приложение определило нужный маршрут срабатывает системное событие:

<?php

$event = new OW_Event(OW_EventManager::ON_AFTER_ROUTE);

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

Обработка контроллера¶

На данном этапе идет создание объекта контроллера и вызов метода init внутри него (метод используется для инициализации окружения контроллера, загрузки ресурсов итд), а также вызов метода (action) внутри контроллера в котором и сосредоточена вся логика запроса. Если в методе контроллера не инициализирован файл представления (view)

<?php

class MYSUPERPLUGIN_CTRL_Base extends OW_ActionController
{
  function test()
  {
      OW::getDocument()->setTemplate(OW::getPluginManager()->getPlugin('mysuperplugin')->getRootDir() . 'views/controllers/custom.html');
  }
}

То приложение попытается найти нужный шаблон самостоятельно, используя название контроллера и метода, к примеру my_controller_test.html и добавить его в метод контроллера. После того как, контроллер отработал срабатывает системное сообщение:

<?php

  $event = new OW_Event(OW_EventManager::ON_AFTER_REQUEST_HANDLE);

Компиляция и отправка сгенерированного документа¶

После того, как приложение получило контент от метода контроллера оно обрамляет полученный контент другим файлом представления - master page (Реализация паттерна Decorator) В коде контроллера можно легко подменять master page :

<?php

class MYSUPERPLUGIN_CTRL_Base extends OW_ActionController
{
  function test()
  {
        // change the master page
        OW::getDocument()->getMasterPage()->
                setTemplate(OW::getPluginManager()->getPlugin('mysuperplugin')->getRootDir() . 'views/master_pages/custom.html');
  }
}

После обрамления контента он отправляется клиенту и срабатывает событие:

<?php

$event = new OW_Event(OW_EventManager::ON_FINALIZE);

В самом конце, жизненного цикла приложения срабатывает систменое сообщение

<?php

$event = new OW_Event('core.exit');