Creare un modulo tutto nostro usando Smarty

Categoria: Sviluppo moduli
Riassunto: Come costruire un modulo semplicissimo. Una struttura base da utilizzare come modulo di default per personalizzare la pagina prinicipale del sito.

PREMESSA

Eccoci qui con un nuovo tutorial. Stavolta ci occuperemo della costruzione di un semplice modulo. Useremo il motore di template SMARTY.
IMPORTANTE:
per far si che questo tutorial FUNZIONI, bisogna avere già CLONATO il template di default di xoops.
Per fare questo:1 - Andare su Admin->Temi e cliccare su CLONA
2 - Dare un NOME a piacere sul sistema sdi template clocnato
3 - Andare su Admin->Preferences->Settings e selezionare il template set appena creato (cerca la voce Template set di default)

Creazione modulo chiamato home

Costruiremo un modulo denominato "home" e lo useremo come modulo di default.
Vale a dire che gli utenti (anonimi e non), quando si collegheranno, vedranno apparire in home una pagina HTML personalizzata tramite i templates di Smarty.

L'indirizzo del sito sarà quindi

http://www.sitoxoopsato.it/modules/home/

dove home è il nostro modulo.

Per iniziare diamo una sbirciatina alla cartella che conterrà i file del modulo. La struttura interna sarà volutamente MOLTO semplice. Più avanti lo perfezioneremo e lo renderemo più dinamico.

SCOPO DEL MODULO

Il modulo non fa altro che visualizzare una pagina HTML semplicissima, che fa uso dei template di smarty.
Per modificare i contenuti di questa pagina basterà andare nella sezione amministrazione e modificare la pagina a piacimentio
come si fa con qualsiasi altro template di xoops.

=> I contenuti della cartella del modulo home:
=> home
=> -->language
=> -->-->italian
=> -->-->-->index.php) //vuota
=> -->-->-->main.php) //contiene il nome modulo
=> -->-->-->modinfo.php) //Info sul modulo
=> -->templates
=> -->-->-->home.html) //il template vero e proprio
=> header.php) //Include il mainfile.php
=> footer.php) //include il footer.php della root
=> index.php) //Il file principale che include header e footer + il riferimento al template
=> home_logo.gif)
=> xoops_version.php) //dati sul modulo

FASE 1: Il file index.php - Il file principale del modulo

Scrivo per comodità l'intero codice visto che è semplice

<?php
//header.php contiene un semplice rimando al mainfile.php
require('header.php');

// Settaggio del template sempre DOPO il il file di inclusione header.php
$xoopsOption['template_main'] = 'home.html';

// Grafica del sito (intestazione e colonne destra e sinistra)
require(XOOPS_ROOT_PATH.'/header.php');

// Grafica del sito (piè pagina)
require(XOOPS_ROOT_PATH.'/footer.php');
?>

Quattro istruzioni. E la index è ok.
1 - Un'istruzione per agganciarsi al file tuttofare mainfile.php nella root del sito
2 -3 ->Due istruzioni per la grafica
4 - Una istruzione per agganciare il file html che è il template smarty memorizzato nella cartella templates
Questo file contiene l'HTML che verrà visualizzato

FASE 2: home.html - Il template vero e proprio

Un file HTML semplicissimo

<table width="80%" border="1" align="center" cellpadding="0" cellspacing="0">
<tr>
<td>Colonna 1</td>
<td>Colonna 2 </td>
<td>Colonna 3 </td>
</tr>
</table>

Una semplice tabella a tre colonne. HTML PURO. Più avanti vedremo come inserire anche le variabili Smarty. Per ora accontentiamoci di inserire HTML PURO e manipolarlo attraverso il menu di amminsitrazione di xoops.

FASE 3: xoops_version.php

<?php
// Questo elenco di istruzioni è abbastanza intuitivo
$modversion['name'] = _MI_HOME_NAME; //Nome del modulo (usa una costante definita nel file modinfo.php dentro la cartella language/italian)
$modversion['version'] = 1.00; //versione del modulo
$modversion['description'] = _MI_HOME_DESC; //Descrizione del modulo
$modversion['credits'] = 'http://www.odes.it'; // credits
$modversion['author'] = 'dan-tom';//autore
$modversion['help'] = 'help.html'; //Un eventuale file di help che si vuole inglobare per spiegare come funziona il modulo
$modversion['license'] = 'GPL see LICENSE';//tipo di licenza
$modversion['official'] = 0;
$modversion['image'] = 'home_slogo.jpg';//logo
$modversion['dirname'] = 'home';//Nome della directory del modulo

// Admin
$modversion['hasAdmin'] = 0; //il modulo non ha amministrazione (0)
$modversion['adminmenu'] = '';

// Menu
$modversion['hasMain'] = 1;

// Templates
$modversion['templates'][1]['file'] = 'home.html';//Nome del template
$modversion['templates'][1]['description'] = 'Pagina di ingresso';//descrizione
?>

FASE 4: modinfo.php - Nella cartella language/italian

<?php
// $Id: modinfo.php,v 1.5 26/02/2004 23:36:33 dan-tom $
// Informazioni Modulo

//Nome del modulo
define("_MI_HOME_NAME","Home");//Costante inserita nel file xoops_version...ricordate?
// Breve descrizione del modulo //idem
define("_MI_HOME_DESC","Descrizione mio modulo");
?>

FASE 5: main.php - Nella cartella language/italian

<?php
define('_MI_HOME_NAME', 'Home');//anche qui definiamo il nome del modulo
?>

TUTTO QUI
Ora passiamo alla sua installazione

Carichiamo la cartella "home" con dentro i nostri file nella cartella modules del nostro portale
Poi andiamo nel menu amministrazione e installiamo il modulo.

Poi:
1 - Andiamo nella sezione GROUPS e assicuriamoci che gli utenti anonimi e registrati hanno diritto di accesso al modulo
2 - Andiamo nella pagina template. Cloniamo il template principale se non lo abbiamo ancora fatto
3 - Cercate la voce "home" nell'elenco dei template appena clonati e clicciamo su GENERATE alla voce "home". Questo fa si che l'html del template venga caricato nel database
4 - Ora potete accedere al template e modificarlo a piacere cliccando su modifica
5 - Andate nella sezione preferenze e impostate il modulo come modulo di default.

FINE

Da questo momento, non appena puntate l'indirizzo alla index/root del sito, vi apparira la vostra tabella a tre colonne del modulo appena costruito. Se volete che appare solo quella a partire dall'alto, eliminate i blocchi centrali nella sezione blochhi del menu' di amministrazione.

Spero di essere stato chiaro
alla prossima,

dan-tom (d.tomasino@xoopsitalia.org)

Xoops Italia :: Articolo

Creare un modulo tutto nostro usando Smarty

PREMESSA

Creazione modulo chiamato home

SCOPO DEL MODULO