Como crear un componente en Joomla

18 de agosto de 20106 min de lectura
Joomla es uno de los CMS más utilizado en la actualidad, el cual nos permite incluso crearnos nuestros propios componentes para utilizarlos en nuestras aplicaciones.

Antes de crear el componente, hay que saber que Joomla se basa en un Modelo-Vista-Controlador (MVC), y que se puede decir que la aplicación en si es un completo Framework de desarrollo.

Veamos como crear un componente de prueba, uno que nos imprima “Hola Mundo”.

Lo primero que debemos de hacer es crearnos el árbol de directorios y ficheros.



Además de los ficheros index.html en blanco, para prevenir accesos a los directorios, vemos que tenemos 5 ficheros:

  • /site/hello.php – Punto de entrara a nuestro componente
  • /site/controller.php – Fichero que contiene nuestro controlador.
  • /site/views/hello/view.html.php – Clase que extiende JView que se encarga de construir la vista
  • /site/views/hello/tmpl/default.php – Plantilla
  • /hello.xml – Fichero XML que indica a Joomla! cómo instalar el componente.

A continuación creamos el punto de entrada a nuestro componente. Para ello editamos nuestro archivo /site/hello.php .

/**
* @package    Joomla.Tutorials
* @subpackage Components
* components/com_hello/hello.php
* @link http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_2
* @license    GNU/GPL
*/
// No direct access
defined( '_JEXEC' ) or die( 'Restricted access' );
// Require the base controller
require_once( JPATH_COMPONENT.DS.'controller.php' );
// Require specific controller if requested
if ($controller = JRequest::getWord('controller')) {
$path = JPATH_COMPONENT.DS.'controllers'.DS.$controller.'.php';
if (file_exists($path)) {
require_once $path;
} else {
$controller = '';
}
}
// Create the controller
$classname	= 'HelloController'.$controller;
$controller	= new $classname();
// Perform the Request task
$controller->execute( JRequest::getVar( 'task' ) );
// Redirect if set by the controller
$controller->redirect();

Lo que hemos hecho en este código ha sido lo siguiente:

  • En primer lugar comprobamos que estamos ejecutando éste código dentro de Joomla mirando si está definido _JEXEC. En caso contrario, finalizamos la aplicación.
  • Cargamos con require_once nuestro controlador.
  • El siguiente bloque de código comprueba si se necesitan más controladores. Por ahora no es necesario, pero lo mantenemos ahí para un futuro.
  • Después, creamos el controlador. En este caso, siempre se creará un controlador de la clase HelloController(), dado que en este ejemplo, como vimos en el paso anterior, no hay más.
  • Posteriormente indicamos al controlador que lleve a cabo la tarea solicitada. Por defecto, si no hay ninguna, la tarea es ‘display’.
  • Finalmente, pasamos el control al controlador, para que, si fuera necesario, lleve a cabo una redirección.

El siguiente paso es crearnos el controlador. Este lo único que hará será mostrar el mensaje. Para este caso hay que editar el archivo /site/controller.php

/**
* @package    Joomla.Tutorials
* @subpackage Components
* @link http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_1
* @license    GNU/GPL
*/
// No direct access
defined( '_JEXEC' ) or die( 'Restricted access' );
jimport('joomla.application.component.controller');
/**
* Hello World Component Controller
*
* @package    Joomla.Tutorials
* @subpackage Components
*/
class HelloController extends JController
{
/**
* Method to display the view
*
* @access    public
*/
function display()
{
parent::display();
}
}

Como vemos, creamos una clase llamada HelloController que hereda a JController. Tan sólo define el método display(), pues es la tarea por defecto (Salvo que no se especifique otra). Este método tan sólo invoca al método JController::display(), que determina y carga la vista y plantilla a utilizar. En nuestro ejemplo, sólo tenemos una vista y una plantilla.

Lo siguiente es crear la vista, que lo único que hará será cargar los datos y guardarlos para usarlos en la plantilla. Para ello se utiliza el método assignRef(), al que se le pasa como primer argumento el nombre de la variable de la plantilla y el segundo la variable que se comparte. En este caso editamos /site/views/hello/view.html.php

/**
* @package    Joomla.Tutorials
* @subpackage Components
* @link http://docs.joomla.org/Developing_a_Model-View-Controller_Component_-_Part_1
* @license    GNU/GPL
*/
// no direct access
defined( '_JEXEC' ) or die( 'Restricted access' );
jimport( 'joomla.application.component.view');
/**
* HTML View class for the HelloWorld Component
*
* @package    HelloWorld
*/
class HelloViewHello extends JView
{
function display($tpl = null)
{
$greeting = "Hello World!";
$this->assignRef( 'greeting', $greeting );
parent::display($tpl);
}
}

Por último nos queda definir el fichero Manifiest, para poder instalarlo de forma sencilla. Este fichero almacena información como por ejemplo:
  • Descripción del componente.
  • Lista de ficheros que incluye.
  • Un fichero opcional PHP que realizar tareas de instalación.
  • Un fichero opcional SQL que se ejecuta al instalar o desinstalar

<install type="component" version="1.5.0">
<name>Hello</name>
<!-- The following elements are optional and free of formatting constraints -->
<creationdate>2007-02-22</creationdate>
<author>John Doe</author>
<authoremail>[email protected]</authoremail>
<authorurl>http://www.example.org</authorurl>
<copyright>Copyright Info</copyright>
<license>License Info</license>
<!--  The version string is recorded in the components table -->
<version>1.01</version>
<!-- The description is optional and defaults to the name -->
<description>Description of the component ...</description>
<!-- Site Main File Copy Section -->
<!-- Note the folder attribute: This attribute describes the folder
to copy FROM in the package to install therefore files copied
in this section are copied from /site/ in the package -->
<files folder="site">
<filename>controller.php</filename>
<filename>hello.php</filename>
<filename>index.html</filename>
<filename>views/index.html</filename>
<filename>views/hello/index.html</filename>
<filename>views/hello/view.html.php</filename>
<filename>views/hello/tmpl/default.php</filename>
<filename>views/hello/tmpl/index.html</filename>
</files>
<administration>
<!-- Administration Menu Section -->
<menu>Hello World!</menu>
<!-- Administration Main File Copy Section -->
<files folder="admin">
<filename>hello.php</filename>
<filename>index.html</filename>
</files>
</administration>
</install>

Para utilizarlo, una vez realizado todo esto, hay que comprimirlo en un fichero ZIP con el nombre com_hello y ya lo tendríamos listo para instalarlo.

Ahora, para poder ver el resultado, debemos consultar el componente. Para ello, debemos acceder a la siguiente URL:

/index.php?option=com_hello&view=hello

Vemos que no se define ninguna tarea (Recordemos que por defecto se usa Display). En caso de querer ejecutar otra tarea, tendríamos que definir el parámetro GET task, por ejemplo para la tarea ‘save’:

/index.php?option=com_hello&view=hello&task=save

Vía: chusete.es

Sigue leyendo