Файл page.counter.php в Cotonti CMF

Основное назначение файла и его место в системе Cotonti

Файл page.counter.php в Cotonti CMF находится в директории /modules/page/inc и служит для подсчета просмотров страниц на сайте. Он взаимодействует с базой данных для обновления статистики просмотров на уровне страницы, увеличивая значение счетчика при каждом посещении.

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

Взаимодействие файла внутри сайта

Файл обрабатывает запросы, поступающие с параметром a=views, для того чтобы увеличить счетчик просмотров соответствующей страницы. Он делает это, выполняя SQL-запрос для обновления поля page_count в базе данных, что способствует ведению статистики посещений.

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

Переменные, хуки, методы, функции, классы

Переменные

• $a — строковая переменная, получаемая из запроса. Она указывает на действие, которое необходимо выполнить (например, увеличение счетчика просмотров).
• $id — переменная, в которую сохраняется идентификатор страницы, извлекаемый из глобальной переменной $_GET с помощью функции cot_import().

Хуки

В коде нет явных хуков для интеграции с другими частями системы Cotonti, так как это прямой обработчик запросов.

Методы и функции

• cot_auth('page', 'any') — метод, проверяющий права пользователя для доступа к странице. Возвращает права на чтение, запись и информацию о статусе администратора.
• cot_block() — функция, которая завершает выполнение скрипта, если у пользователя нет необходимых прав (в данном случае прав на чтение страницы).
• cot_import() — функция для безопасного извлечения значений из глобальных массивов, в данном случае используется для извлечения идентификатора страницы.
• cot_die() — функция, которая завершает выполнение скрипта, если условие не выполнено (в данном случае, если переменные $id или $a пусты).
• Cot::$db->query() — метод для выполнения SQL-запроса к базе данных, используемый для увеличения счетчика просмотров страницы в таблице базы данных.

Суть содержания кода, задачи, функции и условия

Основная задача этого файла — это увеличение счетчика просмотров страницы в базе данных. Он выполняет проверку, что параметр a передан и имеет правильное значение (в данном случае views), а также что идентификатор страницы (id) присутствует и является валидным. Затем выполняется SQL-запрос, который обновляет счетчик просмотров для конкретной страницы в базе данных.

Код предусматривает:

1. Проверку прав пользователя на выполнение действия (права на чтение).
2. Валидацию входных данных (параметры id и a).
3. Выполнение обновления статистики в базе данных.

Использование сценария кода владельцем сайта

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

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

Таким образом, использование этого кода позволяет:

• Автоматически отслеживать количество просмотров страниц.
• Уменьшить нагрузку на сервер, благодаря использованию кеширования.
• Получить актуальную информацию о посещаемости контента на сайте.

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

<?php
/**
 * Page views counter. For cached pages.
 *
 * @package Page
 * @copyright (c) Cotonti Team
 * @license https://github.com/Cotonti/Cotonti/blob/master/License.txt
 *
 * @var string $a
 */

defined('COT_CODE') or die('Wrong URL'); // Проверка, что файл был вызван внутри системы Cotonti, иначе прекращается выполнение.

list(Cot::$usr['auth_read'], Cot::$usr['auth_write'], Cot::$usr['isadmin']) = cot_auth('page', 'any'); // Получение прав пользователя для работы с модулем "page", авторизация по правам для чтения и записи.
cot_block(Cot::$usr['auth_read']); // Блокировка доступа, если у пользователя нет прав на чтение.

$id = cot_import('id', 'G', 'INT'); // Получение значения параметра 'id' из глобальной переменной GET, ожидается целочисленный тип.
cot_die(empty($id) || empty($a), true); // Завершение работы, если 'id' или 'a' пусты, прерывание выполнения скрипта с ошибкой.

switch ($a) { // Проверка значения переменной $a для определения действия.
    case 'views': // Если значение переменной $a равно 'views', выполняется следующий код:
        Cot::$db->query(
            'UPDATE ' . Cot::$db->pages . ' SET page_count = page_count + 1 WHERE page_id = ?', // SQL-запрос, увеличивающий количество просмотров на 1 для страницы с указанным ID.
            $id // Параметр, который передается в запрос (ID страницы).
        );
}

exit(); // Завершение работы скрипта, после выполнения запроса.