Документация InstantCMS

Компонент "Загрузка изображений"

fuze (fuze@undisclosed.example.com) — 2026-11-12T22:26:54+00:00

Компонент "Загрузка изображений"

Панель управления ⇒ Компоненты ⇒ Загрузка изображений

Описание

В InstantCMS управление изображениями осуществляется через пресеты.

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

Каждый пресет имеет уникальное системное имя.
Количество пресетов не ограничено; разные пресеты могут иметь одинаковые параметры.
Рекомендация: Определите набор необходимых пресетов и их количество еще на этапе создания сайта.

Управление пресетами

Удаление: Не рекомендуется удалять пресеты, если вы не уверены, что они нигде не используются (в виджетах или компонентах). Если нужный пресет был удален случайно, его можно создать заново, указав то же самое системное имя.
Изменение размеров: Размеры в пресете применяются только к новым изображениям. Изменение параметров существующего пресета не приведет к автоматическому изменению размера уже загруженных картинок на сайте.

Настройки пресета

При создании пресета доступны следующие параметры:

Драйвер обработки изображений: Программа, выполняющая конвертацию.
- Выберите Авто, если хотите, чтобы система сначала попробовала использовать модуль Imagick. Если он недоступен, сработает резервный драйвер GD.
Системное имя: Уникальный идентификатор пресета для работы системы.
Название пресета: Отображаемое имя, удобное для восприятия администратором (например, «Превью товара»).
Размеры изображения: Задайте ширину и высоту в пикселях.
- Если указана только одна сторона (ширина или высота), вторая будет рассчитана автоматически пропорционально.
Обрезка по размеру: Опция «Строго по размеру». Включает обрезку изображения под заданный прямоугольник без искажения пропорций. Вырезанный фрагмент берется из исходного фото, согласно опции «Режим обрезки».
Увеличение мелких изображений: Если включено, маленькие картинки будут увеличены до размеров пресета. Может появиться зернистость или пикселизация.
Формат выходного файла:
- Можно сохранить файл в исходном формате.
- Или выбрать один из форматов: JPG, PNG, WebP.
- Поддерживается конвертация анимированных GIF и WebP.
Опция «Конвертировать анимированный файл, сохраняя анимацию»: Если этот флажок установлен, формат файла не изменится (останется как в исходнике), но изображение будет масштабировано согласно размерам пресета.
Качество изображения: Задается в процентах.
Водяной знак: Возможность наложить изображение-водяной знак с указанием его положения на итоговой картинке.

История изменений

Обратите внимание! До версии InstantCMS 2.10.2 вместо опции «Обрезать строго по размеру» существовала опция «Квадратный».

При работе со старыми версиями: если флажок «Квадратный» не установлен, можно задать только одну сторону (ширину или высоту). Движок изменит размер этой стороны, а вторую рассчитает пропорционально. Это позволяет точно контролировать высоту или ширину изображения вне зависимости от его ориентации.

Авто-поворот

Конвертер изображений автоматически поворачивает фотографии, если в EXIF-данных присутствует информация об ориентации (поле `Orientation`).

Назад к разделу Компоненты

Настройки виджета

fuze (fuze@undisclosed.example.com) — 2026-09-25T16:32:33+00:00

Настройки виджета

Окно настроек виджета открывается после добавления нового виджета или клику по иконке «Редактировать» у существующего.

Вкладка "Общие"

Заголовок

Будет выводиться на сайте, над виджетом. Внешний вид зависит от темы оформления. В заголовке можно вставлять SVG иконки при помощи выражения {file_name%icon_name}, где:

file_name - имя SVG файла (SVG спрайта) по пути /templates/шаблон/images/icons/;
icon_name - имя иконки SVG спрайта.

Так же, в зависимости от виджета, можно вставлять выражения полей типов контента, например, для виджета «Список контента», в зависимости от того, где он размещён, можно вставлять {title}, {user_nickname} и другие имена поле в фигурных скобках: вместо них выведутся значения полей. В описаниях конкретного виджета написано более подробно.

Показывать заголовок

Если отключено, заголовок виджета не будет выводиться на сайте.

Объединять с предыдущим виджетом

Если над виджетом на данной странице есть другой виджет, то они будут объединяться в один блок. Переключение между виджетами внутри блока будет происходить с помощью вкладок (зависит от шаблона контейнера). Текущий виджет в панели управления будет расположен с отступом слева, тем самым давая понять, что он объединён. Так же, если включено, то вы можете выбирать шаблоны контейнера (о них ниже), начинающиеся на wrapper_tabbed. Шаблон контейнера вывода группы виджетов определяется по последнему (нижнему) виджету группы.

Ссылки в заголовке виджета

Заголовок виджета может иметь одну или несколько ссылок:

Ссылки указываются в этом поле, по одной на строке, в следующем формате:

Заголовок ссылки | URL ссылки

Для внутренних ссылок URL указывается относительно корня сайта, не включая хост и подпапки (если InstantCMS установлена в подпапку).

Если вся строка со ссылкой обернута в фигурные скобки, то эта ссылка будет показыаться только авторизованным пользователям:

{Заголовок ссылки | URL ссылки}

Например, ссылки со скриншота выше были созданы так:

Все новости | news
Обсуждаемые | news-discussed
{Приватные | news/from_friends}

Скриншот сделан из-под авторизованного пользователя, поэтому он видит все три ссылки. Гость видел бы только ссылки «Все новости» и «Обсуждаемые».

Вкладка "Опции"

Содержание этой вкладки зависит от типа виджета. Опции стандартных виджетов (входящих в комплект поставки InstantCMS) рассмотрены здесь.

Вкладка "Дизайн"

Все виджеты формируются в шаблонах контейнера и в шаблонах самих виджетов. Контейнер виджета - это HTML шаблон, где обозначена вёрстка названия (включая ссылки заголовка) и тела виджета. Контейнер может использоваться в любых виджетах.

Шаблон виджета - это HTML файл, который присущ только определенному виджету.

Шаблон контейнера

Выберите из доступных шаблон контейнера (обертки) виджета. Файлы оберток хранятся в директории widgets вашего шаблона.

Если в опции выбрано «Без шаблона контейнера», то тело виджета будет выведено без обёрток в какие-либо HTML теги, при этом, если указана опция «Класс CSS для контейнера», то вывод тела виджета будет обёрнут в тег div с указанным классом.

Если в опции выбрано «Свой HTML контейнера», то появится поле с вводом своего HTML кода для контейнера. В нём будут доступны выражения: {title}, {id}, {body}, которые будут заменены на заголовок виджета, ID виджета и тела виджета соответственно.

Стиль

Если шаблон поддерживает стилизацию контейнеров, то появится эта опция. Её изменение повлечёт за собой изменение внешнего вида контейнера виджета (не содержимого).

Шаблон виджета

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

Класс CSS для контейнера

Добавляет класс на весь блок виджета. Позволяет выделить этот конкретный виджет с помощью CSS.

Класс CSS для заголовка

Добавляет класс CSS на блок заголовка виджета. Если шаблон контейнера это поддерживает.

Класс CSS для тела

Добавляет класс CSS на блок вывода тела виджета. Если шаблон контейнера это поддерживает.

Дополнительные переменные в шаблон контейнера

Для InstantCMS выше 2.18.3 версии.

Эта опция для опытных пользователей. Вы можете добавлять переменные в шаблон контейнера и выводить их, отредактировав нужный вам файл. Например, у вас выбран шаблон контейнера wrapper (это файл /templates/modern/widgets/wrapper.tpl.php) и вы указали:

Имя переменной: hint
Значение переменной: Моя подпись к виджету

Теперь в файле /templates/modern/widgets/wrapper.tpl.php доступна для вывода конструкция:

<?php echo $widget['wrap_vars']['hint']; ?>

Которая выведет: Моя подпись к виджету.

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

Имя переменной: hint_en
Значение переменной: My caption for the widget

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

<?php echo get_localized_value('hint', $widget['wrap_vars']); ?>

Т.е. указываете имя переменной без языкового суффикса. InstantCMS выведет на странице значение, учитывая текущий язык сайта.

Вкладка "Доступ"

На этой вкладке можно выбрать каким группам пользователей показывать этот виджет, а для каких скрывать. Например, вы можете не показывать виджеты с рекламой администраторам и модераторам.

Можно выбрать на каких устройствах показывать виджет: планшеты, телефоны, настольные ПК. Тип устройства определяется по User-Agent браузера.

Опция «Выводить на макетах» предназначена скорее для опытных пользователей, в случае, если макетов несколько и они разнятся в зависимости от компонента.

