PROGRAMMARE JOOMLA GUIDA PRATICA. ( Testato per versioni dalla 1.7 alla 2.5 )

Transcript

1 PROGRAMMARE JOOMLA GUIDA PRATICA ( Testato per versioni dalla 1.7 alla 2.5 )

2 Programmare JOOMLA guida pratica Ad ELISA... l angelo in cielo E a mia moglie.. angelo in terra Pag. 2 Autore: Gianpiero Fasulo

3 COPYRIGHT Tutti i diritti riservati. Nessuna parte di questo libro può essere riprodotta, memorizzata in un sistema di recupero, o trasmessa in qualsiasi forma o con qualsiasi mezzo, senza la previa autorizzazione scritta della editore, eccetto nel caso di brevi citazioni incorporate in articoli di critica o recensioni. Ogni sforzo è stato fatto per la preparazione di questo libro per assicurare l'accuratezza delle informazioni presentate. Tuttavia, le informazioni contenute in questo libro viene venduto senza garanzia, espressa o implicita. Né l'autore, né i suoi concessionari e distributori saranno ritenuti responsabili per eventuali danni causati o presumibilmente causati, direttamente o indirettamente da questo libro. 3

4 Programmare JOOMLA guida pratica Sommario Breve.. introduzione... 7 LA STRUTTURA DI JOOMLA... 8 LA CARTELLA CLI... 8 I COMPONENTI... 9 CARTELLA IMMAGINI CARTELLA INCLUDE CARTELLA LANGUAGE CARTELLA LIBRARIES CARTELLA LOGS CARTELLA MEDIA CARTELLA MODULES CARTELLA PLUGINS CARTELLA TEMPLATES CARTELLA TMP CARTELLA ADMINISTRATOR CARTELLA ADMINISTRATOR/CACHE CARTELLA ADMINISTRATOR/COMPONENTS CARTELLA ADMINISTRATOR/HELP CARTELLA ADMINISTRATOR/INCLUDES CARTELLA ADMINISTRATOR/LANGUAGE CARTELLA ADMINISTRATOR/MANIFESTS CARTELLA ADMINISTRATOR/MODULES CARTELLA ADMINISTRATOR/TEMPLATES I FILES FILE ADMINISTRATOR/INDEX.PHP FILE DEL TOP LEVEL DI JOOMLA LA PIATTAFORMA JOOMLA PROGRAMMAZIONE WEB E PROGRAMMAZIONE CLIENT (il ciclo di comando Joomla) CONTROLLARE I COMANDI JOOMLA IN PRATICA COME JOOMLA ESEGUE IL CODICE Pag. 4 Autore: Gianpiero Fasulo

5 INSTALLIAMO UN MODULO E ANALIZZIAMOLO COMPRENDERE I PLUGIN TRADURRE UN COMPONENTE IL MANIFEST VISUALIZZARE INFORMAZIONI NEI MODULI CONFIGURARE NEI MODULI DEL BACK END I PARAMETRI GLI STILI FARE L OVERRIDING DEI LAYOUT FUNZIONAMENTO DELL MVC LE SCELTE DEL CONTROLLER IN JOOMLA ANALIZZIAMO LE VIEWS IL MODEL DATA VISUALIZZARE UN SINGOLO RECORD VISUALIZZAZIONE COMPLESSA DI UN RECORD VISUALIZZARE RECORD DA DVERSE TABELLE/DATASET LINCARE TUTTE LE VIEW USIAMO I CSS PER IL LAYOUT DEL COMPONENTE OVERRIDING DELLE VIEWS IL BACKEND VISUALIZZARE I RECORD AGGIUNGERE LA TOOLBAR NEL BACK END GESTIAMO IL BACKEND TRAMITE IL CONTROLLER E IL MODEL PAGINARE I RISULTATI FILTRARE I RECORD

6 Programmare JOOMLA guida pratica AGIUNGERE UNA SEARCH BOX ORDINARE LE COLONNE EDITARE I RECORD NEL BACKEND UTILIZZARE LA CLASSE JFORM LEGERE DATI CON JFORM DIVIDERE IL LAYOUT DEL FORM IN DUE PARTI CON JFORM Gli elementi di JFORMS Aggiungere pannello di controllo al componente Leggere i valori del pannello di configurazione del componente Configurare un pannello di controllo per un modulo Creare i link dei menù per le nostre views Configurare i menù con link individuali alle nostre view Usare MOOTOOLS in JOOMLA Usare MOOTOOL e JQUERY insieme LE BASI DELLA SICUREZZA IN JOOMLA FARE L'OVERRIDE DEL LINGUAGGIO CREIAMO IL NOSTRO PACKAGING Pag. 6 Autore: Gianpiero Fasulo

