Файл "forums.admin.php" в Cotonti

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

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

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

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

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

Этот файл непосредственно взаимодействует с административной частью сайта и используется для отображения и обработки информации о форумах:

1. Авторизация и проверки: В начале файла идет проверка, что у пользователя есть права на чтение и запись для модуля форума. Если у пользователя нет прав администратора, доступ к функционалу ограничивается.
2. Парсинг шаблонов: Шаблоны, которые отображаются в административной панели, обрабатываются с помощью XTemplate. Это позволяет динамически отображать и модифицировать данные на основе шаблонов.
3. Интеграция с базой данных: Для отображения актуальной информации о форумах, темах и постах используется запросы к базе данных (например, для получения списка последних тем и количества сообщений).

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

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

• $t: Экземпляр класса XTemplate. Используется для загрузки и парсинга шаблонов.
• $n: Переменная, определяющая текущую операцию или отображаемую страницу.
• $structureCode: Код структуры для форума.
• $row: Массив данных, получаемых из базы данных для каждой строки форума.
• $structureLevel: Уровень вложенности категории форума.
• $adminPath: Массив, используемый для формирования хлебных крошек в админке.
• $adminTitle: Название страницы в административной панели.
• $adminHelp: Помощь, если она задана для форума.

2. Хуки:

• forums.admin.first: Хук, вызываемый до основной логики страницы администрирования форума. Используется для подключения плагинов и выполнения действий до того, как страница будет загружена.
• forums.admin.tags: Хук для подключения плагинов, которые должны работать с тегами в админке форума.
• admin.structure.loop: Хук для работы с данными структуры форума.

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

• cot_auth(): Функция для проверки прав пользователя. В данном случае проверяется, имеет ли пользователь права на чтение, запись и является ли он администратором для модуля форума.
• cot_block(): Функция, которая блокирует доступ к странице для пользователей, не соответствующих определенным условиям. В данном случае блокируется доступ, если пользователь не является администратором.
• cot_url(): Функция для генерации URL-адресов на основе переданных параметров, используемая для создания ссылок на другие страницы административной панели.
• cot_breadcrumbs(): Функция для отображения хлебных крошек, которая строит путь к текущей странице форума.
• cot_getextplugins(): Функция для получения списка подключенных плагинов, которые могут быть использованы на странице форума.
• cot_tplfile(): Функция для загрузки соответствующего шаблона для отображения страницы в админке.
• $db->countRows(): Метод для подсчета количества строк в таблице базы данных. Используется для получения общей статистики по темам и постам.
• $db->query(): Метод для выполнения SQL-запросов к базе данных. В данном контексте используется для получения последних тем и статистики.

Задачи, функции и условия, выполняемые этим файлом:

1. Проверка прав доступа: Этот файл включает в себя проверки прав доступа для пользователя, убедившись, что только администратор может взаимодействовать с настройками форума.
2. Формирование интерфейса: Создается интерфейс администрирования форума, который включает хлебные крошки, ссылки на другие страницы форума, статистику и данные о форумах.
3. Загрузка и обработка данных: Выполняются SQL-запросы к базе данных для получения информации о темах, постах и другой статистике форума. Эти данные затем отображаются в шаблоне.
4. Обработка плагинов: Включаются дополнительные плагины, которые могут добавлять дополнительный функционал или изменять отображение страницы.
5. Парсинг и вывод шаблона: Создается HTML-контент с использованием XTemplate для динамического отображения данных на странице.

/* ====================
[BEGIN_COT_EXT]
Hooks=admin
[END_COT_EXT]
==================== */

/**
 * Статистика для форумов
 *
 * @package Forums
 * @copyright (c) Cotonti Team
 * @license https://github.com/Cotonti/Cotonti/blob/master/License.txt
 */
(defined('COT_CODE') && defined('COT_ADMIN')) or die('Неверный URL.'); // Проверка, что файл вызывается из правильного контекста (проверка наличия констант COT_CODE и COT_ADMIN)

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

$t = new XTemplate(cot_tplfile('forums.admin', 'module', true)); // Загружаем шаблон для админки форума

require_once cot_incfile('forums', 'module'); // Подключаем файл модуля форума

// Формируем пути для навигации в админке
$adminPath[] = array(cot_url('admin', 'm=extensions'), $L['Extensions']); // Добавляем путь для расширений
$adminPath[] = array(cot_url('admin', 'm=extensions&a=details&mod='.$m), $cot_modules[$m]['title']); // Добавляем путь к деталям модуля
$adminPath[] = array(cot_url('admin', 'm='.$m), $L['Administration']); // Добавляем путь к админ-панели форума
$adminHelp = isset(Cot::$L['adm_help_forums']) ? Cot::$L['adm_help_forums'] : ''; // Устанавливаем описание справки для админки форума
$adminTitle = Cot::$L['Forums']; // Название для админ-панели форума