Опция «Для каких языков сайта показывать виджет» позволяет настраивать виджеты с привязкой к текущему языку сайта, имея таким образом для разных языков свой набор виджетов.

Опция «Отрицательные маски» дополняет маски страниц, позволяя более тонко настроить отображение виджета. На страницах, соответствующим этим маскам, виджет не будет показан. Для указания главной страницы используйте косую черту (слэш). Для указания страниц с кодом 404 (не найдено), напишите 404 - актуально, если включена опция «Выводить виджеты на странице 404» в общих настройках сайта. Например, у вас есть виджет, который расположен на всех страницах, но вы не хотите его показывать всего лишь на нескольких страницах: на главной, в профилях и на страницах с 404 ошибкой:

/
users/%*
users/{slug}*
404

Назад к разделу Управление виджетами

Модели - [Содержание раздела]

fuze (fuze@undisclosed.example.com) — 2026-09-12T19:41:10+00:00

Модели

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

Содержание раздела

К предыдущему оглавлению Разработчикам

Изменение записей

fuze (fuze@undisclosed.example.com) — 2026-09-12T19:40:10+00:00

Изменение записей

В данном разделе описаны методы класса cmsModel, позволяющие добавлять, изменять и удалять записи из базы данных.

Все примеры кода подразумевают, что действие происходит в контексте модели (т.е. внутри класса вашей модели, унаследованного от cmsModel).

Вы должны иметь представление о работе SQL-запросов для полного понимания описанных здесь методов.

Добавление записей

Список INSERT запросов к базе данных.

Простое добавление

insert($table_name, $data, $array_as_json = false, $ignore = false)

$table_name	Название таблицы, без префикса
$data	Массив данных для вставки, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Обратите внимание, если в массиве данных есть названия ключей, которых нет в списке ячеек таблицы, то ошибки при вставке не будет, - эти данные будут проигнорированы.
$array_as_json	Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра `true`, массив будет преобразован в JSON.
$ignore	Если значение этого параметра `true`, будет выполнен запрос INSERT IGNORE вместо простого INSERT.

Метод возвращает id вставленной строки.

Пример:

$id = $this->insert('users_statuses', ['content' => 'Мой статус', 'user_id' => 1]);

Добавление с обновлением

Метод выполняет запрос INSERT (INSERT ... ON DUPLICATE KEY UPDATE), но при совпадении PRIMARY или UNIQUE ключа выполняет UPDATE вместо INSERT.

insertOrUpdate(
    $table_name,
    $insert_data,
    $update_data = false,
    $array_as_json = false
)

$table_name	Название таблицы, без префикса
$insert_data	Массив данных для вставки, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Ключи массива не проверяются на наличие ячеек в таблице.
$update_data	Массив данных для обновления существующей записи при совпадении уникальных ключей. Если этот параметр равен `false`, то будет равен параметру $insert_data.
$array_as_json	Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра `true`, массив будет преобразован в JSON.

Метод возвращает id вставленной строки при условии, что строка добавлена, а не обновлена.

Пример:

$id = $this->insertOrUpdate('tags', ['tag' => $tag]);

Если в ячейке tag значение $tag уже есть в таблице, то $id будет равен false. Ячейка tag имеет уникальный индекс.

Изменение записей

Обновление записи

update(
    $table_name,
    $id,
    $data,
    $skip_check_fields = false,
    $array_as_json = false
)

$table_name	Название таблицы, без префикса
$id	ID записи, которую нужно обновить
$data	Массив данных для обновления, где ключи массива это название ячейки таблицы БД, а значение - данные для записи. Обратите внимание, если в массиве данных есть названия ключей, которых нет в списке ячеек таблицы, то ошибки при вставке не будет, - эти данные будут проигнорированы.
$skip_check_fields	Если значение этого параметра `true`, то проверка существования ячеек таблицы по названию ключей не будет осуществляться.
$array_as_json	Если значение записываемого поля массив, то движок по умолчанию преобразовывает его в YAML. Если значение этого параметра `true`, массив будет преобразован в JSON.

Метод возвращает true или false.

Пример:

$this->update('articles', $id, [
    'title' => 'Новое название',
]);

Метод устанавливает filterEqual('id', $id) и передаёт операцию в метод updateFiltered().

updateFiltered(
    $table_name,
    $data,
    $skip_check_fields = false,
    $array_as_json = false
)

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

Пример:

$this->
    filterEqual('is_pub', 0)->
    updateFiltered('articles', ['is_pub' => 1]);

После формирования условий фильтры сбрасываются.

Замена подстроки

Заменяет подстроку в указанном поле у всех записей, подходящих под LIKE.

replaceFieldString($table_name, $search, $replace, $field)

$table_name	Название таблицы, без префикса
$search	Что меняем
$replace	Чем заменяем
$field	Название поля, в котором ищем

Пример:

$this->replaceFieldString(
    'articles',
    'старый текст',
    'новый текст',
    'content'
);

increment/decrement

Увеличивает числовое поле непосредственно в SQL.

increment($table, $field, $step = 1)

$table	Название таблицы, без префикса
$field	Название поля таблицы, в котором изменяем число
$step	Шаг изменения, может быть дробным. Отрицательное значение уменьшает поле.

$this->
    filterEqual('id', $id)->
    increment('articles', 'views');

Уменьшает числовое поле. Реализован через increment() с отрицательным шагом.

decrement($table, $field, $step = 1)

$table	Название таблицы, без префикса
$field	Название поля таблицы, в котором изменяем число
$step	Шаг уменьшения, может быть дробным.

Максимальное/минимальное значение поля

Возвращает максимальное/минимальное значение поля с учётом текущих фильтров.

getMax($table, $field, $default = 0, $dir = 'MAX')

$table	Название таблицы, без префикса
$field	Название поля таблицы, в котором ищем максимальное число
$default	Значение по умолчанию, если значений нет.
$dir	Направление: MAX или MIN.

Возвращает минимальное значение поля с учётом текущих фильтров. Реализован через getMax() с направлением MIN.

getMin($table, $field, $default = 0)

Удаление записей

Удаляет запись, фильтруя по указанному полю.

delete($table_name, $id, $by_field = 'id')

$table_name	Название таблицы, без префикса
$id	Значение поля по которому фильтруем
$by_field	Название поля, по которому фильтруем

Пример:

$this->delete('articles', $id);

Можно изменить поле фильтрации:

$this->delete('articles', $slug, 'slug');

Метод устанавливает filterEqual($by_field, $id) и передаёт операцию в метод deleteFiltered().

deleteFiltered($table_name)

Удаляет все записи, соответствующие текущим фильтрам.

$table_name

Название таблицы, без префикса

Пример:

$this->
    filterEqual('is_deleted', 1)->
    deleteFiltered('articles');

К оглавлению раздела "Модели"

К оглавлению документации для разработчиков

Специальные пункты меню

fuze (fuze@undisclosed.example.com) — 2026-09-12T17:43:12+00:00

Специальные пункты меню

При указании специального тега в качестве ссылки пункта меню InstantCMS может производить особые действия с этим пунктом.

Ссылки имеют вид {controller:action} или с параметрами {controller:action?id=123&foo=bar}.

Список специальных ссылок

Ссылка	Цель / Действие	Класс CSS
users/{user.id}	Мой профиль	profile
{messages:view}	Мои сообщения	messages messages-counter ajax-modal
{messages:notices}	Уведомления	info notices-counter ajax-modal
{moderation:panel}	Модерация	checklist
{moderation:user_panel}	Материалы пользователя на модерации	onchecklist
{moderation:draft}	Черновики	draft
{billing:balance}	Выводит баланс текущего пользователя и указывает на вкладку «Баланс» текущего пользователя	balance
{groups:my}	Мои группы (клубы)	group
{content:add}	Создать контент	add
{content:name}	Категории контента
{content:trash}	Корзина материалов	basket
{content:private_list}	Список приватных записей	lock
comments	Список комментариев
{admin:menu}	Админка	cpanel
users	Пользователи	group
{users:profile}	Ссылка на профиль текущего авторизованного пользователя
{users:profile_tab_name}	Ссылка на вкладку профиля пользователя (с учётом настроек вкладки), где tab_name имя вкладки. Подобные пункты меню работают, если само меню размещено виджетом на странице просмотра профилей. Например, {users:profile_karma} выведет вкладку с репутацией.
{users:settings}	Ссылка на редактирование профиля текущего авторизованного пользователя
{users:edit}	Ссылка на редактирование профиля текущего авторизованного пользователя. Отличие от пункта {users:settings} заключается в том, что меню с данным пунктом должно быть расположено виджетом на странице просмотра профилей и только если текущий авторизованный пользователь просматривает свой профиль.
{users:logout}	Ссылка на разавторизацию (выход) текущего пользователя. Работает, если само меню размещено виджетом на странице просмотра профилей и только если текущий авторизованный пользователь просматривает свой профиль.
{users:subscribers}	Ссылка на список подписчиков текущего авторизованного пользователя
{users:subscriptions}	Ссылка на список подписок текущего авторизованного пользователя
auth/login	Войти	ajax-modal key
auth/register	Регистрация	user_add
auth/logout?csrf_token={csrf_token}	Выход	logout

