Создание счетчика посещений для сайта на MODX

В этой статье изучим как можно очень просто добавить на сайт, работающим под управлением CMS MODX, подсчет количества просмотров страниц.

Краткий план

Подсчет количества просмотров страниц на сайте организуем так:

• само значение будем хранить в TV поле views;
• его обновление будем выполнять посредством плагина UpdateTVViews;
• для получения списка самых просматриваемых ресурсов напишем сниппет getMostViewedResources;
• для вывода результатов работы сниппета getMostViewedResources будем использовать чанки: tplMostViewedResourcesRow (для одного элемента) и tplMostViewedResources (в качестве обёртки, для заворачивания всех элементов).

Защиту от накрутки выполним с использованием куки.

В коде шаблона получить количество просмотров ресурса можно будет посредством плейсхолдера [[!+views]], который будем устанавливать с помощью плагина UpdateTVViews.

Вывести список самых популярных ресурсов можно будет посредством вызова сниппета [[!getMostViewedResources]].

Шаг 1. Создание TV для хранения просмотров

Разработку в MODX начнем с создания дополнительного поля и его настройки следующим образом:

• на вкладке «Общая информация» в «Название» введём views и в «Подпись» – Количество просмотров;
• на вкладке «Параметры ввода» в выпадающем списке «Тип ввода» выберем Число, а в поле «Номер по умолчанию» введём значение 0;
• на вкладке «Параметры вывода» в выпадающем списке «Тип ввода» выберем значение По умолчанию;
• на вкладке «Доступно для шаблонов» отметим галочками шаблоны, для которых это TV должно быть доступно.

После этого в ресурсах, которые используют один из шаблонов для которых это TV доступно, на вкладке «Дополнительные поля (TV)» появится только что созданное TV-поле views.

Шаг 2. Создание плагина для обновления TV

После добавления TV в MODX создадим новый плагин и дадим ему название UpdateTVViews. Он будет использоваться для увеличения счетчика просмотров views.

Плагин будет выполняться при наступлении системного события OnLoadWebDocument, которое будет возникать после загрузки документа, но до обработки парсером тегов MODX. Получение текущего ресурса при наступлении этого события можно получить посредством $modx->resource.

Код плагина UpdateTVViews:

<?php
if ($modx->event->name != 'OnLoadWebDocument') {
  return;
}

// получим ресурс
$resource = $modx->resource;
// URL
$url = $modx->makeUrl($resource->get('id'), '', '', 'abs');
// id TV views
$tvViewsId = 1;
// количество просмотров
$views = 0;

// если TV не доступна для этого шаблона, то завершаем
$tvViewsTemplate = $modx->getObject('modTemplateVarTemplate', [
  'tmplvarid' => $tvViewsId,
  'templateid' => $resource->get('template')
]);
if (!$tvViewsTemplate) {
  return;
}

// получаем TV
$tvViews = $modx->getObject('modTemplateVarResource', [
  'tmplvarid' => $tvViewsId,
  'contentid' => $resource->get('id')
]);

// если имеется TV то получаем его значение, иначе создаем
if ($tvViews) {
  $views = $tvViews->get('value');
} else {
  $tvViews = $modx->newObject('modTemplateVarResource');
  // устанавливаем значение поля tmplvarid
  $tvViews->set('tmplvarid', $tvViewsId);
  // устанавливаем значение поля contentid
  $tvViews->set('contentid', $resource->get('id'));
}

// если значение куки не равно текущему URL, то увеличиваем счетчик
if ($_COOKIE['views'] != $url) {
  // устанавливаем количество просмотров
  $tvViews->set('value', ++$views);
  // сохраняем TV
  $tvViews->save();
  // устанавливаем COOKIE views
  setcookie('views', $url, time() + (86400 * 365), $url);
}

// устанавливаем плейсхолдер views
$modx->setPlaceholder('views', $views);

Для того чтобы плагин отслеживал данное событие, его необходимо включить на вкладке «Системные события»:

В коде, приведенном выше, для того чтобы счётчик просмотров не увеличивался при повторном просмотре некоторого ресурса одним и тем же пользователем используются куки. Установка куки выполняется посредством php-функции setcookie, а её получение с помощью ассоциативного массива $_COOKIE.

Кроме этого, плагин будет ещё устанавливать плейсхолдер views, посредством которого можно будет вывести количество просмотров ресурса на экран. Плейсхолдер необходимо вызывать не кэшированным:

[[!+views]]

Шаг 3. Создание сниппета для вывода самых популярных ресурсов

В завершении напишем сниппет для вывода самых популярных страниц на сайте. Назовем его getMostViewedResources. Сниппет будет получать из базы 5 ресурсов, которые имеют самые большие значения views.

Код сниппета getMostViewedResources:

// id TV views
$tvViewsId = 1;

// создадим новый запрос, используя объект modTemplateVarResource
$query = $modx->newQuery('modTemplateVarResource');
// присоединяем к нему объект modResource
$query->innerJoin('modResource', 'Resource');
// добавляем к запросу условие
$query->where(['modTemplateVarResource.tmplvarid' => $tvViewsId]);
// выполним сортировку по TV (для преобразования строки в беззнаковое число используем mysql функцию CAST)
$query->sortby('CAST(modTemplateVarResource.value as unsigned)', 'DESC');
// укажем поля для выборки
$query->select([
  'Resource.id as id',
  'Resource.pagetitle as pagetitle',
  'modTemplateVarResource.value as countviews'
]);
// ограничим выборку 5 записями
$query->limit(5);
// подготовим и выполним запрос
$query->prepare();
$query->stmt->execute();
$rows = $query->stmt->fetchAll(PDO::FETCH_ASSOC);
// присвоим переменной $output пустую строку
$output = '';
// переберём все записи
foreach ($rows as $row) {
  $row['url'] = $modx->makeUrl($row['id'], '', '', 'abs');
  // оформим вывод строки с использованием чанка tplMostViewedResourcesRow
  $output .= $modx->getChunk('tplMostViewedResourcesRow', $row);
}
$output = $modx->getChunk('tplMostViewedResources', ['output' => $output]);
// вернём результат
return $output;

HTML-шаблон который используется для формирования одной строчки хранится в чанке tplMostViewedResourcesRow:

<li class="list-group-item d-flex justify-content-between align-items-start">
  <div class="ms-2 me-auto">
    <div class="fw-bold"><a href="[[+url]]">[[+pagetitle]]</a></div>
  </div>
  <span class="badge bg-primary rounded-pill">[[+countviews]]</span>
</li>

Чанк tplMostViewedResources используется в качестве обёртки и имеет следующий код:

<div class="card">
  <div class="card-header">Популярные статьи</div>
  <ol class="list-group list-group-flush list-group-numbered">[[+output]]</ol>
</div>

Для вывода блока с самыми популярными страницами необходимо поместить в необходимое место шаблона вызов сниппета getMostViewedResources:

[[!getMostViewedResources]]

Вид блока «Популярные статьи»:

Оформление этого блока выполнена с использованием Bootstrap 5, а для создания структуры этого списка был выбран компонент из этого фронтенд инструмента под названием List group.