Empezando con Zend Framework.

Published: September 5, 2008Posted in: Zend FrameworkTags: , , ,
Empezando con Zend Framework.

Empezando con Zend Frameworks.

El otro día me encontré con una persona que se resistía a usa frameworks por el alto costo de aprendizaje que estos requerían. Si bien tiene cierto costo de aprendizaje, ese costo a mediano plazo es totalmente redituable.  Esto lo digo porque varias veces he leído por ahí, gente buscando alguna librería para que maneje la conexion a la base de datos, otra para hacer un paginador, otra para el manejo del access controll list (ACL), entre otras; y lo que nos da este framework, es una solución para los problemas mas comunes, así evitamos rompernos la cabeza buscando la mejor solución, porque esto ya lo tenemos en Zend Framework. Si analizamos esto, aprender a implementar una solución, es muchisimo mas fácil que crearla, y este es el costo de aprendizaje de Zend Framework. Por esto, voy a tratar de explicar de la mejor manera como empezar a trabajar con un proyecto hecho enteramente en Zend Framework, aprovechando todos sus componentes a la medida que lo necesitemos.


1- Estructura de directorios.

Lo primero que necesitamos hacer es definir nuestra estructura básica de directorios. Nuestra estructura tiene que tener una carpeta donde podamos guardar nuestros archivos de acceso publico, como css, jpeg, avi, swf, etc. Esa carpeta en nuestro caso se va a llamar html/, la cual contendrá una carpeta css/, otra images/ y  por ultimo una carpeta js/ por ahora.
Esta carpeta también contendrá nuestro bootstrap, el cual se va a encargar de llamar al modulo que corresponda, y otros menesteres. 

Necesitamos una carpeta para nuestros componentes y los de Zend Framework, y para eso vamos a usar library/. Dentro de la carpeta library vamos a tener una carpeta Me/ y otra Zend/, en la primera por ahora no vamos a tener nada pero la idea es que cada componente que propio, lo colguemos en esa carpeta, Zend/ contendrá los componentes de Zend Framework.

Los módulos de nuestros sistemas van a estar compuestos de tres partes, controlador, modelo, y vista (MVC). Para esto vamos a crear una carpeta llamada apps/, en la cual vamos a tener una carpeta controllers, otra models, y otra views.

Necesitamos una carpeta para guardar todos nuestros archivos de configuracion, para seguir ejercitando nuestro lado creativo vamos a llamarla config/. Y otra carpeta para nuestros layouts, que la vamos a llamar con el mismo nombre.

A partir de lo que mencionamos anteriormente, nuestra estructura de directorios tendría que quedarnos de la siguiente manera.


Una vez definida nuestra estructura de directorio como siguiente paso vamos a incorporar los componentes de Zend Framework a nuestro proyecto. Hay varias formas de hacerlo, la que uso yo para no ocupar espacio innecesario en duplicar ZF es crear una carpeta Zend, en alguna parte de mi sistema, y a partir de ahí crear symlinks a cada proyecto, de esta forma, solo tengo una copia de ZF, y cada vez que hay alguna actualizacion de ZF solo actualizo una carpeta.

Supongamos que nosotros tenemos en /usr/local/Zend/apache2/htdocs/ nuestros proyectos, y en ese mismo lugar una carpeta Zend, con todos los componentes de Zend Framework.

Abrimos una consola y ejecutamos el siguiente comando.

$ ln -s /usr/local/Zend/apache2/htdocs/Zend/ /usr/local/Zend/apache2/htdocs/proyecto/library/Zend


2- Bootstrap.
El próximo paso es configurar nuestro bootstrap. El cual va a estar dentro de nuestra carpeta html, y vamos a llamarlo index.php.

  1.  
  2. <?php
  3. set_include_path(‘library’ . PATH_SEPARATOR .
  4.                  ‘config’ . PATH_SEPARATOR .
  5.                  ‘apps/models’ . PATH_SEPARATOR .
  6.                  ‘apps/controllers’ . PATH_SEPARATOR . PATH_SEPARATOR .
  7.                  get_include_path());
  8. /**
  9.  * Carga las clases que sean necesarias
  10.  */
  11. include "Zend/Loader.php";
  12. Zend_Loader::registerAutoload();
  13. /**
  14.  * Configuración inicial
  15.  */
  16. error_reporting(E_ALL | E_STRICT);
  17. date_default_timezone_set(‘America/Buenos_Aires’);
  18. /**
  19.  * Setup controller
  20.  */
  21. $controller = Zend_Controller_Front::getInstance();
  22. $controller->setControllerDirectory( ‘../apps/controllers’ );
  23. $controller->throwExceptions( true ); //Inicialmente esta en true, cuando pasemos a produccion deberia estar en false
  24. // DISPATCH!
  25. $controller->dispatch();
  26. ?>
  27.  