Подстановка ID пользователя

Если внутри ссылки есть тег {user.id} то он заменяется на ID текущего пользователя (на 0 для неавторизованных). {user.slug} заменяется на буквенный URL текущего пользователя или, если не указан, то ID текущего пользователя.

Например, ссылка на профиль текущего пользователя может выглядеть так: users/{user.id} или users/{user.slug}.

Создание контента

Тег: {content:add}

Пункт меню получает вложенные пункты, каждый из которых ведет на страницу создания контента определенного типа. При этом учитываются права доступа текущего пользователя. Например, если текущий пользователь имеет право создавать контент типа «Статьи», «Посты» и «Фотоальбомы», то сгенерированные пункты будут выглядеть так:

Создать статью
Создать пост
Создать фотоальбом

Категории контента

Тег: {content:name}, где name - системное имя любого типа контента

Пример: {content:articles}

Пункт меню получает вложенные пункты, открывающие категории указанного контента. Иерархия сгенерированных пунктов меню соответствует иерархии категорий.

Для InstantCMS выше 2.18.3 версии.

Поддерживается параметр ссылки с указанием категории, от которой выводить. Например, выражение вида {content:articles?category_id=1} выведет только категории первого уровня. Если указать, например, {content:articles?category_id=2}, то выведет только вложенные категории с id=2.

Приватные записи контента

Тег: {content:private_list}

Пункт меню получает вложенные пункты, открывающие списки записей контента с типом доступа «показывать только друзьям». Списки показываются только авторизованным пользователям. Все записи друзей текущего авторизованного пользователя, которые установили доступ только для друзей, будут показаны.

Корзина материалов

Тег: {content:trash}

Для InstantCMS 2.7.0 и выше.

Пункт меню открывает корзину материалов пользователя. Показывается в том случае, если как минимум для одного из типов контента правами доступа группы пользователя разрешено восстановление записей из корзины.

Личные сообщения

Тег: {messages:view}

Пункт меню открывает окно личных сообщений. При появлении новых сообщений рядом с пунктом появляется счетчик.

Личные уведомления

Тег: {messages:notices}

Пункт меню открывает окно уведомлений. При появлении новых уведомлений рядом с пунктом появляется счетчик. Если непрочитанных уведомлений нет - пункт меню скрывается.

Мои группы (клубы)

Тег: {groups:my}

Пункт меню получает вложенные пункты, открывающие профили групп в которых состоит текущий пользователь.

Панель модератора

Тег: {moderation:panel}

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

Материалы пользователя на модерации

Тег: {moderation:user_panel}

Для InstantCMS выше 2.8.2 версии.

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

Черновики

Тег: {moderation:draft}

Для InstantCMS выше 2.8.2 версии.

Пункт меню открывает список черновиков материалов пользователя. Пункт меню показывается в том случае, если как минимум один материал есть в черновиках.

Панель управления

Тег: {admin:menu}

Пункт меню получает вложенные пункты, совпадающие с пунктами меню в панели управления. Сам родительский пункт получает ссылку на панель управления.

Назад к разделу Управление меню

Введение

fuze (fuze@undisclosed.example.com) — 2026-08-20T18:52:10+00:00

Введение

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

добавление,
чтение,
изменение,
удаление,
фильтрацию.

Модель позволяет обойтись без написания «голых» SQL-запросов для обращения к базе данных. Вместо этого она предоставляет интерфейс (набор методов), позволяющих работать с записями в базе как с обычными ассоциативными массивами.

Термин «запись» здесь и далее обозначает, грубо говоря, одну строку в какой-либо таблице в базе. Либо, когда речь идет о чтении – одну строку из результатов запроса.

InstantCMS не использует ORM, поэтому сам термин «модель» здесь имеет несколько отличное от общепринятого значение. Модель в InstantCMS не является объектным представлением одной записи. Здесь модель – всего лишь объект, содержащий набор методов для работы с базой. То есть одна модель в InstantCMS может работать с любыми записями. Однако, есть и общие черты с ORM. Например, автоматическая фильтрация входящих данных.

Все методы построения запроса используют fluent-интерфейс: большинство методов возвращает `$this`, поэтому вызовы можно объединять в цепочки.

После выполнения большинства операций выборки/изменения состояние построителя запроса сбрасывается. Если необходимо сохранить фильтры между операциями, используется `lockFilters()`.

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

Модель добавляет уровень абстракции между бизнес-логикой (контроллером) и хранилищем данных (базой). Теоретически, это может позволить изменить хранилище (например, использовать PostgreSQL вместо MySQL) без необходимости внесения правок в код контроллеров.

Модель и компоненты

Каждая модель является логической частью какого-либо компонента. Модель не может существовать без компонента. Однако, компонент может содержать только модель.

Модель берет на себя всю работу по извлечению и изменению данных. Другие части компонента (контроллеры, шаблоны) не должны содержать никакой логики связанной с получением или хранением данных в базе. Они могут только запрашивать нужные данные у модели или наоборот, передавать ей новые данные для сохранения.

Использование модели внутри компонента подробно описано в соответствующем разделе.

Класс модели

Путь к файлу модели формируется по схеме: /system/controllers/{компонент}/model.php. Например, модель компонента «Комментарии» находится в файле /system/controllers/comments/model.php.

Внутри файла определяется класс модели, название которого образуется как model{Компонент}, например modelComments. Сам класс наследуется от системного класса cmsModel:

class modelExample extends cmsModel {}

Или вы можете унаследовать свою модель от другой существующей модели

class modelExample extends modelContent {}

Начиная с версии InstantCMS 2.14.2 можно создавать модели для бэкендов. Путь к файлу модели формируется по схеме: /system/controllers/{компонент}/backend/model.php. Например, бэкенд модель компонента «Контент» находится в файле /system/controllers/content/backend/model.php.

Модель бэкенда обычно, но не обязательно, наследуют от основной модели, расширяя её:

class modelBackendExample extends modelExample {}

Как использовать объект этого класса описано здесь.

К оглавлению раздела "Модели"

К оглавлению документации для разработчиков

Кеширование и состояние модели - создано

fuze (fuze@undisclosed.example.com) — 2026-08-20T18:31:12+00:00

Кеширование и состояние модели

В данном разделе описывается работа с кэшированием результатов запросов и управление состояниями модели. Под кэшированием подразумевается работа с данными, которые хранятся в Memcache/Memcached/Files/Redis, т.е. в том методе кэширования, который включен в настройках сайта. Если глобально кэширование не включено в настройках, вызов методов игнорируется.

useCache()

useCache($key)

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

$item = $this->
    useCache('articles.item')->
    getItemById('articles', $id);

Фактический ключ дополняется CRC32B от сформированного SQL, поэтому разные запросы под одним namespace не конфликтуют.

После выполнения операции ключ кеша автоматически отключается.

stopCache()

Защищённый внутренний метод, отключающий текущий ключ кеша.

Принудительная очистка кэша

cmsCache::getInstance()->clean($key)

В операциях SELECT данные, при включенном кешировании, записываются и получаются из метода кэширования. В операциях изменения записей, INSERT/UPDATE, в ваших методах вы должны очищать данные в кэше по вашему имени ключа. Учитывая пример выше:

public function addArticle($entry) {
 
    cmsCache::getInstance()->clean('articles.item');
 
    return $this->insert('articles', $entry);
}
 
public function updateArticle($id, $entry) {
 
    cmsCache::getInstance()->clean('articles.item');
 
    return $this->update('articles', $id, $entry);
}

Статический кеш внутри запроса

cacheResult()

cacheResult($key, $data)

Сохраняет произвольные данные в статическом массиве $cached. Использовать этот метод вы можете где угодно в своём коде.

cmsModel::cacheResult('current_ctype', $ctype);

getCachedResult()

getCachedResult($key)

Возвращает ранее сохранённые данные либо null.

Это отличается от useCache(): здесь используется статический массив PHP в рамках текущего выполнения.

$ctype = cmsModel::getCachedResult('current_ctype');

