Joomla 1.6: creare un modulo (II parte)

Nell'articolo joomla 1.6: creare un modulo (I parte) abbiamo indicato quali sono i file necessari per creare un modulo in Joomla 1.6 e dove devono essere posizionati. In questo secondo articolo vedremo il codice necessario per realizzare il nostro modulo "Ciao mondo".

Punto di entrata del modulo

In mod_ciao_mondo.php si trova l'entry point del modulo ciao_mondo (il nome del file deve essere lo stesso della cartella che lo contiene):

<?php

// impediamo l'accesso diretto alla pagina

defined('_JEXEC') or die;

// richiesta del file helper.php

require_once dirname(__FILE__).'/helper.php';

// chiamata al metodo statico getSaluto presente nell'helper

$saluto = modCiaoMondoHelper::getSaluto($params);

require JModuleHelper::getLayoutPath('mod_ciao_mondo', $params->get('layout', 'default'));

?>

Il codice è molto semplice ed i commenti dovrebbero essere sufficienti per capirne il funzionamento.

Il file helper del modulo

Nel nostro esempio il file helper.php sarà molto semplice:

<?php

// classe del modulo

class modCiaoMondoHelper

{

    // metodo statico

    public static function getSaluto(&$params)

    {

        // valore di ritorno

        return 'Ciao Mondo!';

    }

}

?>

Osserviamo soltanto che il nome della classe è composto da mod + CiaoMondo (nome del modulo senza underscore) + Helper.

Template del Modulo

Il file del template "tmpl/default.php" si limita semplicemente a visualizzare il contenuto della variabile $saluto:

<?php

defined('_JEXEC') or die;

echo $saluto;

?>

Notiamo come la variabile $saluto creata nello script mod_ciao_mondo.php sia automaticamente presente nel template grazie al framework di Joomla.

File xml del modulo

Infine vediamo il file mod_ciao_mondo.xml: esso servirà a Joomla per poter caricare correttamente il modulo:

<extension client="site" method="upgrade" type="module" version="1.6.2">

    <name>Ciao Mondo!</name>

    <author>Paolo Mosca</author>

    <version>1.6.2</version>

    <description>Modulo Ciao Mondo</description>

    <files>

        <filename module="mod_ciao_mondo">mod_ciao_mondo.php</filename>

        <filename>mod_ciao_mondo.xml</filename>

        <filename>index.html</filename>

        <filename>helper.php</filename>

        <filename>tmpl/default.php</filename>

        <filename>tmpl/index.html</filename>

    </files>

</extension>

Per poter utilizzare questo semplice modulo basterà creare uno zip (mod_ciao_mondo.zip) di tutti i file visti nei due tutorial e utilizzare la procedura di installazione di Joomla.