Sviluppo estensioni con Joomla – Capitolo 10

Continuiamo ad approfondire il libro “Learning Joomla 1.5 Extension Development“, di Joseph Le Blanc, che nel capitolo 10 ci introduce all’utilizzo di parametri di configurazione per le nostre estensioni.

Colonna parametri

Quando registriamo la nostra estensione in Joomla, viene creata una colonna params con i settaggi di configurazione dell’estensione stessa. Ad esempio, un nostro modulo potrebbe avere diverse varianti di visualizzazione: tra i parametri salveremmo quella specifica da usare.

File XML

Per moduli e plugins, per dare direttamente all’utente finale la possibilità di impostare i parametri dal backend di Joomla, anzichè doverli modificare direttamente dal database, si usa un file XML associato alla nostra estensione. Tale file XML definisce il tipo di parametri a disposizione, oltre a varie altre proprietà dell’estensione.

Il file XML si chiama come l’estensione a cui è associato, e si colloca nella stessa cartella. Ad esempio, il modulo mod_reviews.php userà un file mod_reviews.xml per definire i propri parametri.

Formato dei parametri

Il file contiene non solo il nome dei parametri ma anche il loro tipo. Questo determina anche il modo in cui verranno visualizzati nella pagina di modifica del modulo o plugin; i campi di modifica vengono infatti creati automaticamente.

Ad esempio text corrisponde a una normale casella di testo, textarea è simile all’equivalente elemento HTML, radio a una serie di opzioni selezionabili (dovremo inserire nel file XML anche i possibili valori).

E’ possibile anche indicare come parametro una lista di oggetti di sistema, quali sezioni, categorie, menu, voci di menu, linguaggi, e così via. Il sistema mostrerà automaticamente la lista degli oggetti del tipo specificato.

Uso dei parametri

I parametri possono essere richiamati all’interno del codice tramite apposite funzioni, del tipo

$layout = $params->get('layout','normal')

Il secondo valore è quello da usare come default nel caso il parametro in questione non sia stato definito.

Componenti

Nel caso dei componenti, i parametri possono essere salvati “per vista” e quindi il file XML con la definizione dei parametri è collocato nella cartella della specifica vista. Nel libro viene indicato ad esempio un file:

/components/com_restaurants/view/list/tmpl/default.xml

Nel caso si vogliano invece definire parametri che si applicano all’intero componente, creare un file config.xml nella cartella amministrativa del componente:

/administrator/components/com_restaurants/config.xml

Per gestire i parametri sarà necessario aggiungere un pulsante alla toolbar di amministrazione:

JToolBarHelper::preferences('com_restaurants')