SVResolution

SVResolution — служебное дополнение для MODX Revolution, которое помогает при адаптивной вёрстке сайтов на Bootstrap.

Дополнение выводит на фронтенде сайта компактный индикатор с текущим Bootstrap-брейкпоинтом и шириной окна браузера в пикселях. Это удобно при разработке шаблонов, проверке адаптивности и отладке поведения интерфейса на разных ширинах экрана.

Возможности

SVResolution показывает:

• текущий брейкпоинт Bootstrap;
• текущую ширину окна браузера в пикселях.

Поддерживаются правила брейкпоинтов Bootstrap 3, 4 и 5.

Дополнение работает как плагин MODX и не требует вставки сниппета в шаблоны сайта.

Условия показа

Индикатор виден только авторизованному пользователю панели управления MODX, который состоит в разрешённой группе пользователей.

По умолчанию используется группа:

Administrator

Название группы можно изменить в свойствах плагина.

Как это работает

Начиная с версии 1.0.3, видимый HTML-блок индикатора не вставляется напрямую в HTML страницы.

На страницу добавляется только небольшой JavaScript-загрузчик. Сам индикатор загружается отдельным служебным запросом после проверки:

• активной сессии панели управления MODX;
• принадлежности пользователя к разрешённой группе.

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

Работа на 404-страницах

Индикатор может отображаться на 404-страницах для авторизованного пользователя панели управления MODX из разрешённой группы.

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

Системное событие

В текущей версии плагин использует системное событие:

OnLoadWebDocument

Свойства плагина

Свойство	Описание
position	Положение индикатора на экране. Например: left,bottom, right,top.
version	Версия Bootstrap, по правилам которой рассчитывается брейкпоинт. Поддерживаются значения 3, 4, 5.
color	Цвет текста и рамки индикатора.
bgcolor	Цвет фона индикатора.
allowed_group	Имя группы пользователей панели управления MODX, которым разрешён показ индикатора.
zindex	CSS z-index индикатора.

Установка

1. Установите транспортный пакет через менеджер пакетов MODX.
2. Убедитесь, что плагин SVResolution включён.
3. Очистите кэш MODX.
4. Откройте сайт, будучи авторизованным в панели управления MODX.
5. Проверьте, что индикатор виден только разрешённому пользователю.

Проверка работы

После установки рекомендуется проверить четыре сценария:

Сценарий	Ожидаемый результат
Главная страница, пользователь авторизован в панели управления MODX и входит в разрешённую группу	Индикатор виден
Главная страница, пользователь не авторизован в панели управления MODX	Индикатор не виден
404-страница, пользователь авторизован в панели управления MODX и входит в разрешённую группу	Индикатор виден
404-страница, пользователь не авторизован в панели управления MODX	Индикатор не виден

Сборка из исходников

Исходники доступны на GitHub:

https://github.com/rumata-estor/svresolution

Сборщик транспортного пакета находится в папке _build.

Если проект расположен рядом с config.core.php, сборщик попробует определить путь к MODX автоматически.

Также путь к core можно передать явно через переменную окружения:

MODX_CORE_PATH=/path/to/modx/core/ php _build/build.transport.php

После успешной сборки транспортный пакет будет создан в папке пакетов MODX.

Совместимость

Текущая версия предназначена для MODX Revolution 2.x.

Для версии 1.0.4 указаны следующие требования:

• минимальная версия MODX: 2.6;
• максимальная версия MODX: 2.8;
• минимальная версия PHP: 7.3.

Автор

Александр Ларин (Палочкин)

Лицензия

MIT