Cotonti / Open Source PHP Content Management FrameworkContent Management Framework

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

Документация / Администрирование / Установка плагинов

Описание процесса установки плагина на сайт на примере ветки Genoa

#1. Введение

Что такое Расширение
По сути — это PHP-скрипт (или их набор), включаемый в заранее определенные области ядра Cotonti, реализующий дополнительную функциональность.

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

Готовые плагины смотрите в разделе «Расширения».

 

#2. О Расширениях для Cotonti

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

На заметку: по историческим причинам в Cotonti существует 2 типа Расширений (Модули и Плагины). Разница между ними, с точки зрения конечного кользователя или Администратора, не значительная. Поэтому в рамках этой статьи мы не будем вдаваться в подробности их различий и опишем общие принципы установки и настройки.

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

#3. Установка Расширения

#3.1. Загрузка на сервер

В качестве примера попытаемся установить плагин User’s pages. Скачайте его на свой ПК, распакуйте архив. В распакованном архиве будет лежать папка, которая и является плагином. Иногда в этой папке можно найти инструкции от разработчиков по установке плагина или документы лицензионного соглашения.

На заметку: пожалуй самая не однозначная для новичка часть в процекссе установки Расширения это определить тип Расширения (Модуль это или Плагин), т.к. в зависимости от типа необходимо разместить код Расширения в соответствующей типу системной папке — Modules или  Plugins.

На заметку: имена некоторых системных папок могут быть изменены Администратором на этапе установки системы (CMF). Для подробностей смотри файл настроек config.php и его описание.

Папку (userpages) необходимо скопировать на сайт в каталог /plugins/. Сделать это можно посредством любого FTP-клиента.

Рис. 1. Загрузка плагина в каталог /plugins/ с помощью FTP-клиента Total Commander.

#3.2. Установка через админ-панель

Зайдите на сайт в раздел Админка → Расширения и найдите вновь загруженный файл в списке расширений (рис. 2).


Рис. 2. Список плагинов в админ-панели сайта.

Имя папки плагина одновременно является и кодовым именем (slugплагина. Поэтому, для более точной идентификации, осуществлять поиск лучше по коду (кодовому имени) плагина (в нашем случае — userpages).

 

#3.3. Настройка Расширения

После завершения процесса установки плагина (для этого нажмите кнопку «Установить») вы увидите страницу описания плагина.

Наиболее интересные нам области выделены рамкой (рис. 3).



Рис. 3. Страница детального описания плагина.

 

#3.4. Конфигурация

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

#3.5. Части и хуки плагина

Данный плагин состоит только из одной части, вызываемой по хуку users.details.tags.ajax (это как раз и есть тот самый хук, о которым мы говорили выше).

Подробнее о «Хуках» читайте в отдельной статье.

#4. Установка права доступа

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


Рис. 4. Настройка прав доступа.


Виды прав:

  • Read — разрешение на просмотр плагина. Если снять галочку с этого разрешения, данная группа пользователей не будет иметь доступ к плагину.
  • Write — разрешение на редактирования каких-либо данных (зависит от конкретно взятого плагина).
  • Admin — полный контроль над плагином.

Более подробно с темой прав пользователей и их настройкой можно ознакомится в статьях: «Пользователи и Группы», « Управление правами в Cotonti»

#5. Добавление TPL-тегов в шаблоны

Т. к. User’s pages является интегрируемым плагином, для его работы мы должны разместить в шаблоне сайта определенные TPL-теги, выводящие результат работы плагина. В нижней части страницы описания плагина (рис. 3) находится перечень TPL-тегов плагина. Данные теги необходимо (в нашем случае) разместить в любом удобном для вас месте шаблона users.details.tpl (он располагается в директории /themes/имя_шаблона_сайта/).

На этом установку и настройку можно считать завершенной.

Более подробно о Шаблонах и Тегах читайте, например, тут и тут.

#6. Прекращение работы плагина

Существует два способа прекратить работу плагина:

  1. Приостановить все («pause all») — работа плагина будет остановлена, но все конфигурационные данные и данные в БД (если такие есть) будут сохранены.
     
  2. Удалить («uninstall») — работа плагина будет полностью остановлена, в т. ч. удалены все конфигурационные данные и информация из БД (при наличии таковой), но физически (из файловой системы) плагин удален не будет.

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

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



1. Trustmaster  31.07.2009 03:12

Thanks: 0

Nice article, thanks a lot!
2. tensh  31.07.2009 03:20

Thanks: 0

No problem ^^ My pleasure!
3. musiconly  31.07.2009 03:34

Thanks: 0

great job tensh!

Всего: 3, на странице: 3

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