PHP

Joomla! Platform 1: Configuración y otros datos, JConfig y JPlatform

2013-06-05 - Categorías: PHP
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:
  1. Un servidor web con PHP como XAMPP, disponible para varios Sistemas Operativos, o el Uniform Server portable y para Windows.
  2. Nuestro editor o entorno de desarrollo preferido. Como por ejemplo Eclipse, Notepad++, etc…
  3. El CMS si queremos probarlo lo tenemos en castellano en http:/www.joomlaspanish.org. Y la Joomla! Platform, yo he usado la versión 12.1, que lo tenemos en descarga en http://api.joomla.org/.
Empezando
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:

<?php

// punto de entrada seguro
define('_JEXEC', 1);

require "libraries/import.php";
require "libraries/config.example.php";

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:

<?php
 
define('_JEXEC', 1);
require "libraries/import.php";

class laWeb extends JApplicationWeb {
protected function doExecute()
{
$this->setBody("<html><body>");
$this->appendBody("<h1>Información sobre la Plataforma Joomla!</h1>" .
"<p>Compilación: " . JPlatform:: BUILD . "</p>" .
"<p>Nombre en código: " . JPlatform:: CODE_NAME . "</p>" .
"<p>Copyright: " . JPlatform:: COPYRIGHT . "</p>" .
"<p>Texto del link: " . JPlatform:: LINK_TEXT . "</p>" .
"<p>Mantenimiento: " . JPlatform:: MAINTENANCE . "</p>" .
"<p>Producto: " . JPlatform:: PRODUCT . "</p>" .
"<p>Liberación: " . JPlatform:: RELEASE . "</p>" .
"<p>Fecha de liberación: " . JPlatform:: RELEASE_DATE . "</p>" .
"<p>Tiempo de liberación: " . JPlatform:: RELEASE_TIME . "</p>" .
"<p>Zona de tiempo de liberación: " . JPlatform:: RELEASE_TIME_ZONE . "</p>" .
"<p>Estado: " . JPlatform:: STATUS . "</p>" );

$this->appendBody("<p>Versión larga: " . JPlatform::getLongVersion() . "</p>" );
$this->appendBody("</body></html>");


}
}

JApplicationWeb::getInstance("laWeb")->execute();

Además de lo de aquí arriba también tenemos la función getShortVersion 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.
Terminando
Los dos ejemplos anteriores los tienen en descarga aquí.

Con ésto me despido por hoy.

Saludos.


Joomla! Platform 0: Introducción

2013-05-18 - Categorías: PHP

Joomla sí, Joomla no

¿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:
  1. 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.
  2. Un servidor de páginas web: Xampp para varias plataformas o Uniform Server para Windows, portable y sin instalador.
  3. 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.

Árbol de clases del Framework

Podemos ver el árbol de clases disponibles de la Joomla! Platform en http://api.joomla.org/classtrees_Joomla-Platform.html
Para hacernos una idea de los tipos de utilidades disponibles podemos ver la organización de éstos en la documentación oficial:

 

 

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:
http://www.joomlaspanish.org/ <- Comunidad de Joomleros de habla castellana.
http://www.joomla.org/ <- La web principal de la comunidad Joomla.
http://joomla.github.io/joomla-platform/ <- Manual de la plataforma en Gihub.
http://docs.joomla.org/Portal:Platform <- Documentación oficial.
http://api.joomla.org/ <- Documentación de las API
Espero que haya dado una buena visión general de la Joomla!Platform.
Saludos!

 


Cómo hacer una plantilla para Joomla

2012-10-21 - Categorías: General

Hablando sobre la creación de páginas web con CMSs. Podemos llegar a ver que la cantidad de CMSs que hay para poner en marcha una web sin programar nada de código fuente es muy grande. He visto que los principales vienen siendo WordPress, Drupal y Joomla. Y en orden de gente que los usa, Joomla viene ganando, o por lo menos eso es lo que he leido en varias páginas de habla hispana y a fecha de hoy.

Me decidí a aprender Joomla en un principio, pero acabé probando WordPress y Drupal también. El Joomla para el que va éste post es la versión 2.5 y tal vez sirva también para los de la 1.5 y en futuro. Yo de momento la versión que tengo instalada es la 2.5 y es la que he usado para escribir éste tutorial.