/* === Hook  === */
foreach (cot_getextplugins('forums.admin.first') as $pl) // Получаем и подключаем плагины, зарегистрированные в хуке forums.admin.first
{
	include $pl; // Подключаем каждый найденный плагин
}
/* ===== */

В этом участке кода выполняются следующие действия:

• Проверяется, что файл был вызван в правильном контексте, с необходимыми константами.
• Получаются права доступа пользователя для форума: разрешения на чтение и запись, а также проверяется, является ли пользователь администратором.
• Если пользователь не является администратором, выполняется блокировка доступа.
• Загружается шаблон для административной панели форума.
• Подключается основной файл модуля форума.
• Формируются пути навигации для админки форума, добавляются ссылки на расширения, детали модуля и саму административную панель форума.
• Вспомогательная переменная adminHelp используется для установки справочной информации о форуме.
• В переменной adminTitle сохраняется название форума для использования в административной части.
• Подключаются плагины, зарегистрированные для хука forums.admin.first.

$sql_forums = $db->query("SELECT * FROM $db_forum_topics WHERE 1 ORDER BY ft_creationdate DESC LIMIT 10"); // Выполняем запрос к базе данных для получения 10 последних тем форума, сортируя их по дате создания
$ii = 0; // Инициализируем переменную для подсчета строк

while ($row = $sql_forums->fetch()) // Проходим по результатам запроса
{
	$ii++; // Увеличиваем счетчик
	$t->assign(array( // Присваиваем данные для отображения в шаблоне
		'ADMIN_FORUMS_ROW_II' => $ii, // Номер строки
		'ADMIN_FORUMS_ROW_FORUMS' => cot_breadcrumbs(cot_forums_buildpath($row['ft_cat']), false), // Хлебные крошки для категории форума
		'ADMIN_FORUMS_ROW_URL' => cot_url('forums', 'm=posts&q='.$row['ft_id']), // Ссылка на темы форума по ID
		'ADMIN_FORUMS_ROW_TITLE' => htmlspecialchars($row['ft_title']), // Заголовок темы форума с экранированием HTML
		'ADMIN_FORUMS_ROW_POSTCOUNT' => $row['ft_postcount'] // Количество сообщений в теме
	));
	$t->parse('MAIN.ADMIN_FORUMS_ROW_USER'); // Парсим шаблон строки для каждой темы форума
}
$sql_forums->closeCursor(); // Закрываем курсор запроса

$t->assign(array( // Присваиваем дополнительные данные для отображения
	'ADMIN_FORUMS_URL_CONFIG' => cot_url('admin', 'm=config&n=edit&o=module&p=forums'), // Ссылка на страницу конфигурации форума
	'ADMIN_FORUMS_URL_STRUCTURE' => cot_url('admin', 'm=structure&n=forums'), // Ссылка на структуру форума
	'ADMIN_FORUMS_TOTALTOPICS' => $db->countRows($db_forum_topics), // Общее количество тем в форуме
	'ADMIN_FORUMS_TOTALPOSTS' => $db->countRows($db_forum_posts), // Общее количество сообщений в форуме
	'ADMIN_FORUMS_TOTALVIEWS' => $db->query("SELECT SUM(fs_viewcount) FROM $db_forum_stats")->fetchColumn() // Общее количество просмотров для всех форумов
));

В этом участке кода выполняются следующие действия:

• Запрашиваются 10 последних тем форума, сортированных по дате создания.
• Перебираются результаты запроса, и для каждой строки формируются данные для шаблона, такие как номер строки, хлебные крошки, URL для просмотра темы, заголовок и количество сообщений.
• Шаблон строки для темы форума парсится.
• После завершения обработки запрос к базе закрывается с помощью closeCursor().
• Присваиваются дополнительные данные для шаблона, такие как ссылки на страницы конфигурации и структуры форума, а также общая статистика форума: количество тем, сообщений и просмотров.

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

/* === Hook  === */
foreach (cot_getextplugins('forums.admin.tags') as $pl) // Для каждого плагина, подключенного к хуку 'forums.admin.tags', выполняем включение файла плагина
{
	include $pl; // Подключаем плагин
}
/* ===== */

$t->parse('MAIN'); // Парсим основной блок шаблона
$adminMain = $t->text('MAIN'); // Получаем содержимое основного блока шаблона в переменную $adminMain

В этом фрагменте кода происходит следующее:

• Для каждого плагина, зарегистрированного на хук forums.admin.tags, выполняется подключение плагина через функцию include. Это позволяет расширить функциональность текущего файла с помощью плагинов.
• Далее происходит парсинг шаблона MAIN с использованием XTemplate. Это формирует HTML-контент на основе данных и шаблонов.
• После парсинга шаблона содержимое блока MAIN сохраняется в переменную $adminMain, которая затем может быть использована для вывода на странице административной панели.

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

Заключение:

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