7 Breve.. introduzione Non sarò prolisso nella introduzione e nemmeno nella spiegazione di ogni paragrafo di questo libro, ho cercato di essere diretto, semplice e chiaro, sono un tecnico e so che chi leggerà questo libro è comunque un tencico e vuole andare subito al dunque, capire, risolvere problemi e mettere in pratica quello che si è letto. Come sta scritto sulla home page del mio sito personale so che richiederebbe una completa rivisitazione... non lo tocco dal 2008, ma si sa, il tempo è danaro e il sito personale viene messo sempre dopo il cliente. Come dicevo, sul mio sito c'è scritto il seguente mio pensiero che da allora non è cambiato anzi si è rafforzato e recita così. A volte e vero, si ha bisogno di far vedere cosa abbiamo realizzato o forse di dimostrarlo a noi stessi o forse il sito ed in questo caso il libro é l occasione per fare un po d ordine in tanto materiale accumulato. Mi sento come tanti che da anni lavorano anche perche ci credono, perche provano ancora quella soddisfazione dentro quando realizzano qualcosa da soli o insieme agli altri, quando, nonostante tutte le batoste e i problemi quotidiani vanno avanti, perché lavorare é bello perché si continua ad imparare e a confrontarsi. Mettere in comune attività, informare, offrire strumenti, far conoscere gli sforzi fatti per raggiungere un fine o uno scopo o la creazione di un software aiuta ad un vero apprendimento attraverso l uso delle nuove tecnologie. Ecco, questo libro riflette quanto appena detto, anche il suo costo lo riflette più che un vero e proprio prezzo lo definirei un contributo per quanto fatto durante le notti di lavoro passate nel ricercare documentazione, sperimentare, testare ed in fine condividere quanto si è appreso. Spero che questo libro sia di aiuto a tutti coloro che vorranno introdursi nel mondo della programmazione JOOMLA! Ma mettiamoci subito al lavoro 7

8 Programmare JOOMLA guida pratica LA STRUTTURA DI JOOMLA Proprio per dare senso a quanto avete appena letto, mettiamoci subito al lavoro e studiamoci in dettaglio come è strutturato JOOMLA dato che ci servirà di base poi per capire come creare il nostro componente. Ecco di seguito uno screen della struttura delle cartelle di una installazione tipica di JOOMLA Vediamo adesso nel dettaglio le principali cartelle di una installazione cosa sono e a cosa servono in JOOMLA. La cartella CLI La cartella cli è stata aggiunta come standard per la memorizzazione dei comandi d'interfaccia di linea applicazioni CLI. Una delle grandi caratteristiche della piattaforma Joomla è la capacità di creare facilmente applicazioni CLI che interagiscono con un sito Joomla. Le applicazioni CLI si adattano bene per funzionare su piattaforme Linux come ad esempio il cron per automatizzare delle operazioni Pag. 8 Autore: Gianpiero Fasulo

9 I COMPONENTI Un componente è normalmente la cosa principale di una determinata pagina e corrisponde di solito a una voce di menù. Quando si seleziona un elemento da un menù, viene caricata la pagina contenente il componente definita da quella voce di menu. Se guardiamo le sottocartelle dei componenti, vediamo ciascuno dei componenti fondamentali di Joomla: com_banners e com_contact e per gli articoli com_content, com_finder (per Smart Search), com_mailto e com_media, com_newsfeeds, com_search, com_users, com_weblinks e com_wrappers. Come avrete probabilmente capito, le cartelle dei componenti iniziano tutte con le lettere com_ seguita dal nome del componente. Questo è un esempio di forti convenzioni di denominazioni di cartelle che vengono utilizzate in tutto Joomla. Se guardiamo le opzioni quando si crea una nuova voce di menu per i componenti di base, possiamo vedere le opzioni mostrate in figura. La maggior parte di questi tipi di elementi di menu corrispondano esattamente a una delle cartelle Joomla. Queste includono i contatti, articoli (che utilizza la cartella com_content), news feed, ricerca, utenti, link, e wrapper 9

