Процесс создания плагина (создания нового правила для других компонентов) состоит из двух фаз.
Шаг 1 - Добавляем API в компонент
Этот курс предназначен впервую очередь для разработчиков или людей с болле продвинутым знанием PHP.
Просто вставьте следующий API в коде компонента, где вы хотите применить правило. В идеале там, где совершается какое-либо действие, которое возвращает данные для подключенного(авторизованного) пользователя.
Например, в компоненте каких-либо комментариев или на форуме, надо добавить API после записи исходного кода комментария или создания новой темы в базу данных.
API:
$api_AUP = JPATH_SITE.DS.'components'.DS.'com_alphauserpoints'.DS.'helper.php';
if ( file_exists($api_AUP))
{
require_once ($api_AUP);
AlphaUserPointsHelper::newpoints( 'function_name' );
}
function_name это имя правила которое будет применяться для начисления или списания баллов текущего пользователя (при условии что он зарегистрирован и авторизован).
Для всех системных правил включенных в AlphaUserPoints, имена функций прописаны следующим образом:
пример: sysplgaup_newregistered для начисления баллов вновь зарегистрированному пользователю.
Необходимо соблюдать стандарт именования для создаваемых плагинов следующим образом:
plgaup_function_name
Например plgaup_newcomment или plgaup_newtopic, продолжая тему примера со вставкой API в комментариях или на форуме.
Имя функции начисления баллов за создание новой темы в компоненте форума Fireboard может быть, к примеру, plgaup_newtopic_fb.
Шаг 2 - Создание XML файла
Теперь необходимо создать файл xml для обеспечения вставки нового правила в список правил AlphaUserPoints.
Вы должны указать 5 элементов:
Имя правила, его описание, название компонента где правило будет применяться (com_example), имя функции применяющейся правилом и тип баллов фксированные (true or false).
<? xml version = "1.0" encoding = "utf-8"?>
<alphauserpoints type="plugin">
<rule>краткое название правила</ rule>
<description>Description of the rule</ description>
<component>com_example_component (or Exemple component)</ component>
<plugin_function>plgaup_function_name</ plugin_function>
<fixed_points>true or false</fixed_points>
</ alphauserpoints>
Файл XML должен иметь кодировку UTF-8 и может быть заархивирован (. Zip).
Примечание для разработчиков
Полную документацию о включении и использовании API в ваших компонентах вы можете найти на официальном сайте автора по адресу: www.alphaplug.com.