Interprete de plantillas sencillo y rápido con PHP

Categorias: PHP

A medida que uno va creando aplicaciones PHP se va dando cuenta de la conveniencia de diferenciar la lógica del programa del aspecto visual del mismo, es decir, mantener separados el código PHP del programa del código XHTML/HTML que define su aspecto visual.

Hay varios formas y niveles de separar el código PHP del XHTML, pero la más conveniente es aquella que permite la separación completa, es decir, aquella en la que el diseño es totalmente independiente del código de la aplicación. La forma de lograr esto es mediante el uso de lo que, en ingles, se suele denominar “Template engine”, es decir, “Interprete de plantilla”. Gracias a estos “Templante engines”, la lógica de la aplicación se define en el código PHP, creada y mantenida por los programadores, mientras que el aspecto visual se define en plantillas, creadas y mantenidas por un diseñador, alguien que no necesariamente sabe programar.

En el mundo de PHP, el “Template engine” más conocido, más potente y el que ofrece mayor flexibilidad es Smarty. Smarty permite la separación completa entre el código de la aplicación y su aspecto, definido mediante plantillas que permiten el uso de etiquetas y funciones especiales asignados desde el código PHP.

Smarty es genial, pero en muchos casos, resulta excesivamente complejo y lento. Recientemente, hemos tenido que crear una aplicación para el envio de boletines electrónicos mediante email en donde cada email debe ser personalizado con los datos del destinatario. Al principio, pensamos utilizar Smarty para personalizar los email a partir de una plantilla previamente definida, ya que su capacidad de precompilar las plantillas permitiría disminuir el tiempo necesario para interpretarlas. Al final no conseguimos que funcionara como queríamos y terminamos creando nuestro propio “Interprete de plantillas” que te presentamos a conitnuación:

Nuestro interprete de plantillas