Сброс состояния

resetFilters()

Название историческое: метод сбрасывает не только WHERE, но и практически весь построитель запроса.

Сбрасываются:

SELECT;
encoded fields;
GROUP BY;
ORDER BY;
index hints;
LIMIT;
read type;
JOIN;
DISTINCT;
STRAIGHT JOIN;
состояние присоединённой online-таблицы.

Если keep_filters = false, также сбрасываются WHERE и системные флаги фильтрации.

lockFilters() / unlockFilters()

Используются, когда несколько операций должны использовать одни и те же условия.

Пример:

$this->
    filterEqual('user_id', $user_id)->
    lockFilters();
 
$count = $this->getCount('articles');
$items = $this->get('articles');
 
$this->unlockFilters();

Следует учитывать, что lockFilters() сохраняет именно условия фильтрации, а остальные части построителя запроса всё равно сбрасываются resetFilters().

Назад, к оглавлению раздела "Модели"

Назад, к оглавлению документации для разработчиков

Создание пакета дополнения CMS - [Создание пакета дополнения CMS]

fuze (fuze@undisclosed.example.com) — 2026-06-13T19:24:06+00:00

Создание пакета дополнения CMS

InstantCMS 2 использует механизм пакетов для установки любых дополнений (компонентов, виджетов, шаблонов, патчей и т.п.) и обновлений. Пакет - это упакованные в zip архив файлы заданной структуры. Файл должен иметь расширение zip. Есть ограничения по файлам: не более 5000 файлов в архиве, максимальный распакованный размер всех файлов 60Мб, не более 10Мб на один файл.

Типы пакетов

Пакеты могут быть нескольких типов и в зависимости от них CMS выполняет те или иные действия.

Пакет установки компонента

Такой пакет предполагает, что будет выполнен процесс установки компонента. Т.е. подразумевается, что компонент ранее не был установлен. При таком типе пакета CMS сама заполняет таблицу cms_controllers.

Пакет обновления компонента

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

Пакет установки виджета

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

Пакет обновления виджета

Алгоритм действия аналогичен пакету обновления компонента с тем отличием, что используется таблица cms_widgets для изменения данных.

Пакет общего назначения

Движок распознает такой пакет в случае, если в файле манифеста (о нем ниже) отсутствуют блоки [install] или [update]. При установке такого пакета CMS ничего делать не будет в плане автоматического создания записей в таблицах cms_controllers и cms_widgets. Разработчик дополнения в этом случае сам должен позаботиться об этом.

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

Внутри архива дерево файлов выглядит в общем случае вот так:

В дереве обязательно должны присутствовать:

файл manifest.ЯЗЫК.ini

Необязательны в архиве следующие файлы:

папка package;
файл install.sql;
файл icon.png;
файл install.php;
файл options.form.php;
файл deleted.files.txt;
файлы manifest.ЯЗЫК.ini на языках, отличных от русского.

Структура папки package

Структура папки package полностью совпадает со структурой папок на самом сайте. Таким образом в нее копируется вся структура папок вашего дополнения так, как она есть на самом сайте, начиная с его корня.

Файл иконки дополнения

Файл должен находиться в корне архива и иметь название, указанное в файле manifest. Файл должен быть в одном из форматов: jpg, png, webp. Не делайте файл большого размера, файлы более 1Мб будут проигнорированы. Размер сторон не более чем 400*400px.

Файл install.sql

