Центр документации
Карта сайта


Новая документация

Настройка платежных систем
Настройка способа оплаты КупиВкредит
Настройка способа оплаты Acquiro
Настройка способа оплаты AvisoSMS

Обновленная документация 

Разработчикам (API)
Руководство пользователя

Установка плагина

Для установки плагина необходимо:

  1. Скопировать дистрибутив плагина в папку дистрибутивов;
  2. Обновить информацию о плагинах в панели управления в модуле управления плагинами;
  3. Произвести установку плагина;
  4. Произвести конфигурирование плагина (если необходимо).

Размещение дистрибутива

Дистрибутив плагинов располагается в папке

_local/plugins_distr

относительно домашней директории сайта.

Состав дистрибутива:

Название папки

Название файла

Описание

Св-ва

Комментарий

 

config.php

Файл описания для установки плагина

*

Файл содержит информацию для установки плагина

 

readme.txt

Файл общей информации о плагине

1)

 

code

 

Папка исполняемых файлов

 

 

 

my_admin.php

Файл модуля управления плагином

2), 3)

Исполняемый файл

 

my_specblock.php

Файл специального блока

2), 3)

Исполняемый файл

 

my_config.php

Файл конфигурации плагина

*, 2)

Исполняемый файл

 

readme.txt

Файл общей информации об исполняемых файлах плагина

1)

 

i18n

 

Папка языковых файлов

 

Папка содержит подпапки с аббревиатурами языков

i18n/ru

 

Папка, содержащая русский языковой файл

 

В качестве языка используется стандартная 2-буквенная аббревиатура

 

index.lng

 

*

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

Img

 

Папка изображений

 

 

 

icon.gif

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

 

Иконка должна присутствовать, если плагин имеет модуль управления

templates

 

Папка шаблонов

 

 

 

admin.tpl

Шаблон интерфейса администратора

4)

 

 

admin.lng

Языковой файл для шаблона интерфейса администратора

4)

 

 

front.tpl

Шаблон спецблока

4)

 

 

front.lng

Языковой файл для шаблона спецблока

4)

 

update

 

Папка обновлений (зарезервировано)

 

 

database

 

Папка, содержащая SQL скрипты, запускаемые во время (де)инсталляции плагина.

 

 

 

install.sql

SQL скрипт запускаемый во время инсталляции плагина.

2)

 

 

uninstall.sql

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

2)

 

* - обязательный файл

1) - рекомендуемое название файла
2) - названия файлов не являются строго фиксированными, они задаются в файле информации для установки плагина
3) - как минимум, один из двух файлов (модуля управления плагина или специального блока) должен присутствовать
4) - наличие и примеры использования этих файлов обусловлено кодом плагина «sample».

Обновление информации о плагинах

Обновление информации о плагинах происходит:

  1. Автоматически при входе в модуль плагинов
  2. При нажатии кнопки «Обновить информацию о плагинах» в модуле управления плагинами

При этом происходят следующие действия:

  1. Для установленных плагинов информация не изменяется
  2. Из списка удаляются плагины, для которых отсутствует дистрибутив, т.е. установка которых невозможна
  3. В список добавляются новые плагины, найденные в дистрибутивах
  4. В списке обновляется информация о плагинах, у которых изменилась версия (подробнее о версиях – в разделе «Файл информации для установки плагинов»)
  5. Остальные плагины, то есть те, у которых не изменилась версия, не изменяются

Установка плагина

Для установки необходимо вызвать на редактирование не установленный плагин или нажать иконку «установить» в списке плагинов. На появившейся форме установки (рис) необходимо:

  1. Задать названия модуля для присутствующих языков
  2. Выбрать модуль для установки плагина

Если модуль для установки плагина имеет вид «Раздел::Название», то плагин будет являться модулем. Если модуль имеет вид «Раздел::Модуль::Название», то плагин будет являться подмодулем указанного модуля.

В процессе установки плагина, отображаются режимы работы плагина. Существуют 2 режима:

  1. Модуль управления
  2. Спецблок

Если плагин имеет режим работы «Модуль управления», то он будет отображаться в панели управления. Если он имеет режим работы «Спецблок», то будет доступен специальный блок плагина.

Конфигурирование плагина

Все плагины имеют список общих настроек:

  1. Время жизни данных в кэше – время, на которое встроенный кэш системы будет кэшировать результат работы плагина без запуска ее кода
  2. Файл специального блока – файл кода специального блока

Подробнее о размещении файлов плагина – в разделе «Разработка плагинов».

Версия для печати

Установка и настройка Руководство пользователя Интеграция дизайна Разработчикам (API) Документация для скачивания
 2000 – 2011 © Amiro.CMS Все права защищены.