YII2 Как создать гибкую модульную архитектуру?

Question

[Screamie Di]

Всем привет! Разрабатываю проект на YII2 и нужна ваша помощь в понимании архитектуры модулей и маршрутизации.

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

Допустим у нас есть модуль Pages который отвечает, за работу со всеми страницами на сайте. Он формирует древо страниц и их URL-ы (в зависимости от вложенности и alias-ов которые придумал админ), и подключает к ним шаблоны и контент. И допустим в панели администратора мы создаем следующую структуру страниц:

• Главная (alias: /home)
  
• О компании (alias: /about)
  
• Новости (alias: /news)
  
• Контакты (alias: /contact)
  

В БД в таблице Page у нас появляются 4 записи

id | alias | name
---------------------------------
1 | /home | Главная
2 | /about | О компании
3 | /news | Новости
4 | /contact | Контакты

Пока страниц всего 4 можно сделать отдельные action в SiteController, но представим, что у нас много страниц и этот вариант не подходит.

Создаем PageController и изменяем маршрутизатор так, что бы он сначала искал страницы в БД по нашему alias и если нашел страницу с таким URL то отсылал на PageController::actionPage(), где бы мы доставали нужную страницу из базы, определяли ее шаблон, вставляли контент и выводили все это дело на фронт. А если нет, то искал controller/action в зависимости от URL-rules и выполнял его логику.

Но на странице Новости у нас должен работать модуль новостей, которые хранятся в отдельной таблице news, т.к. их может быть не одна сотня или этого модуля может не быть вообще. И у модуля news есть свой контроллер, который обеспечивает сортировку новостей по тегам, датам и любой другой функционал. К примеру NewsController::actionFindByTag() или NewsController::actionMostPopular().

И вот тут у меня возникает головная боль с маршрутами. Можно зашить дополнительное поле action, в таблицу template, которая отвечает за шаблоны страниц и чекать URL по нему. То есть если у страницы есть шаблон и его action != null
тогда уходим НЕ на PageController::actionPage(), а подставляем значение action и уходим по нему.

Теперь вроде все в порядке, пользователь набирает в адресе sitename.ru/news мы ищем эту страницу в БД, находим у нее template.action который равен news/index и уходим на NewsController::actionIndex(). И вот тут и таится проблема. Если админ изменит alias страницы Новости, например на /events, то по запросу sitename.ru/events он все равно попадет
на NewsController::actionIndex(), что нам и надо, но вот если он на странице новостей кликнет на "Показать популярные", которая должна вести на NewsController::actionMostPopular(), то единственный способ это указать контроллер и action напрямую, как news/most-popular. Соответственно происходит необоснованное изменение адресов с /events на /news/most-popular.

Резюмируя этот огромный вопрос. Не могу понять, как организовать модули с их логикой, рядом с обычными страницами без логики, и при этом что бы в панели администратора Админ мог изменять alias-ы страниц, их вложенность и прочее. Но функционал модулей сохранялся бы.

Заранее спасибо!

UPD:
Пока сошлись на том, что нужно определять принадлежность модуля к странице и как-то парсить URL в UrlManager::ParseRequest().

Хочу выразить огромное спасибо Дмитрию Елисееву, за помощь, он предложил следующий вариант парсинга URL:

В parseRequest:

- Ищем /city/events/most-popular. Не нашлось.
- Ищем /city/events. Нашлось. Тип "news". Запускаем рекурсию:

$r = clone $request;
$r->setPathInfo('news/most-popular');
return $manager->parseRequest($r);

Пока не знаю подойдет ли этот метод, но буду пробовать его. Отпишусь здесь, когда проверю. Если у кого-то есть идеи, то буду очень признателен, за помощь.

Comments

[Владимир Солдатов]

Почему скажем у страницы в поле ссылка(или сделать отдельное поле) не писать имя класса. При парсинге урла этой страницы кушать это поле и соответсвенно перенаправлять\рендерить\что то еще делать с именем класса. Записывать класс можно так же не руками а выбирая из какого списка модулей\виджетов и т.д.

[Screamie Di]

Владимир Солдатов: спасибо за ответ, но если хранить имя класса, то не получится парсить URL rules. Загвоздка в том, что нужно отделить уровень вложенности в админке, от рулсов в модуле. Поэтому рекурсия и нужна. Но рекурсия затратный процесс и сейчас размышляю над тем, не создать ли связанную таблицу, где хранить динамически формируемый URL для модуля по которому и чекать.

[Владимир Солдатов]

Парсинг урла производить не через конфиг а через собственный класс.

use Yii;
use \yii\web\UrlRule;

class ExampleUrlRule extends UrlRule {

    public $pattern = 'new';
    public $route = 'new';

    public function createUrl($manager, $route, $params) {

        return false;
    }

