AlphaUserPoints - Come creare un plugin - (base)

La creazione di un plugin (creazione di una nuova regola per un componente di terzi) è divisa in 2 fasi.

Fase 1 - Inserire l'API nel componente
Questo corso mira principalmente agli sviluppatori o a qualsiasi persona con un livello di conoscenza del linguaggio PHP sufficientemente avanzata.

Semplicemente, inserisci la seguente API nel codice del componente nel punto che desideri. L'ideale è seguire una azione che possa portare oggetti all'utente connesso. Per esempio, in qualsiasi componente per lasciare commenti o forum, aggiungi l'API dopo l'inserimento del codice sorgente del commento o del nuovo tema nel database.

API:

$api_AUP = JPATH_SITE.DS.'components'.DS.'com_alphauserpoints'.DS.'helper.php';
if ( file_exists($api_AUP))
{
    require_once ($api_AUP);
    AlphaUserPointsHelper::newspoints( 'function_name' );
}


function_name è la regola che verrà utilizzata per assegnare punti all'utente attuale (se è registrato ed ha effettuato l'accesso).
Per tutte le regole incluse in AlphaUserPoints (sistema), i nomi delle funzioni sono scritti come segue:

esempio: sysplgaup_newregistered per assegnare punti ad un nuovo utente registrato.

Sarebbe opportuno mantenere un nome standrd per i plugin di componenti di terzi come descritto:

plgaup_function_name

Esempio: plgaup_newcomment or plgaup_newtopic per riprendere l'esempio di inclusione dell'API di questo componente in un commento o un forum.
Il nome di una funzione per assegnare punti quando si crea un nuovo argomento pubblicato nel componente Fireboard potrebbe essere, plgaup_newtopic_fb.

Fase 2 - Creazione del file XML
Si dovrebbe poi creare un file .xml per facilitare l'installazione della regola in AlphaUserPoints.
Occorre specificare 4 elementi:

il nome della regola, la sua descrizione, il nome del componente che utilizza la regola (com_example) e il nome della funzione utilizzato dalla regola.

<? xml version = "1.0" encoding = "utf-8"?>
<alphauserpoints type="plugin">
     <rule>nome breve della regola</ rule>
     <description>Descrizione della regola</ description>
     <component>com_esempio_componente (o componente esempio)</ component>
     <plugin_function>plgaup_function_name</ plugin_function>
     <fixed_points>true o false </ fixed_points>
</ alphauserpoints>

Questo file XML deve essere salvato con codifica UTF-8 e poi compresso (.zip).

Note per gli sviluppatori

Potete trovare la documentazione completa per inserire ed utilizzare questa API nei vostri componenti sul sito ufficiale dell'autore:r www.alphaplug.com.