Файл "page.admin.home.php" модуль "Page" в Cotonti

Описание файла "page.admin.home.php" в Cotonti CMF

Файл "page.admin.home.php" является частью модуля "Page" в Cotonti CMF, расположенный в директории /modules/page/. Этот файл предназначен для работы с административной панелью сайта и в первую очередь используется для отображения информации о состоянии страниц в очереди на главной странице админки, а также для отображения статистики, связанной с этим состоянием.

Основное назначение файла:

• Представление статистики: Файл формирует и выводит на главной странице панели администратора данные о количестве страниц, находящихся в очереди на публикацию или обработку.
• Интеракция с шаблонами: Он использует систему шаблонов XTemplate для отображения данных на сайте.

Место в системе Cotonti:

Этот файл хранится в модуле "Page", который управляет страницами сайта. Он активно взаимодействует с административной панелью и отвечает за вывод статистической информации в боковой панели админки.

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

• Этот файл не предназначен для прямого взаимодействия с пользователями сайта. Он взаимодействует с административной частью движка, обеспечивая администратору информацию о количестве страниц в очереди.
• Взаимодействует с базой данных для подсчета количества страниц в определенном состоянии (page_state='1').

Хуки, методы, функции и классы:

1. Хуки:

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

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

   • cot_tplfile(): Эта функция используется для получения пути к шаблону page.admin.home, который будет использоваться для генерации HTML-кода на административной панели.
   • cot_incfile(): Функция для подключения дополнительного файла модуля. В данном случае подключается файл модуля "page", содержащий функции и классы для работы с данными страниц.
   • $db->query(): Выполняет SQL-запрос к базе данных, который подсчитывает количество страниц, находящихся в очереди.
   • XTemplate: Класс, используемый для работы с шаблонами. В данном случае создается объект этого класса для обработки шаблона page.admin.home.

3. Переменные:

   • $tt: Это объект класса XTemplate, который используется для работы с шаблоном.
   • $pagesqueued: Хранит количество страниц, находящихся в очереди, полученное из базы данных.

4. Классы:

   • XTemplate: Используется для работы с шаблонами и вывода данных в административной панели.

Задачи, функции и условия кода:

• Подсчет страниц в очереди: Код выполняет запрос к базе данных для подсчета количества страниц, находящихся в состоянии "в очереди" (page_state='1'), и передает это количество в шаблон.
• Отображение информации: Полученная информация о количестве страниц в очереди передается в шаблон через метод assign и используется для вывода в админке.
• Обработка шаблона: После того как данные присвоены шаблону, вызывается метод parse, который обрабатывает шаблон с этими данными и готовит его к отображению.

Как владельцу сайта использовать этот файл:

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

Стиль написания PHP-кода:

• Код написан в стандартном стиле PHP, используя объектно-ориентированный подход для работы с шаблонами и запросами к базе данных.
• Используются стандартные функции Cotonti для работы с базой данных и шаблонами.
• Совместимость с PHP 7 и выше, так как используется строгая типизация и объектно-ориентированное программирование.

/* ====================
[BEGIN_COT_EXT]
Hooks=admin.home.sidepanel
[END_COT_EXT]
==================== */

// Определение хуков для расширения. Это сигнализирует, что код должен быть вызван в контексте хука admin.home.sidepanel. // Код в этом блоке будет выполняться, если хук "admin.home.sidepanel" активирован в админке.

 /**
 * Pages manager & Queue of pages
 *
 * @package Cotonti
 * @copyright (c) Cotonti Team
 * @license https://github.com/Cotonti/Cotonti/blob/master/License.txt
 */
defined('COT_CODE') or die('Wrong URL'); // Проверка на наличие правильного запроса. Если скрипт был вызван напрямую, то выполнение будет остановлено с ошибкой.

$tt = new XTemplate(cot_tplfile('page.admin.home', 'module', true)); // Создание объекта XTemplate, который будет использовать шаблон 'page.admin.home' для обработки отображения данных в админке.

require_once cot_incfile('page', 'module'); // Подключение файла для работы с модулем страницы. Этот файл содержит необходимые функции и классы для работы с данными страниц.

$pagesqueued = $db->query("SELECT COUNT(*) FROM $db_pages WHERE page_state='1'"); // Выполнение запроса к базе данных для подсчета количества страниц, которые находятся в очереди (page_state='1').

$pagesqueued = $pagesqueued->fetchColumn(); // Извлечение значения количества страниц из результата запроса.

$tt->assign(array( // Присваивание значений в шаблон для дальнейшего использования при рендеринге.
    'ADMIN_HOME_URL' => cot_url('admin', 'm=page'), // Присваивание URL для перехода в раздел админки "page".
    'ADMIN_HOME_PAGESQUEUED' => $pagesqueued // Присваивание количества страниц, находящихся в очереди.
));

$tt->parse('MAIN'); // Обработка шаблона, вставка значений и подготовка его к выводу.

$line = $tt->text('MAIN'); // Извлечение сгенерированного текста из шаблона и сохранение в переменную $line для дальнейшего использования.