Разработка

InstantCMS построена на архитектуре MVC (Model-View-Controller). Основной функционал реализован через компоненты — независимые модули, каждый из которых содержит контроллер, модель и шаблоны. Система поддерживает автозагрузку классов и пространства имён.

Автозагрузка классов

Цикл обработки запроса

Ядро InstantCMS состоит из набора системных классов, расположенных в директории /system/core/. Каждый класс отвечает за определённую область функциональности и доступен через глобальные объекты или статические методы.

Контроллер — основная единица функционала. Имя контроллера должно быть в нижнем регистре, из латинских букв, минимум 3 символа. Каждый контроллер размещается в собственной директории внутри /system/controllers/.

Структура директории контроллера

/system/controllers/{name}/
  ├── frontend.php         # Фронтенд-контроллер
  ├── backend.php          # Бэкенд-контроллер (админка)
  ├── model.php            # Модель данных
  ├── hooks.php            # Хуки и обработчики событий
  ├── frontend/
  │   └── *.php            # Действия фронтенда
  ├── backend/
  │   └── *.php            # Действия админ-панели
  └── templates/
      ├── frontend/        # Шаблоны фронтенда
      └── backend/         # Шаблоны админки

Составные части

Модели в InstantCMS наследуют класс cmsModel и предоставляют методы для чтения, записи, фильтрации и кэширования данных. Модель каждого компонента расположена в файле model.php директории контроллера.

Основные разделы документации

Шаблоны — это наборы файлов, определяющих визуальное представление сайта в браузере. Они генерируют HTML-код и управляются через класс cmsTemplate. Система поддерживает наследование шаблонов, хелперы и схемы позиций.

Разделы документации шаблонов

Виджеты бывают двух типов: общие (в /system/widgets/) и виджеты компонентов (в директории контроллера). Класс виджета наследует cmsWidget и реализует метод run() для генерации данных.

Типы виджетов

Структура файлов виджета

/system/widgets/{name}/
  ├── widget.php           # Класс виджета (extends cmsWidget)
  ├── options.form.php     # Форма настроек виджета
  └── languages/
      └── ru/
          └── lang.php     # Языковые константы

Ключевые методы и свойства

InstantCMS предоставляет фреймворк для создания форм, работы с полями и динамического изменения готовых форм. Создание собственных полей сводится к созданию определённого класса с заданными свойствами и методами обработки данных.

Встроенные типы полей

InstantCMS предоставляет несколько механизмов для хранения различных данных помимо основной базы данных. Каждый механизм подходит для своих задач.

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

InstantCMS предоставляет набор механизмов для интеграции компонентов друг с другом. Это позволяет расширять функционал без модификации исходного кода других компонентов.

Пакет — это ZIP-архив, содержащий файлы определённой структуры для установки компонентов, виджетов, шаблонов, патчей и обновлений в InstantCMS.

Типы пакетов

Структура пакета

package.zip
  ├── manifest.ru.ini      # Манифест (обязательно)
  ├── package/              # Файлы дополнения
  │   └── system/
  │       └── controllers/
  │           └── mycomp/   # Зеркалирует структуру сайта
  ├── install.sql           # SQL-запросы установки
  ├── install.php           # PHP-скрипт установки
  ├── icon.png              # Иконка дополнения
  └── deleted.files.txt     # Файлы для удаления (обновление)

Секции манифеста

На официальном YouTube-канале InstantSoft доступны серии видеоуроков по разработке расширений для InstantCMS 2. Уроки охватывают все этапы — от создания компонента до упаковки в пакет.