Vamos a comenzar por ver la estructura en líneas generales de Joomla, si vamos al directorio, por los nombres podremos hacernos una idea de que la carpeta templates/ (plantillas en castellano) es la carpeta en cuestión que nos interesa.

administrator/
cache/
cli/
components/
images/
includes/
language/
libraries/
logs/
media/
modules/
plugins/
templates/
tmp/
uploads/
configuration.php
favicon.ico
htaccess.txt
index.php
LICENSE.txt
README.txt
robots.txt
web.config.txt

Dentro de la carpeta tenemos las carpetas correspondientes a todas las plantillas que tenga instaladas nuestro Joomla. Podemos editarlas directaremente de aquí, o a través del administrador de Joomla, actualizamos la página y los cambios se verán.

La plantilla ‘atomic’ es una plantilla básica, sin muchas florituras, para que hagamos a partir de ella, la nuestra propia. Pero mirando los archivos que la componen podemos ver que hay demasiado código fuente si es que estas haciendo tu primera plantilla, así que vamos a crear otra más simple todavía y luego le podrás añadir todo lo que quieras.

La plantilla básica ‘atomic’ que proporciona Joomla tiene la siguiente estructura:

css/      <- aquí van las hojas de estilo
html/    <- páginas html peladas
images/     <- imágenes de la plantilla

js/      <- scripts de javascript

language/     <- archivos para las traducciones
component.php   <- para mostrar el contenido de los componentes
error.php    <- página de error
favicon.ico   <- el icono de la web
index.html    <- el index en html
index.php    <- el index en php
template_preview.png    <- vista previa de la plantilla
template_thumbnail.png    <- imagen pequeña de la vista previa
templateDetails.xml      <- descripción de la plantilla, para uso interno

Hay plantillas muy grandes, con muchos añadidos, pero ésta que suponemos básica vamos a reducirla de la manera siguiente. Sólo necesitamos lo siguiente para nuestra nueva plantilla:

css/      
favicon.ico   
index.php   
template_preview.png  
template_thumbnail.png  
templateDetails.xml    

Todo ésto lo creamos en una carpeta nueva, yo la he llamado mynew/ dentro de la carpeta templates/ 
Y dentro de la carpeta css/ vamos a crear un archivo llamado ‘template.css’ para hacer la presentación mediante CSS. No se recomienda poner la estructura de una página web mediante tablas ni directamente formateando el archivo index.php. Ésto es porque no todos los navegadores interpretan exactamente igual las etiquetas HTML, sin embargo mediante CSS tenemos un control mucho mejor, afinando incluso pixel a pixel las posiciones y tamaños de todo. Así que vamos con esto y veremos que simple va a quedar y se va a entender cómo funciona todo.
El archivo index.php de ejemplo que vamos a usar es:
<?php defined( ‘_JEXEC’ ) or die( ‘Restricted access’ );?>
<!DOCTYPE html PUBLIC “-//W3C//DTD XHTML 1.0 Transitional//EN”
  “http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd”>
<html xmlns=”http://www.w3.org/1999/xhtml” 
   xml:lang=”<?php echo $this->language; ?>” lang=”<?php echo $this->language; ?>” >
<head>
<jdoc:include type=”head” />
<link rel=”stylesheet” href=”<?php echo $this->baseurl ?>/templates/mynew/css/template.css” type=”text/css” />
</head>
<body>

<div id=”arriba”><jdoc:include type=”modules” name=”arriba” /></div>
<div id=”izquierda”><jdoc:include type=”modules” name=”izquierda” /></div>
<div id=”derecha”><jdoc:include type=”modules” name=”derecha” /></div>
<div id=”contenido”><jdoc:include type=”component” /></div>
<div id=”abajo”><jdoc:include type=”modules” name=”abajo” /></div>