La idea es que nuestro bootstrap no sea demasiado complejo. Primero vamos a definir el path de nuestros directorios, a los cuales queremos acceder de forma facil. Mas adelante hablaremos del componente Zend_Loader, y que es el registerAutoload. Ademas le indicamos que nos muestre todos los errores, y los problemas de versiones. Y por ultimo, le decimos que ejecute el modulo que corresponda, y que lo busque en nuestra carpeta apps/controllers/


3- Configuramos el ambiente, y las reglas de Rewrite

Lo siguiente a crear son las reglas de rewrite para que se redireccione al bootstrap cada vez que se requiera algo, salvo en el caso que sea un js, css, jpeg, o cualquier extension que no sea necesario procesarla desde el bootstrap.

Nuestro archivo .htaccess tambien va a estar dentro de la carpeta html/ y tiene que tener el siguiente contenido.

RewriteEngine on
RewriteRule !\.(js|ico|gif|jpg|png|css)$ index.php

Ahora necesitamos configurar nuestro virtual host, para eso editamos el archivo httpd.conf de apache, al final de todo ingresamos el siguiente codigo

<VirtualHost *:80>
ServerAdmin admin@admin.com
DocumentRoot “/usr/local/Zend/apache2/htdocs/proyecto/html”
ServerName www.proyecto.com
ServerAlias www.proyecto.com
ErrorLog logs/proyecto-error_log
CustomLog logs/proyecto-error_log common
</VirtualHost>

Por ultimo en nuestro /etc/hosts agregamos la siguiente linea.

127.0.0.1  www.proyecto.com


4- Crear nuestro primer modulo

Una vez reiniciado el apache, en nuestro browser escribimos nuestra url de prueba. www.proyecto.com y si hicimos las cosas bien, nos aparece el siguiente error.


Los que nos dice esta excepcion, es que nos falta nuestro controller default que es index.

Para esto tenemos que crear dentro dentro de nuestra carpeta apps/controllers, un archivo con el nombre IndexController.php, el cual va a ser nuestro archivo principal.

IndexController.php

  1.  
  2. <?php
  3. class IndexController extends Zend_Controller_Action
  4. {
  5.     public function indexAction()
  6.     {
  7.     }
  8. }
  9. ?>
  10.  


Cada vez que nosotros necesitaramos agregar un modulo por ejemplo, un modulo de usuarios, tenemos que crear un controlador para ese modulo. Cada accion que podamos ver en nuestro modulo, va a estar representado por un metodo con el nombre de la accion mas la palabra Action, de esta forma, Zend_Controller_Action identifica que es una accion valida.

En el ejemplo nosotros estamos usando Index como modulo, e index como accion, en nuestro caso, a ser la accion default no necesitamos agregar en nuestra url, el nombre del modulo, y el nombre de la accion, aunque si lo hacemos nos anda igual, por ejemplo si tipeamos www.proyecto.com/index/index/ vamos a tener el mismo resultado que www.proyecto.com o que www.proyecto.com/index/, eso es porque ZF interpreta que sino se especifica un modulo en la url, estamos hablando del modulo default (Index en nuestro caso), lo mismo con la accion.

Si nosotros queremos ver nuestro modulo de usuarios a la accion default, nuestra url seria la siguiente http://www.proyecto.com/usuarios, si queremos referirnos a la accion read, deberiamos llamarlo asi http://www.proyecto.com/usuarios/read/.

En articulos anteriores vimos un poco del patron de disenio MVC, no voy a entrar en detalles en este articulo.
El patron MVC
Zend Framework y el patron MVC

Nuestro modulo Index, tiene que mostrar algo en el browser, esto lo vamos a configurar desde nuestra vista, que en nuestro caso las vistas, las tenemos en la carpeta views/scripts/. Creamos una carpeta con el nombre del modulo, para guardar todos nuestros archivos ahi. Nos quedaria la siguiente carpeta views/scripts/index/ dentro de la cual vamos a crear un archivo, con el mismo nombre de la accion, index.phtml. La extension phtml, es la que usa como default ZF, para los archivos de la vista.

En nuestro index.phtml, vamos a generar un simple hola mundo.

index.phtml


Si todo salio bien, y ejecutamos en nuestro browser http://www.proyecto.com/

Tenemos que ver la siguiente salida






Esta es la primer entrega, donde apuntamos a la configuracion basica, mas adelante iremos aplicando mas complejidad a nuestro proyecto.