Comentarios y ejemplo con xajax - PHP Class Library

XAJaX es una librería de clases de código abierto elaborada en PHP que permite utilizar Ajax en aplicaciones web sin tener que programar directamente en JavaScript. Esto no significa que no se pueda utilizar JavaScript en una aplicación que esté utilizando XAJaX.

El programador simplemente elabora en PHP las funciones que actualizan el contenido de un objeto HTML (un DIV o un INPUT por ejemplo) y XAJaX se encarga de generar el código Javascript AJaX correspondiente a esas funciones en el momento de cargar la página.

En mi caso específico, he tenido la oportunidad de trabajar con esta librería y me ha gustado el hecho de no tener que elaborar el código Javascript para AjaX. En ocasiones he tenido que elaborar funciones que no actualizan contenido HTML sino más bien realizan únicamente operaciones en base de datos.

Para consultar información más detallada de esta librería, la página oficial del proyecto es: http://www.xajaxproject.org

Vamos a realizar un ejemplo sumamente sencillo de cómo puede utilizarse esta librería para actualizar dinámicamente el contenido de un objecto INPUT y de un objeto DIV.

El primer paso consiste en descargar la librería XajAx desde la página oficial (para este ejemplo se utilizó la versión 0.5 beta4 Compiled) y descomprimirla en una subcarpeta llamada xajax en la raíz donde vamos a ubicar los archivos de nuestro ejemplo. Los archivos que vamos a elaborar para nuestro ejemplo son: index.php (archivo principal que contiene los objetos HTML) y entorno_xajax.php (archivo con las funciones y el entorno XAJaX). La estructura de directorios y archivos de nuestro ejemplo sería la siguiente:

Primeramente vamos a crear nuestro archivo principal index.php que contiene los objetos HTML a ser actualizados dinámicamente:

Seguidamente vamos a crear el entorno de XAJaX (entorno_xajax.php) con las funciones encargadas de actualizar los contenidos de los objetos HTML (Archivo entorno_xajax.php):

Este ha sido un ejemplo muy sencillo de la utilización de XAJaX. Sin embargo, hay más cosas que se pueden llevar a cabo con esta librería (tema que está más allá del alcance de este artículo).

Descargar acá el ejemplo completo: ejemplo_xajax.zip

Las ventajas de documentar en PHP con phpDocumentor

Según el sitio http://www.phpdoc.org/, phpDocumentor es la herramienta estándar para auto-documentación en PHP; es decir, se puede generar documentación de forma automática tomando como base el código fuente. Usualmente esta herramienta es comparada con lo que Javadoc hace en Java.

Algunas de las ventajas de usar phpDocumentor son la ayuda obvia que recibe el programador para que todas sus aplicaciones tengan un formato de documentación similar, que además, es el mismo formato de documentación de cientos de programadores PHP, si todos usáramos el mismo formato de documentación sería bastante más sencillo tomar un código fuente iniciado por otra persona; además, usando este tipo de herramientas el programador "se obliga" a ir llenando los campos necesarios para documentar y seguir una serie de "buenas prácticas" que posiblemente pasaría por alto si no contara con la herramienta. Finalmente, es muy sencillo pasar de comentarios en el código fuente a tener preparado un documento (por ejemplo en HTML) con todo el detalle de los archivos, clases, funciones, etc. que utiliza una aplicación, explicando los parámetros de entrada, los valores de retorno, etc.

Con phpDocumentor es fácil estandarizar por ejemplo la documentación sobre qué hace una función, qué parámetros recibe, que valores devuelve, cómo se lleva a cabo cada paso, por qué algo se programó de una forma y no de otra, etc.

Algunas de las funcionalidades de phpDocumentor es que logra exportar todos estos comentarios a formato PDF, HTML u otros; tiene interfaz web o por medio de línea de comandos, manejo automático para los README/CHANGELOG/INSTALL/FAQ, consulte el listado completo de características (en Inglés)

Puede leer más sobre phpDocumentor en algunos de los siguientes enlaces:

• phpDocumentor -Documentar código nunca fue tan sencillo
• Página oficial de phpDocumentor