DB Structure Viewer для Cotonti Siena v.0.9.26

Общее описание

DB Structure Viewer — это мощный административный плагин для CMF Cotonti Siena, предназначенный для просмотра, анализа и экспорта структуры базы данных.
Плагин предоставляет наглядный интерфейс в панели администратора, где можно просматривать таблицы, их поля, типы данных, а также экспортировать структуру и данные в различные форматы (SQL, CSV, JSON, PHP Array).

Плагин полностью совместим с:

• Cotonti Siena v.0.9.26
• PHP 8.4+
• MySQL 8.0+

Назначение и преимущества

Плагин предназначен для веб-разработчиков, администраторов и технических специалистов, работающих с Cotonti и нуждающихся в инструменте для:

• Быстрого просмотра структуры таблиц базы данных без обращения к phpMyAdmin.
• Удобного экспорта структуры и данных в нужном формате (для резервирования, анализа или переноса).
• Логирования всех операций экспорта, чтобы отслеживать, кто и когда выгружал данные.
• Минимизации ручной работы при создании документации или отладке базы.

Ключевые преимущества:

• Простая установка — полностью интегрируется через стандартную систему плагинов Cotonti.
• Совместим с последними версиями PHP и MySQL.
• Не требует внешних библиотек.
• Поддерживает экспорт в браузер и на сервер одновременно.
• Легкий просмотр таблиц, полей и содержимого прямо в интерфейсе админки.
• Возможность включить логирование всех экспортов для аудита.
• Архивирование файлов экспорта в ZIP.

Структура плагина

Плагин организован по классическому стандарту Cotonti и включает в себя следующие директории и файлы:

plugins/dbviewstructure/
├── dbviewstructure.setup.php          # Регистрация плагина и конфигурация
├── dbviewstructure.tools.php          # Основная логика интерфейса админ-панели
├── inc/
│   └── dbviewstructure.functions.php  # Вспомогательные функции для работы с БД и экспортом
├── tpl/
│   └── dbviewstructure.tools.tpl      # HTML-шаблон для интерфейса плагина
├── export/                            # Папка для сохранения файлов экспорта (права 755)
├── lang/
│   ├── dbviewstructure.ru.lang.php    # Русская локализация
│   └── dbviewstructure.en.lang.php    # Английская локализация
└── setup/
  ├── dbviewstructure.install.sql     # SQL для создания таблицы логов
  └── dbviewstructure.uninstall.sql   # SQL для удаления таблицы логов

Функциональные возможности

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

1. Структура — просмотр таблиц и их полей.
2. Экспорт — выгрузка структуры и данных в выбранный формат.
3. Логи — просмотр истории экспортов.

Вкладка “Структура”

Назначение

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

• Просмотр строк (Rows) — выбор таблицы и просмотр первых 10 строк данных либо строки по конкретному ID.
• Таблицы и поля (Tables & Fields) — сводный список всех таблиц, количества строк, полей и используемого движка (InnoDB, MyISAM и т. д.).

Функции вкладки

• Список всех таблиц в текущей базе данных.
• Подробное отображение структуры каждой таблицы:
  • Названия полей
  • Типы данных (VARCHAR, INT, TEXT и т. д.)
  • Возможность NULL
  • Ключевые поля (PRIMARY, UNIQUE, INDEX)
  • Значения по умолчанию
  • Дополнительные атрибуты (AUTO_INCREMENT и др.)
• Просмотр данных:
  • Первые 10 строк таблицы
  • Фильтрация по ID строки

Вкладка “Экспорт”

Назначение

Позволяет экспортировать структуру базы данных (или её части) в один из поддерживаемых форматов.

Поддерживаемые форматы экспорта

• SQL — экспорт структуры таблиц и данных в виде SQL-дампа.
• CSV — данные в табличном формате с разделителями.
• JSON — экспорт в JSON для использования в API или документации.
• PHP Array — массив PHP, удобный для отладки и тестов (только структура или первые 10 строк).

Режимы экспорта

• Только структура — без данных.
• Первые 10 строк — небольшой пример содержимого.
• Все строки — полный экспорт данных таблиц.

Дополнительные функции

• Возможность выбрать несколько таблиц для одновременного экспорта.
• Массовое выделение таблиц («Выделить все»).
• Одновременный экспорт в браузер и сохранение файла в папку /export/.
• Автоматическое сжатие экспортированных файлов в ZIP.

Вкладка “Логи”

Назначение

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

Данные, сохраняемые в логе

• ID записи
• Имя файла экспорта
• Формат (SQL, CSV, JSON, PHP)
• Количество таблиц в экспорте
• Флаг «С данными» (да/нет)
• Дата создания

Возможности

• Просмотр истории экспортов.
• Ссылки для скачивания экспортированных файлов.
• Постраничная навигация при большом количестве записей.

Конфигурация плагина

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

• Путь к папке экспорта — по умолчанию plugins/dbviewstructure/export/.
• Включить логирование — фиксирует все экспорты в БД.
• Одновременный экспорт в браузер — позволяет сразу скачать файл при создании.
• Количество записей на страницу — ограничение для пагинации логов.
• Упаковывать в ZIP — архивирование файлов экспорта.

Папка export/ должна иметь права доступа 755 для корректной записи файлов.

Файлы базы данных

Создание таблицы логов

При установке плагина создаётся таблица:

cot_dbviewstructure_logs

Поля таблицы:

• id — автоинкрементный идентификатор
• filename — имя экспортированного файла
• format — формат экспорта
• tables_count — количество таблиц
• with_data — признак включения данных
• created_at — дата экспорта

Экспортированные файлы

После экспорта файлы сохраняются в:

plugins/dbviewstructure/export/

Форматы имен файлов:

• export_2025-11-01_123456.sql
• export_2025-11-01_123456.json
• export_2025-11-01_123456.zip

Файлы могут быть скачаны напрямую из вкладки “Логи” через ссылку «Скачать файл экспорта».

Работа с плагином — пошагово

1. Перейдите в админ-панель → Инструменты → DB Structure Viewer.
2. Откройте вкладку “Структура”, чтобы ознакомиться с таблицами.
3. Во вкладке “Просмотр строк” выберите таблицу, чтобы увидеть данные.
4. Перейдите во вкладку “Экспорт” и отметьте нужные таблицы.
5. Выберите формат экспорта и режим (только структура / с данными).
6. Нажмите “Экспорт” — файл сохранится на сервере, при необходимости откроется в браузере.
7. Во вкладке “Логи” можно скачать ранее созданные файлы и просмотреть историю.

Заключение

Плагин DB Structure Viewer делает управление базой данных Cotonti простым и наглядным.
Он объединяет функции анализа, экспорта и аудита в одном удобном интерфейсе.
Инструмент подходит как для разработчиков (документирование структуры), так и для администраторов (резервное копирование и контроль изменений).