</body>
</html>
No voy a explicar en éste minitutorial cómo se maqueta con CSS porque es muy extenso. La idea es que hay que poner todo con DIVs y esos DIVs se posicionan en el navegador mediante el archivo CSS que luego veremos.
Si queremos usar un archivo desde el index.php debemos usar la instrucción PHP: <?php echo $this->baseurl ?> como se usa en el ejemplo anterior, por ejemplo, para incluir el archivo template.css
Las posiciones vienen definidas por: <jdoc:include type=”modules” name=”nombrePosicion” /> y podemos poner tantas posiciones como queramos.
La posición principal que va a mostrar el contenido viene definida por: <jdoc:include type=”component” /> que sólo la vamos a poner una vez.
Ahora nos queda hacer el CSS y el templateDetails.xml. El favicon.ico y los archivos PNG, son imágenes, el favicon es el icono que sale en el navegador cuando alguien nos visita en la página, y los archivos PNG son los vistas previas, en grande y pequeño, que muestra Joomla dentro del gestor de plantillas. Así que seguimos con el CSS (hoja de estilo para los amigos) llamado ‘template.css‘, por ejemplo ponemos:
#arriba {
  position: fixed;
  left: 0px;
  top: 0px;
  width: 100%;
  height: 30px;
  background-color: blue;
}
#izquierda {
  position: fixed;
  left: 0px;
  top: 30px;
  width: 100px;
  height: 100%;
  background-color: green;
}
#derecha {
  position: fixed;
  right: 0px;
  top: 30px;
  width: 100px;
  height: 100%;
  background-color: red;
}
#contenido {
  margin: 40px 110px 40px 110px;
  background-color: grey;
}
#abajo{
  position: fixed;
  left: 0px;
  bottom: 0px;
  width: 100%;
  height: 30px;
  background-color: blue;
}
El archivo templateDetails.xml es el archivo que define todo lo que necesita Joomla para poner las cosas en las posiciones en concreto y los contenidos. Un ejemplo para mi plantilla que he hecho llamada ‘mynew’ es:
<?xml version=”1.0″ encoding=”utf-8″?>
<extension version=”1.6″ type=”template”>
<name>mynew</name>
<creationDate>2012-10-21</creationDate>
<author>Yo mismo</author>
<authorEmail>Aquí v@ tu email .com</authorEmail>
<authorUrl>http://elblogdejnj.blogspot.com</authorUrl>
<copyright>http://elblogdejnj.blogspot.com 2012</copyright>
<license>GNU/GPL</license>
<version>1.0.0</version>
<description>My New</description>
<files>
<filename>index.php</filename>
<filename>templateDetails.xml</filename>
<filename>favicon.ico</filename>
<filename>template_preview.png</filename>
<filename>template_thumbnail.png</filename>
<folder>css</folder>
</files>
<positions>
<position>arriba</position>
<position>izquierda</position>
<position>derecha</position>
<position>abajo</position>
<position>contenido</position>
</positions>
</extension>

Llegado éste punto, acabamos de crear la nueva carpeta dentro de templates/ y hemos puesto todos estos archivos. Ahora resulta que tal cual Joomla no ve la plantilla dentro del administrador de plantillas. Podemos ir al Gestor de Extensiones y darle a Encontrar, con lo que Joomla buscará todo lo que hayamos puesto manualmente sin usar el instalador de Joomla. Ahora ya veremos la nueva plantilla en el Gestor de Plantillas, la ponemos como plantilla del sitio y nuestro sitio tendrá la apariencia que acabamos de hacer.

Ahora podemos editar éstos archivos directamente, añadirles imágenes, cambiar la hoja de estilos CSS, las posiciones, etc.. y sólo con refrescar la página veremos los cambios.

Otra opción para usar ésta plantilla, es comprimir el directorio donde está, y después instalarlo con el gestor de extensiones. Es decir, en el ejemplo anterior, hemos creado el directorio mynew/ dentro de templates/, comprimimos el directorio mynew/ con todos los archivos que hemos puesto y nos quedará, en éste caso, el archivo mynew.zip con toda la plantilla. Éste archivo comprimido es el que usamos en el gestor de extensiones para instalar la plantilla.

Para terminar, si todo ha ido bien, entonces tenemos que ver algo parecido a lo siguiente en nuestro navegador:

Sólo queda poner en cada posición los módulos que queramos usando Joomla. En las posiciones ahora tendremos: arriba, izquierda, derecha, contenido y abajo; que son los valores que hemos usado en el index.php y hemos puesto también en el ‘templateDetails.xml’. Ahora todo es imaginación y con buena documentación sobre CSS podremos hacer que nuestra página con Joomla tenga una apariencia única, totalmente personalizada, con efectos 3D o cualquier otra cosa que se pueda hacer con HTML, Javascript, CSS, etcétera…

Ésto es todo un mundo, las plantillas, los editores de plantillas, maquetación, etcétera… hay mucha información por Internet. Espero que haya servido.

Un saludo.
Hasta la próxima

© 2020 JnjSite.com - MIT license

Sitio hecho con WordPress, diseño y programación del tema por Jnj.