proyecto

Planificación de un proyecto modular
Autor: Marcio Barrios (http://www.marciobarrios.com/) - 21/07/2006




En este artículo mostraré mi visión sobre la organización de los proyectos en PHP y las posibles técnicas para optimizar el trabajo, además de introducir las bases para una programación modular.
Cuando queremos comenzar un proyecto individual en PHP de pequeña-mediana escala y noutilizamos un framework debemos tener en cuenta muchos factores al organizar el proyecto, de la buena planificación de estos factores depende en gran parte el éxito del proyecto y un fácil mantenimiento, ampliación, modificación, etc. Con la experiencia se va aprendiendo a organizar mejor las carpetas, a crear y organizar mejor el código, a reutilizar mejor nuestras funciones básicas, endefinitiva a optimizar el ritmo de trabajo con una serie de técnicas que deberían de repetirse en cada proyecto nuevo que iniciamos. Personalmente creo que esta división organizativa se puede dividir en varios puntos:
Organización en el servidor
Organización del código reutilizable
Organización del código que generamos
Organización en el servidor
Para que nuestro proyecto sea consistente y a lavez fácil de entender es básico que planifiquemos una programación modular, eso implica por ejemplo una distribución de carpetas en el Server de manera que nos sea fácil identificar cualquier código y acceder a él. Si al código le añadimos los xml que queramos generar para sindicaciones, las imágenes que utilicemos, los css y demás requerimientos es necesario una distribución práctica y sencilla.La distribución de carpetas que a mi me resulta útil es la siguiente:
modulos: aquí introduciremos todas las secciones de nuestro proyecto (página principal, contacto, catálogo, registro…)
includes: aquí colocaremos todos los php comunes y reutilizables (funciones, conexión bbdd…)
css: para los documentos de estilos
imágenes: para las imágenes que utilicemos
xml: para los xml desindicación
js: para los javascripts que utilicemos en el proyecto
Personalmente también divido algunos módulos en varias partes, es decir, imaginemos que tenemos un módulo de noticias que es una sección de la web donde mostramos noticias de un determinado tema, bien pues creo que lo más útil(que no lo más óptimo) sería dividir este código en porciones de la siguiente manera:
noticias.php en lacarpeta modulos: el módulo noticias únicamente con el código php y html que implementa la forma de mostrar las noticias.
noticias_consulta.php en la carpeta includes: la consulta a la base de datos para recoger este conjunto de noticias con unos parámetros previos, incluso podríamos generar una función si la utilizamos en otros sitios.
noticias_paginacion.php en la carpeta includes: la paginación delas noticias, igual que antes podríamos generar una función con parámetros para la paginación de varios listados de la web.
Como veis la nomenclatura es importante ya que así podemos identificar fácilmente los archivos de un mismo módulo dentro de la carpeta includes.
Por otra parte hay que decir que en la en la raíz únicamente tendremos el index.php y el htaccess (si utilizamos un servidorapache, que seguro que sí ;p), así conseguiremos una buena organización que quizá no se vea especialmente útil cuando se plantea, pero seguro que lo agradeceréis cuando volváis a trabajar en el proyecto pasado un tiempo.
Organización del código reutilzable
Evidentemente este es un punto que nos será útil una vez hayamos hecho varios proyectos y pruebas, a partir de aquí seguro que nos damoscuenta que hay porciones de código o funciones que podemos reutilizar en otros proyectos.
Lo ideal es que hagamos funciones con el código reutilizable, ya que así nos ayudará que nuestro programa sea más legible y más limpio que si lo utilizáramos directamente, de todos modos en cada proyecto nuevo sabremos identificar el código reutilizable y optimarlo para futuros proyectos, que en definitiva...