В этом файле описываются все необходимые sql запросы, которые наполняют какие-либо таблицы или создают новые, необходимые вашему дополнению. В sql запросах префикс таблиц должен быть заменен на {#}. Например, если оригинальный запрос имеет такой вид:

INSERT INTO `cms_controllers` (`title`, `name`, `is_enabled`, `options`, `author`, `url`, `version`, `is_backend`) VALUES
('Микроформат Open Graph', 'opengraph', 1, '---\nenabled_ctypes:\nis_https_available: null\ndefault_image:\n', 'InstantMedia Team', 'https://instantmedia.ru/', '1.1.0', 1);

то в этом файле этот запрос должен выглядеть так:

INSERT INTO `{#}controllers` (`title`, `name`, `is_enabled`, `options`, `author`, `url`, `version`, `is_backend`) VALUES
('Микроформат Open Graph', 'opengraph', 1, '---\nenabled_ctypes:\nis_https_available: null\ndefault_image:\n', 'InstantMedia Team', 'https://instantmedia.ru/', '1.1.0', 1);

Обратите внимание, что в версиях InstantCMS выше 2.3.0 в этом файле нет необходимости писать sql запросы, добавляющие записи в таблицы cms_widgets и cms_controllers, достаточно указать в файле манифеста тип дополнения. При установке дополнения движок сам добавит нужные записи в эти таблицы на основе данных в файле манифеста и далее автоматически будет следить за версионностью при установке пакетов обновлений.

Файл install.php

В этом файле должна быть определена функция install_package как без аргументов, так и с аргументом $install_options, в котором будут опции пакета (об этом ниже). Внутри функции вы можете выполнять любые действия, вызвав нужные объекты классов системы. Конечно же, в этом файле вы можете создать сколь угодно своих функций и обращаться к ним из функции install_package. Функция install_package должна возвращать:

true, если все заданное в ней выполнено успешно;
false, если при выполнении кода произошла какая-то ошибка;
текст ошибки, который будет показан пользователю при установке дополнения.

В случае ответа false или текста ошибки InstantCMS не создаст записи в таблицах cms_widgets и cms_controllers и дополнение будет считаться неустановленным.

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

Файл options.form.php

Этот функционал доступен с InstantCMS 2.18.2

Каждый установочный пакет при необходимости может иметь набор опций, которые запрашиваются у пользователя на финальном этапе установки пакета. Для создания формы опций необходимо:

Создать php файл options.form.php в корне пакета установки;
В нем определить класс для формы опций с названием по принципу formInstallPackageOptions;
Описать поля формы.

Форма будет показана на последнем шаге установки, перед выполнением логики в файле install.php, который также требуется для того, чтобы опции были показаны. После успешной отправки формы с опциями, их массив, например $install_options, будет передан первым аргументом в функцию install_package, где вы будете с ним работать.

Файл deleted.files.txt

Этот функционал доступен с InstantCMS 2.18.0

В этом файле вы можете перечислить пути к файлам, которые необходимо удалить после установки пакета. Как правило, имеет смысл это делать для пакетов обновления.

Пути должны быть указаны относительно корня установки InstantCMS, без начального слэша. Пустые строки установщик проигнорирует. Строки, начинающиеся с символа решётки # тоже игнорируются. Например:

system/controllers/admin/actions/content_grid_columns.php
system/controllers/admin/actions/content_items_ajax.php
# Можно писать комментарии
system/controllers/admin/actions/controllers_ajax.php
system/controllers/admin/actions/controllers_events_ajax.php

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

Файл manifest.*.ini

Этот файл имеет синтаксис обычного ini файла, например такого, как php.ini. Название файла должно иметь следующую структуру:

manifest.{название языка}.ini

Т.е. в зависимости от того, какие языки поддерживает ваше дополнение, вы можете создать для каждого из них свой файл манифеста. Файл manifest.ru.ini будет использоваться по умолчанию. Например, для английской локализации название файла будет выглядеть как manifest.en.ini.

В файле могут быть обозначены следующие блоки:

[info]
[version]
[depends]
[author]
[description]
[package_controllers]

а также, в случае типизирования пакета:

[install] или
[update]

Блок [info]

Это обязательный блок

title = "Название вашего дополнения, не более 64 символов"
image = "Название иконки дополнения вместе с расширением файла, например icon.png"
addon_id = "id вашего дополнения в официальном каталоге дополнений"
image_hint = "Название поясняющего изображения, например hint.png"

Отметим, что строка addon_id необязательна, но крайне рекомендуем её указать. В этом случае у владельца сайта, где ваше дополнение будет установлено, в каталоге дополнений в админке будет видно, что пакет установлен, будет отслеживаться версионность и работать уведомления о новых версиях.

Опция image_hint поддерживается в версиях InstantCMS выше 2.12.2. Работает только для пакетов виджетов. Если указана, то она будет показана в списке виджетов под названием. После установки перемещается в директорию upload/package-images/widgets/.

Блок [version]

Это обязательный блок

major = "первая цифра версии"
minor = "вторая цифра версии"
build = "третья цифра версии"
date  = "дата релиза дополнения, например 20251231"

Блок [depends]

Это необязательный блок

core = "версия InstantCMS, ниже которой дополнение работать не будет"
php = "версия PHP, ниже которой дополнение работать не будет"
package = "версия уже установленного дополнения"

например,

core = "2.16.0"
package = "1.5.7"
php = "8.3.0"
php_ext[imagick] = "*"

Опция package нужна лишь при типе пакета «обновление компонента» или «обновление виджета». Если она указана, то обновление не установится, если уже установленная версия дополнения имеет версию ниже заданной здесь. Это полезно, чтобы наверняка знать, что обновление, например, под цифрой 2.0.5 должно обязательно устанавливаться на версию 2.0.4. Опция php работает с InstantCMS 2.17.0.

Параметры, поддерживаемые с версии InstantCMS 2.6.0.

dependent_type = "тип дополнения, от которого зависит устанавливаемое и которое должно быть уже установлено"
dependent_name = "имя зависимого дополнения"
dependent_controller = "название контроллера зависимого дополнения"
dependent_version = "версия зависимого дополнения, ниже которой нельзя установить текущий пакет"
dependent_url = "ссылка на страницу зависимого контроллера"
dependent_title = "название зависимого контроллера"

Указав вышеперечисленные параметры, вы можете распространять пакеты, которые не установятся в админке, если условия не соблюдены. Например, вы создали некий компонент. Распространяете его. После вы решили сделать отдельно виджет для него. В пакете установки этого виджета укажите в зависимостях наличие вашего компонента. Например, параметры для зависимого от контроллера виджета могут выглядеть так:

dependent_type = "component"
dependent_name = "video"
dependent_version = "2.2"
dependent_url = "https://instantcms.ru/addons/instantvideo2.html"
dependent_title = "InstantVideo2"

В этом случае, если не установлен компонент InstantVideo2 или он установлен, но ниже версии 2.2, пакет виджета не сможет установиться.

В случае, если ваше дополнение зависит от наличия установленного виджета (например, ваш пакет распространяет дополнительный шаблон к нему), то параметры могут быть такими:

dependent_type = "widget"
dependent_name = "promo"
dependent_controller = "video"
dependent_version = "2.0"
dependent_url = "https://instantcms.ru/addons/instantvideo2.html"
dependent_title = "Промо видео для InstantVideo2"

В этом случае при установке дополнения будет требоваться наличие виджета «Промо видео для InstantVideo2» версии не ниже 2.0. Стоит отметить, что параметр dependent_version необязателен, и версионность проверятся только при его наличии.

Параметры, поддерживаемые с версии InstantCMS 2.17.0.

php_ext[imagick] = "*"
php_ext[gd] = "8.3.6"

Такими конструкциями вы можете указать для дополнения зависимые модули PHP и их требуемые версии. Символ звёздочки - означает любую версию. В данном примере дополнению будет требоваться два модуля: imagick и gd. imagick требуется любой версии, gd - не ниже 8.3.6.

Блок [author]

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

name  = "Наименование разработчика: бренд или просто какое-то имя, не более 128 символов"
url   = "Если есть, адрес сайта c http://, не более 250 символов"
email = "email разработчика, если есть"

Блок [description]

Это необязательный блок

text[] = "Описание дополнения"
text[] = "Строк может быть одна или"
text[] = "несколько"

Блок [install] или [update]

В файле может быть только один из указанных блоков, т.е. либо [install], либо [update]. По ним CMS определяет тип: установка или обновление. Внутри блока (одинаков для обоих типов) обязательно должны быть определены следующие опции:

type = "можно указать только component или widget или system"
name = "системное имя"
controller = "опция для виджета, может быть не заполнено или вовсе отсутствовать, если виджету контроллер не нужен"

Например, для пакета установки компонента video блок может выглядеть так:

[install]
type = "component"
name = "video"

а для обновления вот так:

[update]
type = "component"
name = "video"

Для установки виджета, привязанному к определенному компоненту опции могут быть такими:

[install]
type = "widget"
name = "related"
controller = "video"

Аналогично и в случае обновления.

Блок [package_controllers]

Если ваш пакет включает в себя несколько контроллеров, то их нужно перечислить в этом блоке, например:

[package_controllers]
controller[] = "video"
controller[] = "channels"

Это необходимо, для корректного заполнения эвентов в базе данных на основе манифестов.

Видео туториал

Видео-туториал по созданию инсталлятора дополнений.

Удаление компонентов

Начиная с версии InstantCMS 2.4.0 доступен механизм удаления сторонних компонентов. По умолчанию экшен удаления выполняет удаление записи о компоненте в таблице cms_controllers. Разработчики компонентов могут дополнить механизм по умолчанию двумя способами:

создать метод с названием deleteController в своей модели и описать там инструкции по удалению, обратные тем, что выполнялись при установке;
создать в бэкенде своего контроллера специальный экшен «delete_component», где так же описать действия по удалению данных компонента.

Вы можете не дополнять и не реализовывать механизм удаления, если в вашем компоненте это не нужно. В этом случае при удалении просто удалится запись в таблице cms_controllers.

В случае с методом модели, код может быть выглядеть так:

public function deleteController($id) {
 
    // здесь вы пишите некий код, который, например, удаляет таблицы, созданные компонентом при установке
    // удаляете записи интеграции с другими компонентами, например
    // из ленты активности, rss и других компонентов, используемых вами
 
 
    // вы должны обязательно вызвать родительский метод, чтобы запись в таблице cms_controllers удалилась
    return parent::deleteController($id);
 
}

Экшен бэкенда контроллера следует использовать, если вы хотите при удалении компонента каких-то действий от пользователя. Экшен создается как обычный экшен контроллера бэкенда. Название экшена должно быть строго «delete_component». Параметры в него не передаются. Финальным результатом, помимо действий, необходимых для вашего компонента, должно быть удаление записи в таблице cms_controllers.

$this->model->deleteController($controller_id);

К оглавлению

Установка InstantCMS 2

fuze (fuze@undisclosed.example.com) — 2026-06-07T12:42:40+00:00

Установка InstantCMS 2

Загрузите дистрибутив InstantCMS с официального сайта.

Распакуйте загруженный архив и загрузите его содержимое на сервер, в корневую директорию вашего сайта. Также есть возможность установки в поддиректорию.

Перейдите по адресу http://your-site/install/ (где your-site - адрес вашего сайта) чтобы запустить Мастер установки.

О безопасности установки и использования InstantCMS вы можете прочитать в этом разделе.

Права доступа

Все файлы и директории CMS должны быть недоступны для записи пользователю, под которым работает web сервер (www-data обычно). Исключения составляют директории /cache/ и /upload/ и всех вложенных в них, а также файл конфигурации CMS и файл конфигурации шаблона, находящиеся в /system/config/.

Как правило, установите для всех файлов движка права (chmod) 644, а для всех директорий права (chmod) 755. После этого для директорий /cache/ и /upload/ и всех вложенных в них установите права 777. На время установки движка так же должна быть доступна для записи (права 777) директория /system/config/. После процедуры установки права доступа для нее нужно выставить в 755.

Для шаблона modern также нужно дать права на запись (666 в общем случае) для CSS файлов шаблона. Т.е. на все файлы в директории /templates/modern/css/, а также для CSS файлов контроллеров /templates/modern/controllers/название/styles.css.

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

На unix-like системах вы можете использовать вот такой простой скрипт для быстрой установки правильных прав доступа:

#!/bin/bash
 
clear
 
if [ -z "$1" ]
  then
    echo "Введите абсолютный путь к корневой папке InstantCMS 2.X"
    exit
fi
 
SITE_PATH=$1
 
echo "Устанавливаем корректные права доступа для сайта с корневой категорией $SITE_PATH"
 
find $SITE_PATH/ -type f -exec chmod 644 {} \;
find $SITE_PATH/ -type d -exec chmod 755 {} \;
 
# на время установки
chmod 777 $SITE_PATH/system/config;
 
find $SITE_PATH/cache -type d -exec chmod 777 {} \;
find $SITE_PATH/upload -type d -exec chmod 777 {} \;
find $SITE_PATH/templates/modern/css/ -name "*.css" -exec chmod 666 {} \;
find $SITE_PATH/templates/modern/controllers/ -name "*.css" -exec chmod 666 {} \;

Указанный код нужно скопировать в любой файл, дать ему название, выставить права на исполнение (755) и запускать, передавая параметром полный путь к корню сайта, например:

файл: chmod_icms.sh
запускать так: chmod_icms.sh /path/to/icms_site_root

Вступление

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

Также вам необходимо либо создать заранее созданную базу данных MySQL в кодировке utf8_general_ci/utf8mb4_general_ci или указать её создание при установке.

База данных может быть пустой, но это не обязательно. Для избежания конфликтов с имеющимися таблицами можно будет изменить префикс таблиц (см. ниже).

Лицензия

InstantCMS распространяется по лицензии GNU/GPL версии 2.

Оригинальный текст лицензии расположен по адресу: http://www.gnu.org/licenses/gpl-2.0.html

Неофициальный русский перевод: http://jxself.org/translations/gpl-2.ru.shtml

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

Вы должны быть согласны с условиями лицензии чтобы продолжить установку и использование InstantCMS.

Проверка PHP

Для работы InstantCMS 2 требуется PHP версии 7.4 или выше.

В секции Требуемые расширения приведен список модулей для PHP, без которых работа InstantCMS будет невозможна. Если любой из них отмечен строкой «Не найдено» то вам нужно обратиться к администратору сервера (или в поддержку хостинга) с просьбой установить требуемый модуль. После того как модуль будет предоставлен нужно перезапустить Мастер установки (обновить страницу).

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

Указание путей

На данном шаге необходимо указать пути и URL для корня сайта, директорию для загрузок, директорию кэша, директорию хранения сессий PHP.

Настройки по-умолчанию подходят для большинства случаев.

Если вы планируете использовать общую базу пользователей с другим сайтом на InstantCMS2, директория хранения сессий PHP должна быть единой. Подробнее о сквозной авторизации написано в этом разделе.

Также, если вы планируете использовать общую базу пользователей с другим сайтом на InstantCMS 2, нужно изменить путь и URL папки для загрузок. Они должны указывать на папку для загрузок первого (созданного ранее) сайта. Это необходимо для того, чтобы изображения и файлы загружаемые пользователями имели одинаковые пути на обоих сайтах.

Например, первый сайт расположен по адресу http://site1 и лежит в папке /var/www/site1. Текущий устанавливаемый сайт располагается по адресу http://site2 и лежит в /var/www/site2. Тогда необходимо указать следующие пути:

Папка для загрузок: /../site1/upload/
URL для загрузок: http://site1/upload

То есть указываем путь папки для загрузок первого сайта относительно текущего пути. URL для загрузок так же указываем от первого сайта. Не забываем про директиву PHP open_basedir, директория upload должна быть в её видимости.

Сайт

На этом шаге вы можете указать базовые настройки вашего сайта: название, описание. Выбрать шаблон самого сайта и/или панели управления. Если у вас кастомная сборка, то будут показаны все доступные шаблоны.

Если отмечен чекбокс «Генерировать рандомный URL админки», то урл админ панели будет с рандомным названием вместо стандартного «/admin», например:/lomerisu47, /demokaru81, /savenito23 и так далее. Вернуть обратно стандартный URL или изменить его вы можете после установки в самой панели управления в списке компонентов.

Если вам не нужна автоматическая проверка обновлений, то снимите чекбокс «Автоматически проверять обновления InstantCMS».

База данных

На данном шаге требуется указать реквизиты для подключения к созданной вами заранее базе данных MySQL или поставить над полем «База данных» чекбокс «Если не существует, будет создана», в этом случае CMS сама создаст базу данных с заданным названием (у пользователя БД должен быть доступ для создания баз данных).

Если вы не знаете какие реквизиты нужно указывать – обратитесь к администратору сервера или поддержку хостинга.

В поле Кодировка базы данных вы можете выбрать сопоставление кодировки базы данных. UTF8 или UTF8mb4. Данные в UTF8mb4 будут занимать больше места, однако станут доступны все специальные символы UTF8, например эмодзи.

В поле Движок базы данных вы можете выбрать движок базы данных. Database engine, storage engine (движок базы данных, подсистема хранения данных) — компонент СУБД, управляющий базами данных, или библиотека, подключаемая к программам и дающая им функции СУБД. Лучше всего выбирать InnoDB.

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

Поле Таблица с пользователями позволяет выбрать уже существующую таблицу в которой хранятся пользователи сайта. Это необходимо в случае если в указанной базе данных уже располагаются таблицы от другого сайта на InstantCMS 2 и вы хотите иметь общих пользователей с этим сайтом. Название существующей таблицы нужно указывать в полном виде (так, как оно отображается в phpMyAdmin).

При установке чекбокса «Установить демо данные» Мастер установки так же установит демо контент для более понятного знакомства с CMS.

Администратор

На данном шаге создается профиль главного администратора сайта. Используя указанный здесь e-mail и пароль вы сможете авторизоваться на сайте после его установки.

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

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

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

На данном шаге создается главный файл конфигурации сайта. Путь его размещения показан в мастере.

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

Планировщик

На данном шаге приводятся подробные инструкции о том как создать задание для планировщика CRON на сервере.

Действия после установки

После завершения установки обязательно удалите папку install в корне вашего сайта! Установите права доступа 755 на директорию /system/config/. Для корректной работы авторизации и регистрации вам необходимо получить ключи reCAPTCHA для вашего домена.

Установка обновлений и дополнений

Инструкция по установке обновлений и дополнений

Установка обновлений и дополнений для InstantCMS 2

fuze (fuze@undisclosed.example.com) — 2026-05-28T17:52:47+00:00

Установка обновлений и дополнений для InstantCMS 2

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

Установка из каталога дополнений

Начиная с InstantCMS версии 2.8.1 в админку CMS встроен официальный каталог дополнений. Попасть в него можно либо из основного меню админки, либо

Панель управления ⇒ Компоненты ⇒ Каталог дополнений

Каталог разбит по категориям, доступна фильтрация платные/бесплатны, доступен поиск по названию дополнения. Бесплатные дополнения устанавливаются по клику на кнопку «Установить», после чего вы автоматически будете на пункте 5 автоматического способа установки (см. ниже).

Для каждого дополнения показывается совместимость с вашей версией InstantCMS. Если она указана автором дополнения, каталог об этом напишет. Дополнения, обозначенные как «Не тестировался с вашей версией InstantCMS», могут с равной долей вероятности как заработать в вашей версии InstantCMS, так и не заработать. В таких случаях стоит уточнять у авторов.

Все корректно установленные компоненты/виджеты будут показаны во вкладке «Установленные» каталога дополнений. В этой же вкладке вы сможете следить за их обновлениями, а в случае бесплатных дополнений сразу же обновлять автоматически.

Для каждого дополнения также показывается дата последнего обновления. Это дата выпуска крайней версии.

Ручная установка файла пакета

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

Автоматический способ

Используйте этот способ, если на вашем сервере есть возможность входа по FTP или права доступа позволяют пользователю, под которым работает WEB сервер сохранять файлы в дерево файлов вашей установки InstantCMS.

Перейдите в Панель управления сайтом;
Перейдите в раздел Компоненты;
Нажмите Установить пакет дополнения;
Выберите архив (или ссылку на скачивание файла) с дополнением или обновлением, которое вы хотите установить;
На странице «Информация о пакете» нажмите Установить;
Заполните, если CMS потребует, реквизиты для доступа по FTP (необходимо для загрузки файлов пакета на сайт);
Установка завершена.

Ручной способ

Используйте в случае, если доступ по FTP на сайт невозможен, либо вы не уверены в том, как правильно указать реквизиты FTP в автоматическом установщике.

В архиве, который вы хотите установить, откройте папку package;
Все содержимое этой папки загрузите в корень вашего сайта (если по ftp, то в двоичном режиме);
Далее сделайте все то же самое, что написано выше, в «Автоматическом способе», но в п.6 поставьте чекбокс «Пропустить этот шаг» и нажмите «Установить».

Изменять исходный архив пакета не нужно.

После установки дополнения может случиться такое, что права на файлы и директории при копировании выставились некорректно. Рекомендуем проверить и выставить правильные права доступа. Какие они должны быть написано здесь.

После установки/обновления дополнений очистите кэш браузера, увеличьте на единицу абстрактный счётчик в настройках сайта, если после установки пакета это не выполнилось по каким-то причинам.

Установка обновлений InstantCMS

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

Автоматическая установка

Включите режим отладки в админке.
Воспользуйтесь функцией «Проверить обновления» в панели управления InstantCMS.
Система сама обнаружит обновление следующей версии, предложит скачать его и установить.
Выполните действия автоматического способа установки дополнений, описанные выше.
Проверьте, что версия InstantCMS изменилась в админке.
Обновление завершено. Если возникли ошибки при установке пакета, то обновление прошло некорректно, воспользуйтесь ручной установкой.

Ручная установка

Включите режим отладки в админке;
Загрузите архив с обновлением по ссылке, размещённой в новости к релизу;
Перейдите в панель управления сайтом;
Перейдите в раздел компоненты;
Нажмите установить пакет дополнения;
Очистите кеш браузера;
Сверните окно браузера;
Все содержимое папки package из архива обновления, скаченного в п.1 загрузите в корень вашего сайта, заменяя файлы;
Вернитесь в свернутое в п. 7 окно браузера, нажмите F5 на клавиатуре (обновите страницу) и выберите архив, который вы скачали в п.2;
На странице «Информация о пакете» нажмите установить;
На странице ввода реквизитов ftp поставьте чекбокс «Пропустить этот шаг» и нажмите «Установить»;
Выключить режим отладки в админке;
Обновление завершено. Если при установке пакета возникли ошибки, то обновление установилось некорректно по какой-то причине. В этом случае необходимо смотреть логи PHP на сервере.

Назад к разделу Администраторам

Биллинг: Подключение Robokassa

fuze (fuze@undisclosed.example.com) — 2026-05-13T19:34:28+00:00

Биллинг: Подключение Robokassa

Панель управления ⇒ Компоненты ⇒ Биллинг ⇒ Системы ⇒ Robokassa

Регистрация в Robokassa

https://login.robokassa.ru/

Настройка магазина в Robokassa

Зайдите в личный кабинет;
В меню слева выберите Мои магазины;
Нажмите Добавить новый;
Заполните форму и создайте магазин;
Перейдите на вкладку «Технические настройки» в настройках магазина;
Заполните поля:

Поле	Значение
Пароль #1	Случайный набор символов
Пароль #2	Случайный набор символов
Result Url	`https://example.com/billing/process/robokassa`
Метод отсылки данных по Result Url	POST
Success Url	`https://example.com/billing/success/robokassa`
Метод отсылки данных по Success Url	GET
Fail Url	`https://example.com/billing/fail`
Метод отсылки данных по Fail Url	GET

Вместо example.com используйте адрес вашего сайта

Настройка Robokassa в биллинге

Поле	Значение
Идентификатор магазина	Указан на вкладке «Технические настройки» в настройках магазина в Robokassa
Режим работы	Рабочий или тестовый режим. Пароли ниже задаются для каждого режима.
Пароль #1	Первый пароль из технических настроек магазина
Пароль #2	Второй пароль из технических настроек магазина
Включить отправку фискального чека	Включает отправку фискального чека. В раскрывающихся опциях укажите налоговые параметры.

После завершения настройки подайте запрос на активацию магазина через личный кабинет Robokassa.

Вернуться к списку систем

Биллинг: Подписки

fuze (fuze@undisclosed.example.com) — 2026-03-04T13:06:05+00:00

Биллинг: Подписки

Панель управления ⇒ Компоненты ⇒ Биллинг ⇒ Подписки

Биллинг позволяет реализовать платное изменение группы пользователя. То есть, дать пользователям возможность временно повышать свои привилегии путем вступления в другую группу.

Подписки реализуются с помощью тарифных планов. Каждый тарифный план определяет в какую группу (или группы) пользователь попадает после его покупки. Стоимость плана указывается за один или несколько периодов. При покупке тарифного плана пользователь сможет выбрать период подписки и оплатить соответствующую сумму.

Подписки могут составлять очередь. Например, пользователь Вася покупает подписку на тариф №1 сроком на полгода. Через месяц он покупает подписку на тариф №2, сроком на месяц. В этот момент первая подписка замораживается до окончания второй. Через месяц подписка на тариф №2 истекает и пользователь возвращается на тариф №1 на оставшиеся 5 месяцев. По их истечении пользователь возвращается в то состояние, в котором он был до оформления первой подписки.

Контроль за подписками осуществляется с помощью задачи «Отслеживание окончания подписок» в планировщике.

Создание тарифного плана

При создании плана необходимо заполнить следующие поля:

Тарифный план доступен для покупки

Если включено, то план будет отображаться на сайте и пользователи смогут приобретать подписку на него.

Название тарифного плана

Имя плана, отображается пользователям.

Описание плана

Краткое пояснение преимуществ, которые пользователь получит при подписке на данный тарифный план

Максимальный вывод

Указывается максимальная сумма для вывода во внутренней валюте.

Покупка только за реальную валюту

Если включено, стоимость подписки будет выводиться в реальной валюте (по курсу ввода) и каждый раз будет требоваться пополнения баланса на сумму подписки, даже если на внутреннем балансе хватает баллов. Если отключено, то для покупки будет использоваться внутренний баланс (баллы), а пополнение будет требоваться только при нехватке баллов на внутреннем балансе.

Подписывать пользователей на тарифный план сразу после регистрации

Если включено, то пользователь будет сразу подписан на этот тарифный план, даже если план платный.

При активации добавлять подписчика в группы

Определяет в какую группу (или группы) пользователь будет добавлен после покупки данного тарифного плана. После окончания подписки пользователю будет возвращен тот набор групп, который у него был до подписки.

Заменить группы пользователя

Если включено, то группы пользователя будут заменены указанными выше. Если выключено, то группы будут добавлены к существующим.

Характеристики

Здесь вы привязываете характеристики, добавленные в общих опциях Биллинга и указываете значения. Для характеристик типа «Да/Нет» указываете 0 или 1, для характеристик типа «Значение» указываете значение.

Стоимость подписки

Здесь можно указать несколько периодов подписки, доступных для покупки, и стоимость каждого из этих периодов. Чем больше периодов будет указано, тем большая свобода выбора будет у пользователя при оформлении подписки. Так же можно снижать цены за большие сроки подписки.

При нажатии на «Добавить цену» вы указываете размер периода, например «1» и «Месяц», цену во внутренней валюте за этот период, при необходимости кэшбэк - количество баллов, начисляемых обратно после покупки. Опция «Зачислить на баланс» работает, если включена опция «Покупка только за реальную валюту». В этом случае при покупке за реальную валюту подписка включится, а стоимость зачислится на баланс. Если опция «зачислить на баланс» указана в «Нет», то купленные баллы за подписку тут же потратятся на оплату самой подписки.

Вернуться к оглавлению

Биллинг: Опции

fuze (fuze@undisclosed.example.com) — 2026-03-04T12:04:21+00:00

Биллинг: Опции

Панель управления ⇒ Компоненты ⇒ Биллинг ⇒ Опции

Общие

Внутренняя валюта сайта

Название внутренней валюты, во множественном числе, с маленькой буквы. Например: баллы.

Числительные склонения внутренней валюты

Строка, состоящая из трех числительных, разделенных вертикальной чертой: |

Числительные по формуле: один|два|много. Например, если внутренняя валюта называется «баллы», то строка будет иметь вид: балл|балла|баллов.

Реальная валюта

Название расчетной валюты, в которой будут приниматься реальные платежи от пользователей. Все остальные валюты принимаемые к оплате будут пересчитаны в данную валюту, по указанным курсам. Например: руб.

Символ реальной валюты

Символ реальной валюты, например ₽ для рублей, $ для долларов, € - евро и так далее.

Минимальный пакет

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

Начислять при регистрации

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

Шаблон кнопки для продажи полей

HTML шаблон для кнопки продажи полей. Доступны выражения {url}, {price}, {title} а также вставка иконок выражениями типа {solid%coins}.

{url} это URL покупки поля, учитывая все зависимости;
{price} - цена поля;
{title} - название кнопки для продажи полей, учитывая все зависимости, о них опции ниже.

Название кнопки для продажи полей

Название может быть различным для авторизованных и неавторизованных (гостей). В поле доступно выражение {price} с ценой поля. Поскольку цены могут быть разными, то для гостей выводится минимальная цена. Для тех, кто авторизовался, выводится актуальная цена, учитывая права доступа.

Ввод

Пополнение баланса за реальные деньги

Опция позволяет пользователям покупать внутреннюю валюту за реальные деньги с помощью платежных систем. Здесь же можно указать цену покупки внутренней валюты в реальной валюте сайта. Можно добавить несколько цен, чтобы предоставить скидки на объем покупаемой валюты.

Опция имеет варианты: Разрешено/Запрещено/Разрешено только через покупку подписки. Если разрешено только через покупку подписки, то простое пополнение баланса счёта не будет доступно.

Нажатие на ссылку «Добавить обменный курс» добавляет новую цену. В поле «Количество, от» указывается объем покупаемой валюты, а в поле «Стоимость» - цена за единицу при покупке данного объема и выше.

Например, если заданы цены:

Количество, от	Стоимость, руб.
1	1
10	0.5

то при покупке 5 единиц валюты стоимость для пользователя составит 5 руб., но при покупке 20 - всего 10 руб.

Подписки

Включить возможность подписки на тарифные планы

Опция позволяет пользователям покупать подписку на тарифные планы, настраиваемые в разделе Подписки.

Уведомлять об окончании подписки по e-mail за

Количество дней, за которое пользователю будет отправлено уведомление о скором завершении оформленной им подписки.

Характеристики подписок

Здесь вы можете добавлять характеристики подписок. Это информационные описания возможностей подписок. При создании подписок вы сможете привязывать эти характеристики и задавать значения.

При нажатии на кнопку «Добавить характеристику» вы указываете:

Идентификатор характеристики: буквенный идентификатор латиницей;
Заголовок: описание характеристики, выражение {value} заменится на значение при привязке характеристики к плану;
Тип характеристики: «Да/Нет» или «Значение». При привязке к тарифному плану для типа «Да/Нет» нужно указывать 0 или 1 для «Нет» или «Да» соответственно. Для типа «Значение» - указывайте значение.

Порядок характеристик можно менять перетаскиванием.

Переводы

Разрешить переводы внутренней валюты между пользователями

Позволяет пользователям переводить свои средства друг другу. Для совершения перевода пользователь должен зайти в профиль получателя и нажать ссылку «Перевести средства» в меню действий.

Требовать подтверждение перевода по e-mail

Если включено, то при совершении перевода отправитель получает письмо по e-mail, содержащее ссылку с уникальным кодом. Отправитель должен перейти по этой ссылке чтобы подтвердить перевод. Только после этого средства будут списаны с его баланса и зачислены получателю. Опция рекомендуется.

Уведомлять получателя о переводе по e-mail

Позволяет сообщать получателю перевода по e-mail о том, что на его баланс поступили средства от другого пользователя.

Переводы между пользователями могут отменяться администраторами из раздела "История".

Обмен

Биллинг может позволить пользователям покупать и продавать (обменивать) свой рейтинг за внутреннюю валюту. Покупка рейтинга может использоваться как способ поднятия своего профиля в общем списке пользователей. Продажа - как способ получения средств, для дальнейшего расходования на другие услуги сайта.

Обмен разрешен группам

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

Разрешить обмен рейтинга на валюту

Разрешает продажу рейтинга.

Курс обмена рейтинга

Сколько единиц внутренней валюты пользователь получит при продаже одной единицы рейтинга.

Разрешить обмен валюты на рейтинг

Разрешает покупку рейтинга.

Курс обмена валюты

Сколько единиц рейтинга пользователь получит за одну единицу внутренней валюты.

Вывод

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

Разрешить заявки на вывод денег

Если включено, пользователи смогут создавать заявки на вывод внутренней внутренней валюты в реальные деньги.

Вывод разрешен группам

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

Требовать подтверждение вывода по e-mail

Если включено, то при создании заявки на вывод пользователь получает письмо по e-mail, содержащее ссылку с уникальным кодом. Пользователь должен перейти по этой ссылке чтобы подтвердить заявку. Только после этого заявка становится видна администратору и появляется в разделе Заявки на вывод. Опция рекомендуется.

Период для вывода

Позволяет ограничить вывод. Один пользователь может создать заявку на вывод только один раз в указанное число дней.

Минимальная сумма для вывода

Позволяет ограничить минимальный размер выводимых средств.

Курс вывода

Стоимость 1 единицы внутренней валюты в реальной валюте сайта

Платежные системы для вывода

Список платежных систем (или других способов), в которых администратор может производить выплату реальных денег. По одной системе на строке. Пользователь сможет выбрать одну из указанных здесь систем при создании заявки на вывод. Должна быть указана хотя бы одна система или способ.

Уведомлять о заявках на вывод по e-mail

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

Рефералы

Биллинг позволяет организовать многоуровневую реферальную программу. Пользователи могут приводить на сайт новых участников (рефералов) и получать процент от дохода сайта, полученного с них.

Включить реферальную программу

Если включено, то в профиле каждого пользователя на вкладке «Баланс» появляется ссылка «Рефералы», ведущая на одноименную страницу. Там публикуется реферальная ссылка для этого пользователя, которую он должен распространять для привлечения рефералов. Там же публикуется список уже привлеченных рефералов и доход, который они принесли пригласившему.

Реферальная программа разрешена группам

Реферальная программа будет разрешена только указанным группам пользователей.

Фиксировать рефералов как приглашённых пользователей

Рефералы будут фиксироваться как приглашённые по инвайтам (приглашениям), см. компонент Авторизация и Регистрация.

Время жизни реферальной куки

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

Хранить реферальную куку после успешной регистрации

Реферальная кука не будет удаляться после регистрации.

URL для редиректа с реферальной ссылки

Сразу после перехода по реферальной ссылке посетитель может быть переадресован на указанный здесь адрес (например, на страницу регистрации). Если оставить поле пустым, то будет происходить переадресация на главную страницу сайта.

Ссылка на правила реферальной программы

URL страницы, содержащей описание всех условий реферальной программы для пользователей.

Вознаграждение за регистрацию реферала

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

Выплачивать вознаграждения за

Возможны варианты:

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

Режим заполнения рефералов

Доступны режимы: линейный и пирамида.

Процент вознаграждения

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

Например, указаны такие значения:

Уровень	Процент
1	20
2	15

Пользователь Вася приводит на сайт пользователя Федю. Тогда Федя – Васин реферал 1-го уровня. Затем Федя приводит на сайт Степана, который становится Васиным рефералом 2-го уровня и Фединым рефералом 1-го уровня. Предположим, что Степан пополняет свой баланс на 100 единиц. Тогда Федя получает 20 единиц вознаграждения, а Вася – 15, в соответствии с указанными значениями.

Вернуться к оглавлению

Биллинг: Платежные системы

fuze (fuze@undisclosed.example.com) — 2026-03-04T10:44:09+00:00

Биллинг: Платежные системы

Панель управления ⇒ Компоненты ⇒ Биллинг ⇒ Системы

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

Подключение каждой платежной системы происходит по такой схеме:

Регистрация магазина (сайта) в платежной системе;
Настройка магазина в личном кабинете (мерчанте) платежной системы;
Настройка платежной системы в биллинге.

В разделе «Системы» в панели управления биллингом перечислены все платежные системы, прием средств из которых возможен в данный момент.

Общие настройки платежных систем

Абсолютно все системы в биллинге имеют следующие настройки:

Поле	Описание
Система включена	Опция определяет доступна ли данная система для приема платежей от пользователей
Включено для администраторов	Если включено, то для администраторов система будет отображаться в списке выбора оплаты, даже если выключена. Используйте для отладки.
Название платежной системы	Название системы, которое видит пользователь при выборе способа оплаты (при пополнении баланса)
URL для отправки платежа	Адрес, на который отправляется форма платежа. Не следует изменять без осознанной необходимости
Курс валюты	Курс валюты, в которой работает платежная система, по отношению к реальной валюте сайта. Например, если основная валюта сайта рубли, а система работает с долларами, то в это поле вносится число (1/курс доллара)

Индивидуальные настройки платежных систем

Процесс подключения и настройки каждой платежной системы описан отдельно:

Интеграция другой платежной системы

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

Вернуться к оглавлению раздела Биллинг

Компонент "Рейтинг"

fuze (fuze@undisclosed.example.com) — 2026-02-25T21:52:59+00:00

Компонент "Рейтинг"

Панель управления ⇒ Компоненты ⇒ Рейтинг

Описание

Управляет оценками рейтинга для контента на сайте. Реализует «суммарный» тип рейтинга, когда можно проголосовать только за (+1) или против (-1), а результатом является сумма данных голосов. Также может реализовать «усреднённый» рейтинг на основе «звёздочных» оценок от 1 до 5.

Настройки

Скрывать итоговый рейтинг пока не поставлена оценка

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

Показывать участников голосования и их оценки

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

Разрешить голосование гостям

Если включено, то гости сайта (неавторизованные пользователи) смогут голосовать за записи. Уникальность голосов определяется по ip адресу посетителя.

Разрешить менять оценку

При «суммарном» типе оценок, пользователь повторным кликом сможет убрать свою оценку.

Разрешить менять оценку только в рамках текущей сессии пользователя

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

Отключить отрицательные оценки

При «суммарном» типе оценок будет доступен только лайк (+1).

Шаблон блока рейтинга

Список доступных шаблонов для вывода блока рейтинга. Файл из директории controllers/rating/widget* вашего шаблона, например /templates/modern/controllers/rating/widget.tpl.php. Вы можете создать свой шаблон, имя которого должно начинаться на widget.

Назад к разделу Компоненты