Joomla: aggiungere helpers personalizzati a JHTML

Di seguito riporto alcuni appunti che indicano come aggiungere degli helpers personalizzati alla classe JHTML che potranno essere richiamati con la classica chiamata

JHTML::_( "prefix.file.function", ........ );

Con il parametro riportato sopra “prefix.file.function” si indica l’helper da richiamare specificando il prefisso della classe (opzionale, se non riportato viene assunto il valore JHTML), il nome del file che poi deve anche essere il suffisso della classe, e il metodo della classe da richiamare.

Per esempio, generalmente si utilizza la seguente chiamata

JHTML::_( "grid.publisher", $row, $i );

per generare codice HTML con il quale eseguire il rendering del pulsante di pubblicazione/non pubblicazione.

Nel caso sopra indicato viene in pratica eseguita la chiamata a JHTMLGrid::publisher(). Per eseguire tale chiamata viene composto il nome della classe, nome delle funzione e nome del file da caricare prendendo il primo argomento fornitoro a JHTML::_():

• classe JHTMLGrid: composta dal prefisso JHTML (preso di default perché non specificato) e dal suffisso Grid preso dalla prima parte di grid.published
• funzione published(): presa dalla seconda parte di grid.published
• file grid.php da cui da cui caricare la classe: preso dalla prima parte grid.published

A questo punto capito il meccanismo con cui viene richiamato l’helper possiamo crearne uno nostro. Di seguito riporto come esempio l’helper che ho creato per eseguire un  nuovo tipo di pubblicazione ovvero chiamato publishedHd, che dovrebbe servire per eseguire la pubblicazione/non pubblicazione di un elemento che qui non sto a specificare.

La chiamata viene eseguita nel seguente modo:

JHTML::_( "extendedgrid.publisherHd", $row, $i );

che in pratica richiama JHTMLExtendgrid::publishedHd( $row, $i ) contenuta nel file extendedgrid.php

Di seguito riporto il codice sorgente della classe JHTMLExtendedgrid:

class JHTMLExtendgrid extends JHTMLGrid
{
  function publishedHd( &$row, $i, $imgY = 'tick.png', $imgX = 'publish_x.png', $prefix='' )
  {
    $img    = $row->published_hd ? $imgY : $imgX;
    $task   = $row->published_hd ? 'unpublish_hd' : 'publish_hd';
    $alt    = $row->published_hd ? JText::_( 'Published' ) : JText::_( 'Unpublished' );
    $action = $row->published_hd ? JText::_( 'Unpublish Item' ) : JText::_( 'Publish item' );
 
    $href = '
    <a title="'. $action .'" onclick="return listItemTask(\'cb'. $i .'\',\''. $prefix.$task .'\')" href="javascript:void(0);">
    <img src="images/'. $img .'" border="0" alt="'. $alt .'" /></a>';
 
    return $href;
  }
}

Il precedente sorgente contenuto nel file extendgrid.php è stato salvato nella cartella helpers/html/ nella parte amministrativa del componente sviluppato. Il path di tale directory dovrà essere fornita JHTML per sapere dove andare a cercare i files contenenti gli helpers da caricare e viene fatto con la seguente chiamata che ho inserito nell’entrypoint del componente:

JHTML::addIncludePath( array( JPATH_COMPONENT_ADMINISTRATOR.DS.'helpers'.DS.'html' ) );