Diferencia entre revisiones de «Plantilla:PHP/Smarty»

De WikiEducator
Saltar a: navegación, buscar
(Smarty)
(Instalando Smarty)
Línea 28: Línea 28:
 
#Al ser usado por una amplia comunidad de desarrolladores, existen multitud de ejemplos y foros para la resolución de los problemas que te vayas encontrando al utilizarlo.
 
#Al ser usado por una amplia comunidad de desarrolladores, existen multitud de ejemplos y foros para la resolución de los problemas que te vayas encontrando al utilizarlo.
  
 +
<div id=parrafo>
 
==Instalando Smarty==
 
==Instalando Smarty==
*Nos descargamos los ficheros de la web
+
Nos descargamos los ficheros de la web<br />
 
  http://www.smarty.net/download
 
  http://www.smarty.net/download
*Lo copiamos en nuestra máquina
+
Vamos a la sección de '''''downloads''''' y descargamos la última versión (En 2017 es la 3.1.30<br />
*De estos ficheros, para funcionar lo que necesitamos es lo que está en el directorio libs
+
[[Imagen:SmartyDownload.png]]
*Lo copiamos en /usr/local/share/smarty (previamente creamos la carpeta).
+
Al clikear, nos redirige a una página de github https://github.com/smarty-php/smarty/releases/tag/v3.1.30 y procedemos a descargar el fichero, en mi caso descargué el tar '''''smarty-3.1.30.tar.gz'''''.<br />
*Modificamos el fichero php.ini añadiendo esta ruta
+
Descomprimimos el fichero y se genera una carpeta.
<source lang=bash>
+
<source lang=bash>
include_path=".:/usr/local/share/php:/usr/share/pear:/usr/local/share/smarty/libs"
+
tar xvfz smarty-3.1.30.tar.gz
 
</source>
 
</source>
{{Definicion|'''''include_path''''' es una lista de directorios donde Apache  (mejor dicho el módulo de apache que se encarga de ejecutar php), al ejecutar código php va a ir a buscar ficheros que necesite para ejecutar ese código}}
+
Obtenemos la carpeta '''''smarty-3.1.30'''''.<br />
{{Nota|Observa que el caracter dos puntos ''''':''''' es el caracter para separar los directorios en  la lista de directorios}}
+
Si observamos su contenido, en un nivel 1 vemos los siguientes ficheros y directorios<br />
 +
[[Archivo:SmartyDirectorios.png]]<br />
 +
De ellos nos interesa el directorio libs que es dónde está el códgio de la clase '''''Smarty'''''que gestiona las platillas. Ahora podríamos copiar esta carpeta en cada proyecto, o copiarla en una carpeta del sistema para tenerla disponible para los diferentes proyectos.<br />
 +
Vamos a decantarnos por la segunda opción, la instalaremos en una carpeta del sistema y modificaremos el path en php.ini, para que esté disponible para todos los proyectos.
 +
{{MRM_Actividad|Title=Instalar '''''Smarty''''' en el sistema|
 +
1.- Creamos la carpeta '''''smarty en /usr/local/share/
 +
    <source lang=bash>
 +
    sudo mkdir /usr/local/share/smarty
 +
    </source>
 +
2.- Copiamos la carpeta libs a esta ubicación
 +
    <source lang=bash>
 +
    sudo cp -R ~/smarty-3.1.30/libs .
 +
    </source>
 +
{{Tip| ~ representa el directorio dónde esté ubicado smarty-3.1.30}}
 +
3.- Modificamos en el fichero php.ini la variable o directiva '''''include_path''''' agregando esta ubicación
 +
    <source lang=bash>
 +
    sudo  vim /etc/php5/apache2/php.ini
 +
    ....
 +
    ;buscamos la línea donde se asigna valor a include_path
 +
    ;agregamos la ubicación, observar que para añadir nuevas
 +
    ; ubicaciones se separa de la anterior con :
 +
    ; UNIX: "/path1:/path2"
 +
    include_path = ".:/usr/share/php:/usr/local/share/smarty/libs"
 +
</source>
 +
4.- Guardamos el fichero y rebotamos el sistema
 +
<source lang=bash>
 +
apt-get service apache2 restart
 +
</source>
 +
 
 +
 
 +
}}
 +
 
 +
*
 +
{{MRM_Definicion|'''''include_path''''' es una lista de directorios donde''''' Apache''''' (mejor dicho el módulo de apache que se encarga de ejecutar php), al ejecutar código php va a ir a buscar ficheros que necesite para ejecutar ese código}}
 +
{{Nota|Observa que el carácter dos puntos ''''':''''' es el carácter para separar los directorios en  la lista de directorios}}
 
{{Nota|Observa que el primer directorio en esa lista es el directorio actual identificado con el carácter punto '''''.'''''}}
 
{{Nota|Observa que el primer directorio en esa lista es el directorio actual identificado con el carácter punto '''''.'''''}}
  
*Con esto ya tenemos la aplicación motor de plantillas lista para usarese
+
Con esto ya tenemos la aplicación motor de plantillas lista para usarse en nuestros proyectos.<br />
*Ahora vamos a ver como utilizarla
+
</div>
*Para cada aplicación crearemos una estructura de directorios, fuera de los ficheros que entregamos a los clientes
+
*Se recomienda ponerlos fuera ya que estos ficheros nunca son accedidos directamente por el servidor web, sino  por los ficheros ubicados en '''''libs''''' de '''smarty'''
+
*Por ejemplo creamos en raiz '''''/web/smarty/dir_por_aplicacion'''''
+
*En cada directorio hay que crear una estructura con cuatro carpetas
+
#templates
+
#templates_c
+
#configs
+
#cache
+
*Una vez creados estos ficheros, el usuario de apache y el del editor de texto que tengamos deben de tener permisos de escritura sobre estos ficheros
+
*Deberíamos de dejar permisos 770 para estas carpetas.
+
*Esto para los usuarios propietarios del servicio Apache (ver https.conf o el fichero de configuración correspondiente de apache y el fichero de configuración de netbeans.
+
*Una solución salomónica y parcial es dejar un 777 en desarrollo y luego cambiarlo (nada recomendada, pero muy cómoda).
+
  
 
==Usando smarty==
 
==Usando smarty==

Revisión de 21:43 19 ene 2017

Gestor de plantillas

El gestor de plantillas o mejor llamado motor de plantillas es una versión más simplificada de separar la lógica de presentación de la lógica de negocio.
El motor de plantillas es una aplicación que genera una página web a partir de dos fuentes:

  1. Un fichero con la información de presentación o plantilla que sería como la vista
  2. otro fichero con la lógica interna de la aplicación que sería el modelo-controlador
Icon present.gif
Tip: En este caso no existiría controlador separado del modelo, lo que simplificaría el escenario.


Este escenario de trabajo persigue el objetivo de separar el trabajo del diseño o generador de plantillas, con el trabajo del programador de la aplicación, aunque lógicamente tienen puntos de unión.
Entre los gestores de plantillas más pontentes y usados podemos encontrar smarty y twig



  • Por la pontencia y sencillez y la información disponble en la web, vamos a estudiar smarty.

Smarty

Es un código abierto basado en la licencia LGPL que permite crear, usar y gestionar plantillas.
En la documentación en castellano podemos encontrar una explicación completa de esta aplicación; Nosotros no vamos a profundizar en su estudio, simplemente vamos a aprender a manejarla, no obstante la herramienta permitiría perfectamnete cubrir amplios desarrollos de forma muy profesional. Por ejemplo este wiki usa ese sistema de plantillas.


Icon key points.gif

Puntos clave

El propósito de ver smarty es doble:

aprender a usar la herramientas
aprender a programar separando la lógica de la presentación


Profundizaremos más este segundo aspecto al estudiar Laravel
Sobre Smarty, podríamos comentar entre otras características:

  1. Permite la inclusión en las plantillas de una lógica de presentación compleja.
  2. Acelera la generación de la página web resultante. Uno de los problemas de los motores de plantillas es que su utilización influye negativamente en el rendimiento. Smarty convierte internamente las plantillas a guiones PHP equivalentes, y posibilita el almacenamiento del resultado obtenido en memoria temporal.
  3. Al ser usado por una amplia comunidad de desarrolladores, existen multitud de ejemplos y foros para la resolución de los problemas que te vayas encontrando al utilizarlo.

Instalando Smarty

Nos descargamos los ficheros de la web

http://www.smarty.net/download

Vamos a la sección de downloads y descargamos la última versión (En 2017 es la 3.1.30
SmartyDownload.png Al clikear, nos redirige a una página de github https://github.com/smarty-php/smarty/releases/tag/v3.1.30 y procedemos a descargar el fichero, en mi caso descargué el tar smarty-3.1.30.tar.gz.
Descomprimimos el fichero y se genera una carpeta.

 tar xvfz smarty-3.1.30.tar.gz

Obtenemos la carpeta smarty-3.1.30.
Si observamos su contenido, en un nivel 1 vemos los siguientes ficheros y directorios
SmartyDirectorios.png
De ellos nos interesa el directorio libs que es dónde está el códgio de la clase Smartyque gestiona las platillas. Ahora podríamos copiar esta carpeta en cada proyecto, o copiarla en una carpeta del sistema para tenerla disponible para los diferentes proyectos.
Vamos a decantarnos por la segunda opción, la instalaremos en una carpeta del sistema y modificaremos el path en php.ini, para que esté disponible para todos los proyectos.


Icon activity.jpg
Instalar Smarty en el sistema

1.- Creamos la carpeta smarty en /usr/local/share/

    sudo mkdir /usr/local/share/smarty

2.- Copiamos la carpeta libs a esta ubicación

    sudo cp -R ~/smarty-3.1.30/libs .
Icon present.gif
Tip: ~ representa el directorio dónde esté ubicado smarty-3.1.30


3.- Modificamos en el fichero php.ini la variable o directiva include_path agregando esta ubicación

    sudo  vim /etc/php5/apache2/php.ini
     ....
    ;buscamos la línea donde se asigna valor a include_path
    ;agregamos la ubicación, observar que para añadir nuevas
    ; ubicaciones se separa de la anterior con :
    ; UNIX: "/path1:/path2"
    include_path = ".:/usr/share/php:/usr/local/share/smarty/libs"

4.- Guardamos el fichero y rebotamos el sistema

 apt-get service apache2 restart






Icon define.gif
Definición
include_path es una lista de directorios donde Apache (mejor dicho el módulo de apache que se encarga de ejecutar php), al ejecutar código php va a ir a buscar ficheros que necesite para ejecutar ese código


(Comment.gif: Observa que el carácter dos puntos : es el carácter para separar los directorios en la lista de directorios)



(Comment.gif: Observa que el primer directorio en esa lista es el directorio actual identificado con el carácter punto .)



Con esto ya tenemos la aplicación motor de plantillas lista para usarse en nuestros proyectos.

Usando smarty

Smarty en la lógica del negocio

  • En el fichero donde vamos a especificar la lógica del programa tenemos que indicar que vamos a usar una vista a través de plantillas
  • Para ello realizamos los includes correspondientes.
  • Suponemos que tenemos una aplicacion llamada app1
  • Y que los ficheros de la plantilla de esa aplicación están en /web/smarty
<?php
//.....
require_once('Smarty.class.php');
$smarty = new Smarty;
$smarty->template_dir = '/web/smarty/app1/templates/';
$smarty->compile_dir = '/web/smarty/app1/templates_c/';
$smarty->config_dir = '/web/smarty/app1/configs/';
$smarty->cache_dir = '/web/smarty/app1/cache/';
//...
?>
  • Si en un momento dado queremos enviar un determinado valor y dejarlo disponible para la plantilla
  • Para ello usaremos el método assign(...)
....
$smarty->assign('usuario', $_SESSION['usuario']);
...
?>
  • Para visualizar la plantilla completa donde se cargarán los valores que hemos asignado previamente
  • Para ello usaremos el método display(...)
//...
$smarty->display('cesta.tpl');
//...


smarty en las plantillas

  • Ahora vamos a generar la plantilla
  • La plantilla es la página que el cliente va a visualizar
  • En ella podemos escribir lo mismo que en una página html normal
  • Pero además podremos incluir los valores que la lógica del negocio haya generado
  • Para este cometido, deberemos usar delimitadores propios de Smarty que son llaves {}
  • Vamos a ver una serie de elementos que podemos incluir
  1. Comentarios. Van encerrados entre asteriscos.
{* Este es un comentario de plantilla en Smarty *}
  1. Variables.
Se incluye simplemente su nombre, precedido por el símbolo $.
También se pueden especificar modificadores, separándolos de la variable por una barra vertical.
{$producto->codigo}
  1. Estructura de procesamiento condicional: if, elseif, else.
Permite usar condiciones, de forma similar a PHP, para decidir si se procesa o no cierto contenido.
//En el ejemplo de la cesta
{if empty($productoscesta)}
    <p>Cesta vacía</p>
{else}{/if}
  1. Bucles: foreach.
Son muy útiles para mostrar varios elementos, por ejemplo en una tabla.
Deberás indicar al menos con from el array en el que están los elementos, y con item la variable a la que se le irán asignado los elementos en cada iteración. (En esto cambia un poco la sintaxis de php
{foreach from=$productoscesta item=producto}
  <p>{$producto->codigo}</p>
{/foreach}
  1. Inclusión de otras plantillas.
Smarty permite descomponer una plantilla compleja en trozos más pequeños
Así las almacenaremos en otras plantillas, que se incluirán en la actual utilizando la sentencia include.
<div id="cesta">      
  {include file="productoscesta.tpl"}
</div>
<div id="productos">
  {include file="listaproductos.tpl"}
</div>