AlphaUserPoints - как создать плагин (правило)? (базовый курс)
| WEB-строительство - Joomla |
Создание дополнения (создание нового правила для компонента) к программе делится на 2 шага.
Шаг 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 (systems), имена функций пишутся как указано ниже:
пример: sysplgaup_newregistered для вознаграждения новому зарегистрированному пользователю.
Это стандарт для трети дополнения компонентов к программе как указано ниже:
plgaup_function_name
Пример: plgaup_newcomment или plgaup_newtopic, чтобы использовать пример включения этого API компонента в комментарии или форуме.
Имя функции, чтобы начислить очки, создавая новую тему, размещенную в компоненте Fireboard, могла быть, например, plgaup_newtopic_fb.
Шаг 2 - Создание XML файла
Необходимо создать файл xml, чтобы облегчить установку правила в AlphaUserPoints.
Нужно указать 5(пять) элементов:
Имя правила, его описание, имя компонента использующего правило (com_example), имя функции используемое по установленным правилам и если фиксированны ли очки (истинна или ложь).
<? xml version = "1.0" encoding = "utf-8"?>
<alphauserpoints type="plugin">
<rule>короткое имя правила</ rule>
<description>Описание правила</ 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.
Оригинал статьи: http://www.utgarda.ru/administrator/components/com_alphauserpoints/help/en-GB/screen.how_create_plugin.html
Перевод: Олег Бугаев (Seth)