10 Programmare JOOMLA guida pratica Ad esempio invece, i componenti, com_banners com_mailto e com_media fanno eccezione e non corrispondono ai tipi di voci di menu. I Banner sono dei componenti ma vengono inseriti in pagine interne ai moduli. Come ad es. quando si fa clic sull icona per inviare una di un articolo a qualcuno, il componente com_mailto viene richiamato. Anche il componente com_media fa eccezione e viene chiamato quando si modifica un articolo del front-end e si preme il pulsante Immagine per caricare il Media Manager. Questi componenti non vengono visualizzati come la cosa principale in una pagina e quindi non inserite nella semplice definizione di un componente. Questo ci porta alla più dettagliata e tecnica definizione di un componente, che è questa: Un componente è un'estensione che ha da compiere qualche azione e che visualizza qualcosa. Ad esempio, quando si fa clic su di un banner, bisogna scrivere nel database per registrare il click per poi magari reindirizzare l utente ad un altro URL. Allo stesso modo, quando si fa clic sull'icona , deve essere visualizzato un modulo ( form ) da compilare e poi inviare il messaggio tramite . Quando si desidera inserire un'immagine in un articolo, si eseguono azioni, come ad esempio il caricamento di un'immagine al server web. In tutti questi casi quindi, abbiamo bisogno di un componente per gestire queste azioni, anche se questi componenti non faranno mai parte del contenuto centrale di una pagina del nostro sito. CARTELLA IMMAGINI La cartella immagini è il luogo ottimale dove i file di immagini possono essere memorizzati. Per esempio, nella distribuzione di base, abbiamo delle sottocartelle chiamate banner e sampledata. Come ci si aspetterebbe, la cartella banner memorizza le immagini di esempio dei banner che sono inclusi nella distribuzione standard di joomla. La cartella sampledata contiene le immagini utilizzate dei dati del campione che è possibile installare (facoltativamente) durante l'installazione di Joomla. Nota sui file Index.html Noterete che ogni sottocartella nella distribuzione Joomla ( ad eccezione di administrator e installation, che contengono file index.php ) contiene un file chiamato index.html. Se si apre questo file con un editor, si vedrà il seguente contenuto: <! DOCTYPE html> <title> </ title> Si tratta di un file HTML con un elemento <html> e un elemento <title> vuoto. Questo file non ha contenuto e quando vengono visualizzati in un browser mostrerà una pagina vuota. Perché in Joomla abbiamo questi file ovunque? La risposta è: per la sicurezza. Se un utente tenta per individuare una cartella, il server web cerca un file chiamato index.php o in mancanza un file indice. html ( index.html ) da caricare. Se non riesce a trovare uno di questi file, il browser mostra un elenco di file e le sottocartelle presenti nella cartella padre ( a meno che il server non sia configurato diversamente ). Potete provare quanto detto, rinominando temporaneamente nella cartella images/ il file index.html in Pag. 10 Autore: Gianpiero Fasulo

11 images/index1.html. Se poi puntate alla URL "<root del sito jommla>/images ", vedrete qualcosa di simile alla Figura sotto. Se si rinomina nuovamente il file index.html, e ripuntate alla stessa URL vedrete solo una pagina vuota. Consentire quindi ad un utente non autorizzato di visualizzare informazioni sui file e le cartelle sul vostro server viene considerato un rischio per la sicurezza dello stesso sito. Qualcuno che voglia hackerare il vostro sito web può utilizzare queste informazioni per cercare un eventuale vulnerabilità del sito o del server intero. Questo quindi è il motivo principale per il quale esiste un file index.html in queste cartelle. Le cartelle installation e administration sono le uniche che non contengono un file index.html. Questo perché contengono un file index.php che funge da punto di ingresso per il processo di installazione di joomla e del back-end amministrativo. In questo caso, il file index.html impedirebbe il caricamento del file index.php. CARTELLA INCLUDE Abbiamo accennato in precedenza che la cartella administator, che controlla il back-end del sito, può essere pensata come un'applicazione del tutto separata dall' front-end del sito. Per questo motivo, quando si inizia una sessione di front-end e back-end, abbiamo bisogno di caricare classi diverse e diverse costanti in memoria. La cartella include contiene i programmi specifici sia per il front-end che per il back-end. Così il toplevel del sito contenente la cartella /include carica i file di cui abbiamo bisogno per ottenere una sessione valida per il front-end, mentre la cartella administrator/includes contiene i file di cui abbiamo bisogno per ottenere una sessione valida per il back-end. La cartella include contiene i file indicati nella tabella sotto: File Azione application.php Crea le classi del sito Joomla 11

