Empieza el domingo interesante. Un poco desesperado porque el framework de Joomla no tiene mucha documentación para usarlo independientemente del CMS pero ahí seguiré atento a los cambios, que seguro que algún día se convertirá en un framework de la categoría de Symfony o Codelgniter, por ejemplo. Con 2700 desarrolladores en todo el mundo, más de 6000 extensiones, con un 2,7% de portales en Internet que usan Joomla! ésto promete.
A fecha de hoy leo en los foros de grupos de desarrollo que con la separación de Joomla Platform del desarrollo del CMS se están cambiando los espacios de nombres y añadiendo más y más funcionalidades. Una de éstas últimas es el nuevo método para autocargar clases.
Con un ejemplo se ve bien sencillo:
<?php
// se importa la Plataforma Joomla.
require_once 'libraries/import.php';
// directorio base que se usa para el autocargador de clases
const JPATH_BASE = __DIR__;
// registra un prefijo cualquiera
JLoader::registerPrefix('Jnj', JPATH_BASE);
// crea una instancia de la clase nueva
$app = JApplicationWeb::getInstance("JnjUnDirectorioEjemploWeb");
// se supone que debemos guardar la applicación en el core
JFactory::$application = $app;
// y entonces podemos ejecutarla desde el core
JFactory::getApplication()->execute();
// así queda todo ordenado en el núcleo del framework
Éste podría ser un index.php del directorio principal. Con JLoader se establece un prefijo para las clases, en éste caso, ‘Jnj’. Ahora al cargar la instancia de la clase ‘JnjUnDirectorioEjemploWeb’, la clase se buscará en el directorio ‘/Un/Directorio/Ejemplo/web.php’ y la clase se deberá llamar ‘JnjUnDirectorioEjemploWeb’. Aquí abajo tienen la clase web para ejecutarlo:
<?php
class JnjUnDirectorioEjemploWeb extends JApplicationWeb {
protected function doExecute()
{
$this->setBody("");
$this->appendBody("<h1>Plataforma Joomla! Autocarga de clases con JLoader</h1>");
$this->appendBody("Si estas viendo ésto en el navegador es que está bien la autocarga...");
}
}
Los dos ejemplos y la estructura de directorios se pueden descargar aquí.
Para que funcione debemos tener el framework descomprimido en el mismo directorio raiz de la web, y ejecutarlo desde un navegador, como viene siendo costumbre en éstos minitutoriales.
Ahora eligiendo un prefijo, y organizando las clases del proyecto en directorios podemos ‘autocargar’ todo fácilmente sin tanto import o require. De manera dinámica el framework se encargará de todo.
Ya llegó el calor, terminaron los exámenes de junio y parece que ya llega el verano, aunque hace poco aún estaba lloviendo en la costa mediterránea de España. Yo sigo con lo mío y hoy les traigo un acceso a bases de datos usando SQLite, una base de datos de dominio público, embebida, no necesita instalación y simplemente con que PHP tenga activada la extensión para ello ya podemos usarla.
Como viene siendo costumbre de la serie que escribo, me voy a centrar en el uso en un servidor web, con lo que el ejemplo es una página web. Se puede también ejecutar en línea de comando pero yo no uso PHP de esa forma así que… vamos al grano.
Un entorno de desarrollo. Aquí ya para gustos estan los colores, Eclipse va muy bien y es multiplataforma.
Un servidor para ejecutarlo. XAMPP funciona muy bien y también es multiplataforma.
Empezando
Descomprimo el framework en el directorio si es que no lo tengo ya, entonces hay que crear un fichero .php como en el ejemplo siguiente y veremos rápidamente como funciona:
... <?php
// se importa la Plataforma Joomla. require_once 'libraries/import.php';
class laWeb extends JApplicationWeb { protected function doExecute() { $this->setBody("<html><body>"); $this->appendBody("<h1>Plataforma Joomla! SQLite</h1>");
// vector de configuración de la base de datos // para sqlite sólo hace falta ésto $option = array(); $option['driver'] = 'sqlite'; // tipo de bd //$option['host'] = 'direccionhost.com'; // host //$option['user'] = 'usuario'; // //$option['password'] = 'contraseña'; // $option['database'] = 'bdpruebas.sqlite'; // nombre de la bd //$option['prefix'] = 'pref_'; // prefijo $dbo = JDatabaseDriver::getInstance($option);
// se puede abreviar usando: //$dbo = JDatabaseDriver::getInstance(array('driver' => 'sqlite', 'database' => 'bdpruebas.sqlite'));
// crea una tabla para las pruebas, la borra si existe $dbo->setQuery("DROP TABLE IF EXISTS aleatorios"); $dbo->execute(); $dbo->setQuery('CREATE TABLE IF NOT EXISTS aleatorios (id INTEGER PRIMARY KEY, numero INTEGER)'); $dbo->execute(); $this->appendBody("<p>Creada la base de datos...</p>");
// inserta unos datos en la BD for ($i = 0; $i < 10; $i++) { $dbo->setQuery('INSERT INTO aleatorios (id, numero) VALUES (' . $i . ', ' . rand(0,99) . ');'); $dbo->execute(); } $this->appendBody("<p>Insertados datos...</p>");
// lee la tabla $this->appendBody("Listando con loadRowList "); $dbo->setQuery("SELECT * FROM aleatorios;"); $resultados = $dbo->loadRowList(); foreach ($resultados as $res){ $this->appendBody( "<p>" . $res[0] . ", " . $res[1] . "</p>"); }
// lee la tabla de otra forma $this->appendBody("Listando con loadAssocList "); $dbo->setQuery("SELECT * FROM aleatorios;"); $resultados = $dbo->loadAssocList(); foreach ($resultados as $res){ $this->appendBody( "<p>" . $res['id'] . ", " . $res['numero'] . "</p>"); }
// lee de nuevo la tabla de otra forma $this->appendBody("Listando con loadObjectList "); $dbo->setQuery("SELECT * FROM aleatorios;"); $resultados = $dbo->loadObjectList(); foreach ($resultados as $res){ $this->appendBody( "<p>" . $res->id . ", " . $res->numero . "</p>"); }
Lo que hace el programa es crear el archivo bdpruebas.sqlite si no existe, es un comportamiento peculiar de SQLite. Si usásemos otra base de datos como PostgreSQL o MySQL podríamos usar las sentencias SQL propias de cada base de datos. El código usa las funciones para cargar tablas de datos loadRowList, loadAssocList y loadObjectList. Ésto nos devuelve un objeto que almacenará los datos de la base de datos en nuestro programa. Hay otras funciones para cuando la consulta devuelve sólo una fila o sólo un dato por ejemplo.
Hasta aquí todo bien, pero entonces ¿porqué usar el framework y no usar directamente PHP como siempre sin framework?
Ahora a partir de las últimas versiones se han añadido más bases de datos aparte de la original MySQL, tenemos PostgreSQL, SQLServer, y se preveen el acceso a muchas otras. Ahora bien, tenemos una capa extra que nos va a independizar totalmente de la base de datos, siempre que no usemos las tradicionales sentencias SQL, como en el ejemplo anterior, y construyamos nuestra aplicación usando ésta herramienta. Puede que en un futuro querramos cambiar de base de datos o hacer posible que dicho cambio sea dinámico según configuración del usuario.
Independizando de la base de datos
La historia está en crear la query usando el framework. Tenemos la clase JDatabaseDriver que es la que nos provee de la conexión a la base de datos. Ahora sí, contruimos la $query usando la clase JDatabaseQuery y entonces obtendremos esa compatibilidad de las consultas, inserciones, actualizaciones y borrados de nuestro programa con varios tipos de bases de datos. He simplificado el ejemplo anterior:
... <?php
// se importa la Plataforma Joomla. require_once 'libraries/import.php';
class laWeb extends JApplicationWeb { protected function doExecute() { $this->setBody("<html><body>"); $this->appendBody("<h1>Plataforma Joomla! Independizando de la base de datos</h1>");
// borrando los datos de la tabla aleatorios // para tenerla limpia $query = $dbo->getQuery(true); $query->delete('aleatorios'); $dbo->setQuery($query); $dbo->execute();
$this->appendBody("<p>Borrados los datos...</p>");
// inserta unos datos en la BD for ($i = 0; $i < 10; $i++) { // crear una nueva consulta $query = $dbo->getQuery(true);
Utilizando la base de datos creada con el primer ejemplo, si guardamos éste segundo en otro fichero .php y lo ejecutamos en el navegador funcionará de forma similar. Ahora, si tenemos la base de datos distinta de SQLite, simplemente con cambiar la línea:
Haciendo la conexión con la base de datos que tengamos, nos aseguramos que el resto de consultas, inserciones, actualizaciones o borrados van a funcionar.
Terminando
Otra vez más, me remito para más información a la documentación oficial:
Hoy les escribo un poco más sobre Joomla y su framework de desarrollo en PHP, la Joomla Platform. Esto es una joya, aunque no se usa mucho de manera independiente al CMS puede ser que pronto se haga. Por lo menos mi opinión es que es un buen framework; simple, rápido y eficaz, una buena alternativa.
Siguiendo con la carnicería, sacando toda la casquería, las tripas y demás de todo lo que es el CMS y el framework. Y nos encontramos con la fábrica de objetos, la clase JFactory.
La fábrica de objetos se usa constantemente en el CMS, en el desarrollo de extensiones, y si queremos desarrollar un sitio web a partir del framework podemos usarla y de esta manera tendremos todo el proyecto mejor estructurado.
Con ésto pequeño ejemplo se puede ver una forma muy simple de usar el framework:
... <?php
// se importa la Plataforma Joomla. require_once 'libraries/import.php';
// en éste ejemplo tan simple la clase la pongo aquí pero // se debería poner en otro fichero class laWeb extends JApplicationWeb { protected function doExecute() { $this->setBody("<html><body>"); $this->appendBody("<h1>Plataforma Joomla! probando la fábrica</h1>");
// declara una variable que es un objeto para trabajar con emails $emiliator = JFactory::getMailer(); $this->appendBody("<p>Versión de MAILER de la plataforma: " . $emiliator->Version);
$this->appendBody("</body></html>");
} }
// instancio un objeto de la aplicación web $app = JApplicationWeb::getInstance("laWeb");
// guardo la aplicación en el core JFactory::$application = $app;
// uso la aplicación web que guardé directamente desde el core JFactory::getApplication()->execute(); ...
JFactory es un objeto, que sirve para acceder al núcleo del framework, es decir, nos va a dar acceso a todo tipo de objetos que, al instanciarlos en nuestro programa, podremos usarlos y ahorrarnos el desarrollo de éstos.
Explicaciones
En el ejemplo he usado la función getMailer() para tener acceso al objeto de tipo JMail que tenemos en el framework. Es una interfaz con la que podremos construir en un email con destinatario, asunto, mensaje, etcétera… y configurando los parámetros del servidor de email podríamos enviar.
Hay muchos otros objetos, para hacernos una idea general, la fábrica de Joomla nos proporciona las siguientes funciones con las que acceder a éstos:
getACL: para manejo de autorizaciones.
getApplication: almacena la aplicación.
getCache: la caché.
getConfig: las configuraciones del sitio.
getDate: para manejo de fechas.
getDbo: manejo de bases de datos.
getDocument: manejo de documentos de varios tipos.
getEditor: el editor.
getFeedParser: te da un XML ya parseado.
getLanguage: el lenguaje.
getMailer: el mailer del ejemplo.
getSession: manejo de sesiones.
getStream: manejo de esos objetos tan útiles a veces, los streams.
getURI: para URIs.
getUser: el usuario.
getXML: para manajar ficheros XML.
Me remito a la documentación oficial, como siendo costumbre para más información sobre cada función: http://api.joomla.org/
Podemos ver la implementación completa de la JFactory en el archivo /libraries/joomla/factory.php
Me siento friki de nuevo, otros leen, juegan a videojuegos… cuando tienen tiempo. Yo me complico la vida tratando de averiguar cómo los desarrolladores de Joomla, han hecho el CMS y su framework, me saltan chispas y estoy hechando humo, pero lo he disfrutado.. ¿éso es de friki no? xD Espero haber dado algo de luz sobre la JFactory.
Para cualquier mensaje, aquí abajo lo pueden dejar.
Continuando con la serie de minitutoriales sobre la Plataforma Joomla, en éste post voy a empezar a despellejar y destripar poco a poco ésta joya de la informática. A fecha de hoy Joomla es el CMS más utilizado en todo el mundo y hay una comunidad muy grande que lo mantiene.
Si vamos a usar un framework PHP, nos vamos a asegurar de que la aplicación va a seguir una estructura, un orden a la hora de programar. Cada archivo, módulo, subprograma, función… va a ser claro de su padre y de su madre. Pero si usamos un framework, cualquiera que lo conozca podrá colaborar en el proyecto más pronto que tarde, porque será más legible, tendrá menos líneas de código probablemente que si lo hubieramos desarrollado desde cero. Todo ésto porque nos ahorraremos unas cuantas líneas de código.
Así que veamos pues cómo lo han hecho…
Materiales
Simplemente 3 cosas para seguir éste minitutorial:
Un servidor web con PHP como XAMPP, disponible para varios Sistemas Operativos, o el Uniform Server portable y para Windows.
Nuestro editor o entorno de desarrollo preferido. Como por ejemplo Eclipse, Notepad++, etc…
Supongo que nos manejamos bien en PHP y con nuestro editor de código fuente, y tambien sabemos poner en marcha un servidor servidor local para nuestras pruebas. Además doy por entendido que conocemos el CMS de Joomla! lo sabemos instalar y más o menos llevamos un nivel adecuado de su manejo. Si no es así recomiendo no seguir y mirar antes éstas cosas.
Usaré para muchos de los ejemplos la clase JApplicationWeb para usar el framework, por si acaso comento que no es necesario, pero para ejecutar con un servidor web y ver en un navegador los resultados hace falta.
Antes de seguir descomprimimos el fichero de la Plataforma Joomla en el directorio donde vamos a hacer las pruebas y configuramos el servidor para acceder a él. Si queremos probar el CMS lo que ponemos en el directorio es el paquete Joomla para instalarlo., que también trae incluido una versión de la Plataforma.
JConfig y el fichero de configuraciones
En el CMS de Joomla! el fichero de configuracion de la web es /configuration.php. Cuando descomprimimos una instalación nueva, y visualizamos el nuevo Joomla! lo que vamos a ver el módulo o subprograma contenido en el directorio de instalación /installation. Dicho directorio está destinado a configurar la nueva instalación de Joomla! con una serie de formularios que nos guian paso a paso para poner todas las configuraciones, además de crear las tablas en la base de datos e introducir los datos necesarios para comenzar a usarlo.
Después de la instalación se debe de borrar el directorio /installation y se habrá creado dicho fichero /configuration.php. Simplemente tiene la clase JConfig que es un conjunto de variables. En el framework nos viene un ejemplo en /libraries/config.example.php como el siguiente:
<?php class JConfigExample { public $dbtype = 'mysql'; public $host = 'localhost'; public $user = ''; public $password = ''; public $db = ''; public $dbprefix = 'jos_'; public $ftp_host = '127.0.0.1'; public $ftp_port = '21'; public $ftp_user = ''; public $ftp_pass = ''; public $ftp_root = ''; public $ftp_enable = 0; public $tmp_path = '/tmp'; public $log_path = '/var/logs'; public $mailer = 'mail'; public $mailfrom = 'admin@localhost.home'; public $fromname = ''; public $sendmail = '/usr/sbin/sendmail'; public $smtpauth = '0'; public $smtpsecure = 'none'; public $smtpport = '25'; public $smtpuser = ''; public $smtppass = ''; public $smtphost = 'localhost'; public $debug = 0; public $caching = '0'; public $cachetime = '900'; public $language = 'en-GB'; public $secret = null; public $editor = 'none'; public $offset = 0; public $lifetime = 15; }
El ejemplo nos indica una forma de tener ordenadas las principales variables… En el siguiente ejemplo, he requerido el archivo de configuración de ejemplo que nos proporciona el framework para verlo como usaríamos uno nuestro:
class laWeb extends JApplicationWeb { protected function doExecute() { $this->setBody("<html><body>");
$this->appendBody("<h1>Configuración de ejemplo</h1>");
// crea el objeto con las configuraciones $conf = new JConfigExample();
// lista dicho objeto foreach($conf as $nombre=>$valor) $this->appendBody("<p><b>" . $nombre . "</b>: " . $valor . "</p>");
$this->appendBody("</body></html>");
} }
JApplicationWeb::getInstance("laWeb")->execute();
En el punto de entrada seguro a Joomla, lo que se suele hacer es definir una variable, que en partes del CMS se busca y si no está declarada entonces termina la ejecución. Ésto se hace para evitar accesos directos por URL a ciertos archivos. Ésto es otro tema pero es de uso aconsejable.
La historia está en crear el objeto $conf declarado como un objeto de tipo JConfigExample, entonces en cualquier parte de nuestro programa podemos consultar los datos de configuración guardados en dicha variable $conf. En la práctica el CMS usa un objeto de tipo JConfig y se almacena para su uso posterior.
JPlatform, datos de la plataforma
Ésto es una clase destinada a guardar la información sobre la plataforma, versión del framework, nombre en clave y otros datos. Poniendo JPlatform::VARIABLE, podemos acceder a esos datos como en el ejemplo siguiente:
Además de lo de aquí arriba también tenemos la funcióngetShortVersion y isCompatible que devuelven una versión corta de la versión del framework que estemos usando y para comprobar si es compatible. isCompatible se usa para el CMS, para saber si es compatible el framework y el CMS.
¿Debo usar un CMS para montar una web? ¿O más bien debo programar desde cero? La gran pregunta a la hora de hacer una web. Leo en algunos sitios que no hay que «reinventar la rueda», que ya tenemos disponibles unos CMS (gestores de contenido), que los ponemos online con un bonito diseño, rellenamos el contenido y ya tenemos lista una web. Pero ¿qué pasa a la larga con esa web si nos piden algo extraño?
Por otro lado podemos empezar desde cero, pero al final llegaremos tarde o temprano a usar herramientas que nos ahorrarán código como por ejemplo para enviar emails, generar PDFs o lo que sea que necesitemos. Al final podemos llegar a reunir tal conjunto de utilidades creando nuestro propio framework. Pudiera ser el caso de que disponemos de mucho tiempo, y llegásemos a desarrollar algunas de éstas utilidades nosotros mismos. Pero al final acabaríamos creando un CMS propio, con lo que estamos en el mismo punto en el que ya está Joomla! entonces pues lanzo la pregunta, ¿porqué no aprender y usar ya Joomla! y la Joomla!Platform?
Joomla y su Platform tienen detrás una gran comunidad que los mantiene. Algo bastante importante a tener en cuenta a la hora de elegir un framework. Casi toda la documentación que vengo encontrando está en inglés, así que manos a la obra me pongo a hacer mi versión en castellano, y la dejo aquí para el que le sea útil.
¿Hacia dónde va la Joomla!Platform?
Desde el 5 de Julio del 2011, el Joomla Framework se ha dividido del proyecto Joomla!, inagurando con su versión 11.1 de manera que ahora se llama Joomla!Platform y da pie a que su futuro no dependa directamente del desarrollo del CMS. Ya no sólo se va a usar para desarrollar el Joomla! Dará soporte al desarrollo del CMS pero también puede proporcionar utilidades que tal vez no se usen directamente en Joomla!.
Básicamente se trata de un conjunto de utilidades o librerías de programación, que podemos usar a la hora de crear un sitio. Se puede desarrollar una web completa, desde cero, pero dando saltos de gigante cada vez que uses las librerías del framework.
Materiales
Como mínimo necesitamos lo siguiente:
Archivo comprimido con el J!Platform. Hacemos click en el botón que pone Download y nos los descargamos donde vayamos a construir nuestro sitio de pruebas.
Un servidor de páginas web: Xampp para varias plataformas o Uniform Server para Windows, portable y sin instalador.
Un entorno de desarrollo, Eclipse, Notepad++, o cualquier otro para PHP o edición de webs.
Supongo que nos manejamos bien con PHP, sabemos usar el editor que tengamos instalado y sabemos lo que es un servidor de páginas web, configurarlo y poner en marcha un sitio local para hacer nuestras pruebas. En un post anterior sobre montar un servidor propio con Joomla! y Uniform Server expliqué todo ésto para Windows, así que me remito a él para más información. Si estás en Linux o Mac, las ideas principales son las mismas, cambiarás el editor y el servidor web pero el J!Platform es el mismo y su uso será igual.
Primera aplicación Hola Mundo
Al descomprimir el fichero del framework veremos que tenemos los siguientes directorio:
build/ Contiene información relevante para crear informes de la plataforma, puede haber procesos que guarden datos en éste directorio.
docs/ Documentación.
libraries/ Todas las libreriras PHP de la plataforma.
media/ Archivos que se usan en la parte cliente de la plataforma, es decir, se usan en el navegador del visitante.
tests/ Tests unitarios.
…y otros archivos sobre la plataforma.
PHP se puede usar en línea de comandos con la salida estandar o en una web que viene a ser el caso más usual. Me voy a centrar pues en su uso en web.
Entonces creamos un fichero en el directorio principal de nuesta web, habiendo descomprimido el framework en dicho directorio tambien. Una primera aplicación podría ser creando un fichero con extensión .php como el siguiente:
<?php
// punto de entrada seguro a la Joomla! Platform
//define('_JEXEC', 1);
require "libraries/import.php";
// la clase que va a implementar el sitio web
class HolaMundo extends JApplicationWeb
{
protected function doExecute()
{
$this->setBody("<!DOCTYPE html>
<html>
<head>
<title>Título de la página</title>
</head>
<body>
<h1>Hola Mundo!</h1>
</body>
</html>");
}
}
// crea el objeto si no se ha creado antes
$app = JApplicationWeb::getInstance('HolaMundo');
// ejecuta y muestra por la salida la página
$app->execute();
Puedes descargar aquí el código. Y usarlo en tu servidor web para ver el funcionamiento. Al ejecutar en el navegador ésta pequeña aplicación debemos ver algo tal que así:
Hola Mundo!
Se puede ver que simplemente descomprimiendo el fichero e importando las librerias con el require ya podemos usar J!Platform en nuestra aplicación.
Tenemos de todo, para enviar emails, manejar bases de datos, manejo de sesiones, las galletas, para manejar ficheros, etcétera… no tenemos más que crear objetos de las clases proporcionadas y a usarlos en nuestras aplicaciones.
Más información
Para más información hay muchas páginas de Internet que hablan de todo ésto, pero recomiendo además de las anteriores: