Описание

Плагин DY Page View Count для системы управления контентом GetSimple CMS позволяет вести учёт и управлять количеством просмотров для каждой страницы веб-сайта.

Использование

Для начала сбора данных о просмотре страниц веб-сайта достаточно активировать плагин DY Page View Count на странице управления плагинами в панеле управления GetSimple CMS. Для разработчиков, желающих использовать возможности плагина для расширения функциональных возможностей веб-сайта, DY Page View Count предоставляет набор специальных функций.

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

<?php dyGetPageViewCount($slug, $offset, $echo); ?>

Параметры, принимаемые функцией dyGetPageViewCount():

  • $slug – slug страницы для которой требуется получить количество просмотров;
  • $offset – задаёт смещение для количества просмотров страницы, необязательный параметр. Используется в случае необходимости увеличить ($offset > 0) или уменьшить ($offset < 0) возвращаемое количество просмотров на заданную величину. По умолчанию $offset = 0;
  • $echo – необязательный параметр. Управляет выводом функции:
    • $echo = false – значение по умолчанию, функция возвращает результат;
    • $echo = true – функция печатает результат на странице.

Практический пример использования DY Page View Count для вывода количества просмотров текущей страницы веб-сайта:

<p>Количество просмотров: <?php dyGetPageViewCount(get_page_slug(false), 0, true); ?></p>

Получение количества просмотров для веб-сайта

Для получения общего количества просмотров веб-сайта используется функция:

<?php dyGetWebsiteViewCount($offset, $offsetForAllPages, $echo); ?>

Параметры, принимаемые функцией dyGetWebsiteViewCount():

  • $offset – задаёт смещение для количества просмотров веб-сайта, необязательный параметр. Используется в случае необходимости увеличить ($offset > 0) или уменьшить ($offset < 0) возвращаемое количество просмотров на заданную величину. По умолчанию $offset = 0;
  • $offsetForAllPages – определяет способ вычисления возвращаемого количества просмотров веб-сайта с применением смещения, необязательный параметр:◦$offsetForAllPages = false – величина смещения добавляется к общему количеству просмотров веб-сайта (значение по умолчанию);
  • $offsetForAllPages = true – заданная величина смещения добавляется к количеству просмотров для каждой страницы веб-сайта;
  • $echo – управляет выводом функции, необязательный параметр:
    • $echo = false – функция возвращает результат (значение по умолчанию);
    • $echo = true – функция печатает результат на странице.

Данные, собранные при помощи DY Page View Count, могут быть использованы для реализации нового и расширения существующего функционала веб-сайта, например, формирования рейтинга страниц на основании количества их просмотров и т.д.

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

Для получения количества учтённых просмотров всех страниц веб-сайта используется функция:

<?php dyGetPageViewCountData(); ?>

Функция возвращает ассоциативный массив, ключами которого являются slug страниц, а значениями - количество их просмотров.

<?php $data = dyGetPageViewCountData(); ?>

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

<?php
    echo '<table><thead>';
    echo '<tr><th>Slug</th><th>Заголовок страницы</th><th>Количество просмотров</th></tr>';
    echo '</thead><tbody>';
    foreach(dyGetPageViewCountData() as $key => $value) {
    echo '<tr><td>' . $key . '</td><td>' . returnPageField($key, 'title') . '</td><td>' . $value . '</td></tr>';
    }
    echo '</tbody></table>';
?>

Задание или сброс количества просмотров для конкретной страницы

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

<?php dySetPageViewCount($slug, $count); ?>

Параметры, принимаемые функцией dySetPageViewCount():

  • $slug – slug страницы для которой требуется изменить количество просмотров;
  • $count – задаёт количество просмотров страницы, необязательный параметр. По умолчанию $count = 0.

Пример использования функции:

<?php
    // Обнуление количества просмотров для главной страницы веб-сайта
    dySetPageViewCount('index'); ?>
    // Задание количества просмотров для страницы question
    dySetPageViewCount('question', 42);
?>

Сброс (обнуление) данных о количестве просмотров для всех страниц

Для сброса всей собранной информации о количестве просмотров страниц веб-сайта используется функция:

<?php dyResetPageViewCountData(); ?>