12 Programmare JOOMLA guida pratica defines.php Definisce le costanti per i path dei files framework.php Carica delle porzioni di codice usati in diverse parti del sito ( conosciuto anche come la piattaforma ) menu.php Carica l intero menù del sito in memoria pathway.php Carica la classe JPathwaySite, che viene utilizzata nel mod_breadcrumbs che mostra il path del menu attualmente selezionato Router.php Carica la classe JrouterSite ( discussa in seguito ) CARTELLA LANGUAGE Joomla è stato progettato per essere eseguito in modo nativo in uno qualsiasi dei 68 linguaggi. Praticamente tutto il testo viene tradotto in Joomla prima di essere mostrato nel browser. Questo viene fatto per mezzo dei pacchetti di lingua, che installano una serie di file di lingua. La sottocartella language è dove questi pacchetti di lingua vengono installati. Con una installazione standard inglese, troveremo due sottocartelle: en-gb e overrides ( vedremo meglio l utilizzo di tutte e due più avanti nel libro ). La prima cartella contiene tutti i file linguistici necessari per tradurre il frontend del sito in inglese. ( Il GB sta per Gran Bretagna. L'inglese ufficiale di Joomla è l Inglese ). La seconda cartella è relativa a una nuova funzionalità introdotta nella versione 1.6: le override di lingua. L override di lingua consente di modificare il valore di qualsiasi stringa di testo, senza dover sostituire l'intero file della lingua. Si noti che ci sono spesso due file di lingua con diverse estensioni, uno con estensione.sys.ini e uno con estensione.ini I file sys.ini sono letti per prendere il nome e la descrizione delle estensioni, come quelle mostrate nel Module Manager di joomla. I file.ini invece vengono caricati, quando in realtà stiamo lavorando con l'estensione per visualizzare quindi tutte le stringhe di testo utilizzate nella pagina dall estensione appena caricata. CARTELLA LIBRARIES Una libreria software è un insieme di programmi che sono stati progettati per essere riutilizzati in contesti diversi. Una libreria svolge normalmente un compito specifico o un insieme di attività correlate, queste librerie sono memorizzate in sottocartelle della cartella libraries. Nella versione 1.5, Joomla utilizzava 14 librerie. Di queste, 13 erano provenienti da librerie esterne di sviluppatori di terze parti e una era la libreria Joomla. Nella versione 2.5, questo numero è stato ridotto a quattro. Tre librerie esterne che sono: phpmailer, utilizzata per l'invio di ; phputf8, utilizzata per alcune operazioni sul testo UTF- 8 e SimplePie, utilizzata per i feed RSS. La cartella che ci interessa di più della libraries è da come si può intuire la cartella joomla. Questa cartella contiene le classi della piattaforma Joomla. A partire dalla Pag. 12 Autore: Gianpiero Fasulo

13 versione 2.5, abbiamo anche una cartella chiamata cms. Questa cartella contiene la libreria utilizzata per il content management system Joomla (CMS), ma non applicabile al piattaforma quindi al framework. CARTELLA LOGS Questa cartella viene utilizzata per archiviare i file di log generati da Joomla e non solo, vedremo come far generare a Joomla il Log solo per la nostra estensione. Gli eventi vengono registrati sulla base di determinate condizioni. Ad esempio, una condizione di errore viene registrata in un file chiamato error.log. In più, attivando la modalità di debug si otterrà la registrazione di ulteriori eventi utili a comprendere eventuali errori di codice. CARTELLA MEDIA La cartella media contiene i CSS, Javascript, e file di immagine per alcuni dei componenti, moduli, e editor. la sottocartella system contiene, tra le altre cose, la MooTools JavaScript framework, che viene utilizzata in Joomla per la alcune funzionalità JavaScript. 13

14 Programmare JOOMLA guida pratica CARTELLA MODULES La cartella modules contiene una sottocartella per ogni modulo del front-end disponibile. La tabella seguente mostra le sottocartelle sulla sinistra e un elenco dei tipi di modulo che si vedono quando si crea un nuovo modulo in Gestione moduli sulla destra. Ogni tipo di modulo ha una sua sottocartella. La Tabella Moduli mostra i nomi dei moduli che corrispondono al nome delle sottocartelle. Quando si installano delle estensioni dei moduli base, essi vengono aggiunti come sottocartelle alla cartella principale modules e diventano completamente integrati nella vostra applicazione Joomla. Nome sottocartella Tipo modulo/nome Descrizione mod_articles_archive Articoli archiviati Chiamato mod_archive nella versione 1.5 mod_articles_categories Categorie articoli Introdotto dalla versione 1.6 mod_articles_category Categoria articoli Introdotto dalla versione 1.6 sostituisce il vecchio mod_sections mod_articles_latest Ultime notizie Era mod_latestnews nella ver. 1.5 mod_articles_news Articoli news-flash Era mod_newsflash nella ver. 1.5 mod_articles_popular Contenuti più letti Era mod_mostread nella ver. 1.5 mod_banners Banner mod_breadcrumbs Sei qui ( visualizza posizione menù ) mod_custom Modulo HTML custom mod_feed Modulo Feed mod_finder Ricerca smart Introdotto nella versione 2.5 mod_footer Gestisce il footer mod_languages Cambia linguaggio Introdotto dalla versione 1.6 mod_login Gestisce i login mod_menu Gestisce i menù Era mod_mainmenu nella ver. 1.5 mod_random_image Modulo immagini casuali mod_related_items Modulo articoli correlati mod_search Modulo cerca mod_stats Modulo statistiche mod_syndicate mod_users_latest Modulo ultimi utenti Introdotto dalla versione 1.6 Pag. 14 Autore: Gianpiero Fasulo