Come creare un modulo per Joomla 3

Per questo articolo sono disponibili Download mod_hello.zip

I moduli sono delle estensioni per Joomla, normalmente non sono complessi da sviluppare e permettono di aggiungere delle piccole funzionalità a componenti già esistenti.

In questa guida spiego come programmare un modulo molto base per Joomla 3, facciamo il classico “Hello World!” .

Struttura file di un modulo Joomla

mod_helloworld.php : questo è il file principale del modulo,  fa un richiamo (require) del file helper, può contenere le varie routine ed include il template per renderizzare il layout del modulo stesso.

mod_helloworld.xml : in questo file sono contenute tutte le informazioni per l’installazione del modulo all’interno di Joomla.

helper.php – qui invece ci sono le classi che vengono utilizzate per mostrare le informazioni a video, di solito la sorgente dati è il database oppure anche altro, per esempio un richiamo ad un file esterno a Joomla.

tmpl/default.php – questo è il file del template (la view), riceve i dati dal file mod_helloworld.php generando codice HTML che verrà mostrato poi a video nelle varie pagine di Joomla.

Creazione del file mod_helloworld.php

Per convenzione la nomenclatura dei file dei modulo ha prefisso mod_nome_del_modulo

In buona sostanza in questo file succede :

  1. includiamo il file helper.php che contiene la classe
  2. richiamiamo la classe helper per ricevere i dati
  3. includiamo il percorso del template per creare il layout del modulo

La riga sottostante ce la porteremo dietro praticamente sempre ed ha l’utilità di verificare che il file venga richiamato direttamente dall’applicativo Joomla e non dall’esterno, questo previene attacchi alla sicurezza del sito stesso. Questa porzione di codice deve essere sempre inserita prima della scrittura di qualunque altra istruzione, classe, ecc..

Struttura del file helper.php di un modulo Joomla

Il file helper contiene la classe che riceve i dati che poi visualizzerà nella view del modulo, in questo caso utilizziamo il metodo getHello() , il metodo restituirà a video un messaggio che nel nostro caso sarà “Hello World!”

Contenuto del file default.php per il template di un modulo Joomla

In realtà i layout del modulo possono essere più di uno ed avere quindi nomenclature differenti, l’importante è che il primo template sia nominato “default.php” .

In questa parte di codice stiamo mostrando a video (echo) il contenuto della variabile hello ($hello) che abbiamo dichiarato nel file mod_helloworld.php ed elaborato in helper.php .

Ricordate che la variabile $hello è già stata dichiarata in precedenza nel file mod_helloworld.php quindi non è necessario valorizzarla nuovamente.

Come creare un file xml manifest per installare un modulo Joomla

Bene abbiamo quasi finito, ora non ci resta che creare il file mod_helloworld.xml, altrimenti detto file manifest che conterrà le informazioni di installazione.

Se state leggendo questo articolo do per scontato che sappiate l’utilità di avere il file index.html contenente solo una riga di codice

Va inserito nella cartella principale del modulo (mod_helloworld) e nella cartella tmpl.

Fatto ciò possiamo creare un file .zip in modo che il modulo sia installabile direttamente con l’installer di Joomla.

La struttua dei file è la seguente

struttura cartelle e file modulo joomla

Buon lavoro e alla prossima 🙂

Commenta l'articolo

Bisogno di postare codice ? Usa un servizio gratuito come Codeshare altrimenti WordPress formatta male il codice!

Pin It on Pinterest

Condividi l'articolo. Grazie.

Vuoi essere aggiornato ?