    public function parseRequest($manager, $request) {
		//ваш код который может делать что угодно
		return ['/blabla/blabla', []];
    }

}

Далее в конфиге указываете класс вместо правила

'rules'               => [ 
....
['class' => 'some\path\ExampleUrlRule '],
...
]

Не вижу проблем перенаправить туда куда необходимо. И передать скажем параметром тот самый хранимый класс и сделать с ним, что угодно или передать уже готовый объект.

[Screamie Di]

Владимир Солдатов: Понял вашу мысль, на самом деле сам сначала пытался реализовать именно так, через свой класс. И передавал в контроллер сформированный объект Page, работало неплохо, пока дело не дошло до фильтрации и изменения URL в админ панели.

Когда пользователь использует фильтр вида /news/most-popular/2016, то первым делом в Базе ищется страница с URL = /news/most-popular/2016 и естественно ее там нет. Если бы не требовались динамические модули, то дело было бы за малым - написать отдельный Рул для фильтрации и отправлять на модуль. Но станица News в админке может быть перенесена.

И адрес /news/most-popular/2016 для которого мы пропишем правила может стать /company/about/news/most-popular/2016 и соответственно правила перестанут работать, скрипт пойдет искать страницу в базу и попадем на 404. Сложность не в том, что бы передать управление на модуль, когда страница найдена. Сложность в том, что бы найти страницу по URL включающему любые фильтры и вложенность, не используя urlRules, т.к. URL формируется админом. Для этого и была предложена рекурсия в parseRequest() собственно, ваше предложение тоже упирается в кастомный parseRequest(), просто вы предлагаете вынести его в отдельный класс UrlRules.

Когда мы находим страницу через рекурсию (в варианте Дмитрия Елисеева) мы отделяем ее URL в БД от параметров, ищем подключенный к ней модуль подменяем URL в pathInfo на путь к модулю склеиваем путь и параметры и заново пропускаем через UrlRules это сформированную строку.

Answer 1

[Максим Федоров]

Вы по моему не совсем правильно разделили Вашу систему на модули: Главная, О компании, Контакты - это обычные страницы сайта тут вопросов нет, но новости это не просто страницы - это отдельный модуль который может иметь свой специфический функционал - поиск, теги, лайки и т.п. Соответственно я бы Вам рекомендовал разделить эту задачу на два модуля:
1. Модуль статического контента - который будет содержать информационные страницы сайта, такие как "о компании", "контакты" и т.п.
2. Модуль новостей - содержащий собственно все новости

Comments

[Screamie Di]

Все верно! Видимо, я не так объяснил.

Так и должно быть. Возникает именно проблема с маршрутами. То есть для администратора панели управления видна просто страница Новости. По клику на которую он переходит к странице Модуля Новостей в Админке. Где есть управление тегами и проч.

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

[Screamie Di]

Опишу User case может быть будет понятней.

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

Все хорошо, пока alias страницы новостей совпадает с контроллером модуля. Но если админ к примеру решить изменить alias на events, или перенести страницу, в какое-нибудь подменю то все рушится

[Денис Рыбин]

Хранить в базе список модулей и выводить их в шаблоне.

[Screamie Di]

Денис Рыбин: Это понятно. Админ в админке, при создании страницы сам выбирает ей модуль из dropdownList. Вопрос в другом. Как заставить этот модуль работать независимо от того, куда админ в дальнейшем перенесет саму страницу.

То есть страница может быть на третьем уровне вложенности. например /about/events/news

И когда мы туда переходим, то запускается модуль news именно по этому адресу.

А его адреса доступа к контроллерам меняются с /news/find-by-tags на /about/events/news/find-by-tags. Причем админ может завтра перенести эту страницу в другое место. Но это не изменит работы модуля, просто изменит адрес обращения к нему.

[Денис Рыбин]

Screamie Di: тогда наверно нужно создать свой класс правил для urlManager чтобы брать маршруты из базы.

[Screamie Di]

Денис Рыбин: Да, я тоже думаю в эту сторону, но как его написать - загадка. Url модулей динамические, могут иметь любой уровень вложенности и при этом должны поддерживать urlRules для модуля.

Хочу выразить огромное спасибо Дмитрию Елисееву, за помощь, он предложил следующий вариант парсинга URL:

В parseRequest:

- Ищем /city/events/most-popular. Не нашлось.
- Ищем /city/events. Нашлось. Тип "news". Запускаем рекурсию:

$r = clone $request;
$r->setPathInfo('news/most-popular');
return $manager->parseRequest($r);

Пока не знаю подойдет ли этот метод, но буду пробовать его. Отпишусь здесь, когда проверю. Если у кого-то есть идеи, то буду очень признателен, за помощь

Answer 2

[RustemS]

Делай модуль в нем ещё sub модуль и будет тебе щастье
В urlManager пропиши 'enableStrictParsing' => true и укажи все явные пути.