<?php class Plantilla {     var $parseVars;   var $parseArrays;     function Plantilla() {     // Inicializar variables     $this->parseVars = null;     $this->parseArrays = null;   }     #   # Funcion para asignar variables a reemplazar   #   function assign($name, $data) {     // Verificar argumentos     if(!$name || !$data) return false;       // Analizar tipo de datos     if(is_array($data)) {       $this->parseArrays[$name] = $data;     } else {       $this->parseVars[$name] = $data;     }       // Respuesta predeterminada     return true;   }     #   # Funcion que intepreta y reemplaza variables en bucles   #   function parseLoop($name, $str) {       // Verificar que el array $name haya sido asignado     if(!is_array($this->parseArrays[$name])) return false;       // Almacenar $str     $strpy = $str;       // Ir de elementos en elemento del array     foreach($this->parseArrays[$name] as $item) {       // Verificar que $value sea un array       if(!is_array($item)) continue;         // Reemplazar variables de arrays en la plantilla  {$cliente.cliente_nombre}        $strp .= preg_replace('/\{\$(\w+)\.(\w+)\}/e',  "\$item['\\2']", $strpy)."\n";     }       // Devolver string formateado      return $strp;   }     #   # Funcion que reemplazar variables en la plantilla   #   function parse($str, $isfile = false) {       // Verificar que $str tenga algo     if(strlen($str) == 0) return false;       // Si $isfile es true, entonces $str es un path al fichero     if($isfile === true && is_readable($str)) $str = file_get_contents($str);       // Intepretar codigo php {php} echo date('Y/m/d H:i:s'); {/php}     $str = preg_replace('/\{php\}(.+)\{\/php\}/e', "eval('\\1')", $str);       // Incluir y parsear ficheros externos {include file="cliente/_header.tpl"}     $str = preg_replace('/\{include file=\"(\w+)\"\}/e', "\$this->parse('\\1')", $str);       // Intepretar y parsear bucles {loop name=arrayname} {$arrayname.varname} {/loop}     $str = preg_replace('/\{loop name=(\w+)\}(.+)\{\/loop\}/e', "\$this->parseLoop('\\1','\\2')", $str);       // Reemplazar variables de arrays en la plantilla  {$cliente.cliente_nombre}      $str = preg_replace('/\{\$(\w+)\.(\w+)\}/e', "\$this->parseArrays['\\1']['\\2']", $str);       // Reemplazar variables normales en plantilla    {$datetime}      $str = preg_replace('/\{\$(\w+)\}/e', "\$this->parseVars['\\1']", $str);       // Limpiar variables asignadas     $this->parseVars = null;     $this->parseArrays = null;       // Devolver string formateado     return $str;   } } ?>

El código superior es el código completo de nuestro “Interprete de plantillas”, guardalo en un archivo llamado “plantilla.class.php”.

Ejemplo con una sola variable

La utilización más simple de nuestro interprete de plantillas es aquel en el que asignas una sola variable a la plantilla, lo puedes ver a continuación:

// Incluir nuestro interprete include('plantilla.class.php');   // Define el código de la plantilla que queremos interpretar $codigo = "La hora actual es {$fechahora}";   // Inicializa la clase $tpl = new Plantilla();   // Asignar variable "fechahora" a la plantilla $tpl->assign('fechahora', date('Y/m/d H:i:s'));   // Interpreta e imprime el ćodigo HTML de la plantilla echo $tpl->parse($codigo);

Guarda este código en archivo llamado “ejemplo1.php” ubicado en el mismo directorio que “plantilla.class.php” y ejecutalo. Su resultado debería ser algo así:

La hora actual es 2005/10/28 15:07:48

Ejemplo con array

Otra posibilidad es asignar a la plantilla un array con valores en vez de una simple variable, un ejemplo de ello lo tienes a continuación:

// Incluir nuestro interprete include('plantilla.class.php');   // Define el código de la plantilla que queremos interpretar $codigo = "Mi nombre completo es {$datos.nombre} {$datos.apellidos}, tengo {$datos.edad} años y resido en {$datos.ciudad}";   // Definir el contenido del array que asignaremos a la plantilla $datos['nombre'] = 'Juan'; $datos['apellidos'] = 'Perez Garcia'; $datos['edad'] = '31'; $datos['ciudad'] = 'Madrid';   // Inicializa la clase $tpl = new Plantilla();   // Asignar array "datos" a la plantilla $tpl->assign('datos', $datos);   // Interpreta e imprime el ćodigo HTML de la plantilla echo $tpl->parse($codigo);

Si guardas y ejecutas este código de la misma forma que con el ejemplo anterior, el resultado sería:

Mi nombre completo es Juan Perez Garcia, tengo 31 años y resido en Madrid";

Ejemplo con un bucle

Supongamos que queremos hacer un listado de los estudiantes de una escuela, en este ejemplo te muestro como debería hacerse:

// Incluir nuestro interprete include('plantilla.class.php');   // Define el código de la plantilla que queremos interpretar $codigo = '<ul>{loop name=alumnos}<li>Su nombre es {$alumnos.nombre} y su edad {$alumnos.edad}</li>{/loop}</ul>';   $alumnos[] = array('nombre'=>'Juan Perez', 'edad'=>16); $alumnos[] = array('nombre'=>'María Sanchez', 'edad'=>15); $alumnos[] = array('nombre'=>'Paula Mendieta', 'edad'=>11);   // Inicializa la clase $tpl = new Plantilla();   // Asignar array de alumnos a la plantilla $tpl->assign('alumnos', $alumnos);   // Interpreta e imprime el ćodigo HTML de la plantilla echo $tpl->parse($codigo);

Si guardas y ejecutas este código de la misma forma que con el ejemplo anterior, el resultado sería:

    * Su nombre es Juan Perez y su edad 16     * Su nombre es María Sanchez y su edad 15     * Su nombre es Paula Mendieta y su edad 11

Ejemplo con inclusión de código PHP en plantilla

A veces es conveniente incluir en la plantilla algo de código PHP, en este ejemplo te mostramos como hacerlo:

// Incluir nuestro interprete include('plantilla.class.php');   // Define el código de la plantilla que queremos interpretar $codigo = "La hora actual es {php}echo date('Y/m/d H:i:s');{/php}";   // Inicializa la clase $tpl = new Plantilla();   // Interpreta e imprime el ćodigo HTML de la plantilla echo $tpl->parse($codigo);

Si guardas y ejecutas este código de la misma forma que con en los ejemplos anteriores, el resultado será el mismo que en el primer ejemplo:

La hora actual es 2005/10/28 15:07:48

Ejemplo con plantillas reales

Para terminar, un ejemplo en el cual el código HTML que vamos a interpretar está guardado en un archivo. Esta es la forma de almacenaminiento más habitual de las plantillas, aunque también se puede almacernar en una base de datos, etc.

Empezemos, para ponerlo más interesante vamos a usar 3 plantillas: la plantilla en sí, su cabecera y su pie de página. Llamemos a la primera “plantilla.tpl”, y “cabera.tpl” y “pie.tpl” a las otras dos.

Guardar el siguiente código en el archivo “cabecera.tpl”:

<html>   <head>     <title>Mi plantilla</title>     <body>     La hora actual es {$fechahora}

El siguiente código guardalos como “plantilla.tpl”:

{include file="cabecera.tpl"}     La hora actual es {$fechahora} {include file="pie.tpl"}

Y, por último, guarda este código en “pie.tpl”:

    La hora actual es {$fechahora}   </body> </html>

Ahora, guarda el siguiente código en un archivo llamado “ejemplo_con_archivos.php”:

// Incluir nuestro interprete include('plantilla.class.php');   // Inicializa la clase $tpl = new Plantilla();   // Asignar variable "fechahora" a la plantilla $tpl->assign('fechahora', date('Y/m/d H:i:s'));   // Interpreta e imprime el ćodigo HTML de la plantilla echo $tpl->parse("plantilla.tpl", true);

Como verás es prácticamente igual a nuestro primer ejemplo, pero hay dos diferencias:

1. La primera diferencia es que esta vez, como la plantilla está almacenado en un archivo no es necesario definir la variable $codigo que hasta ahora habíamos venido utilizando.
2. La segunda diferencia está en la forma que llamamos a la función de nuestro interprete que se encarga de interpretar las plantillas, $this->parse(). Esta vez, no le pasamos el código de la plantilla sino la ubicación del archivo y además, le pasamos otro argumentos con valor “true” que indica que le estamos pasando la ubicacion del archivo y no su contenido.

Además, como la plantilla “plantilla.tpl” insertaba otroas dos plantillas, el resultado final de la ejecución de este código será:

<html>   <head>     <title>Mi plantilla</title>   </head>   <body>     La hora actual es 2005/10/28 15:07:48       La hora actual es 2005/10/28 15:07:48       La hora actual es 2005/10/28 15:07:48         </body> </html>

Tagging: php, plantillas, smarty, template engine