La documentación de KumbiaPHP continúa mejorando para ofrecer ejemplos más precisos, explicaciones más claras y una experiencia de aprendizaje más sencilla. Durante los últimos días se incorporaron varias actualizaciones al manual, con especial atención en ActiveRecord, seguridad y el tutorial de CRUD.
Mejoras en ActiveRecord
Se corrigieron ejemplos de validación que contenían sintaxis PHP incorrecta y se ajustaron argumentos y mensajes para que correspondan con la API actual de KumbiaPHP. También se repararon ejemplos relacionados con callbacks y validaciones de correo electrónico.
La documentación de paginación también fue revisada. El ejemplo completo ahora conserva correctamente las condiciones de búsqueda y el estado de la paginación entre las diferentes solicitudes, además de corregir referencias a propiedades, comparaciones y archivos de las vistas.
Otro cambio importante fue la actualización de la referencia de la API de ActiveRecord. Se alinearon firmas de métodos, valores de retorno, convenciones de fechas, configuración y ejemplos con el comportamiento actual del framework.
Sin embargo, también se recomienda revisar la opción de utilizar el nuevo ActiveRecord, ya que incorpora mejoras de optimización y seguridad que pueden beneficiar a las aplicaciones que utilizan KumbiaPHP.
Documentación de seguridad más precisa
La seguridad también recibió una revisión importante.
Se eliminó de la documentación una afirmación incorrecta sobre la protección automática de ActiveRecord frente a inyecciones SQL. Ahora se explica con mayor claridad la diferencia entre el filtrado de solicitudes, el manejo de SQL, las consultas sin parámetros y el escape de contenido HTML.
El objetivo es que la documentación no solo muestre cómo utilizar el framework, sino que también ayude a comprender sus límites y a desarrollar aplicaciones más seguras.
Un tutorial CRUD más fácil de seguir
El tutorial de CRUD fue reorganizado para ofrecer una experiencia más progresiva, especialmente para quienes están comenzando con KumbiaPHP.
La nueva versión explica el flujo de datos y la relación con MVC, incorpora pasos para CRUD, rutas, paginación y verificación, además de incluir una sección de solución de problemas y una lista de comprobación. También se añadieron 14 capturas de pantalla con textos alternativos descriptivos y captions en Markdown.
Estas mejoras permiten seguir el tutorial de principio a fin y comprender no solo qué código escribir, sino también cómo se relacionan las diferentes partes de una aplicación KumbiaPHP.
Seguimos mejorando
Estas actualizaciones son parte del trabajo continuo para mantener la documentación de KumbiaPHP alineada con el framework y hacerla más útil tanto para desarrolladores experimentados como para quienes están aprendiendo.
Puedes consultar los cambios directamente en GitHub:
- PR #90, correcciones de ejemplos de ActiveRecord
- PR #91, correcciones del ejemplo de paginación
- PR #92, mejoras de documentación sobre seguridad SQL
- PR #93, actualización de la referencia de ActiveRecord
- PR #97, mejora del tutorial de CRUD
La documentación es una parte fundamental del proyecto. Mantenerla actualizada ayuda a que KumbiaPHP siga siendo más fácil de aprender, utilizar y mantener.