Diferencia entre revisiones de «KumbiaPHP Framework Versión 1.0 Spirit»

De KumbiaPHP Framework Wiki
m
 
(No se muestran 334 ediciones intermedias de 59 usuarios)
Línea 1: Línea 1:
 +
{{cleanupbox
 +
|image=[[Archivo:Information_icon4.png|45px]]
 +
|imageright=[[Archivo:Information_icon4.png|45px]]
 +
|texto ='''Este manual corresponde la versión 1.0 beta 1(Desaconsejada). <br />Se recomienda ver la última versión del [https://github.com/KumbiaPHP/Documentation/tree/master/es Manual de KumbiaPHP 1.0]'''
 +
}}
 +
 
== Introducción ==
 
== Introducción ==
−
En la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) el enfoque primordial que ha considerado el [https://launchpad.net/%7Edesarrollokumbia Equipo de Desarrollo] gira en torno al rendimiento del framework a nivel de velocidad y en este sentido hemos obtenido grandes resultados, de manera que las pruebas en base a esta versión nos indica que es bastante rápida con pequeños cambios aplicando las mejores practicas de desarrollo.
+
En la [https://launchpad.net/kumbia/1.0 versión 1.0](<s>antigua 0.5.1</s>) el enfoque primordial que ha considerado el [[Team_Development_KumbiaPHP_Framework|Equipo de Desarrollo]] gira en torno al rendimiento del framework a nivel de velocidad y mantenibilidad del framework en este sentido hemos desacoplado el core de kumbiaphp framework en una nueva estructura obteniendo grandes resultados, de manera que las pruebas en base a esta versión nos indica que vamos en buen camino y ademas es bastante rápida con los cambios aplicados siempre con las mejores practicas de desarrollo.
  
 
Entre los componentes a nivel del core que hemos tocado para lograr nuestros objetivos se encuentran:
 
Entre los componentes a nivel del core que hemos tocado para lograr nuestros objetivos se encuentran:
 +
#Estructura de Directorios
 
#environment.ini
 
#environment.ini
 
#Router
 
#Router
Línea 15: Línea 22:
  
  
−
Como se menciona al principio muchos de estos cambios son a nivel de '''core''', esto significa que haremos pocas adecuaciones para migrar nuestras aplicaciones que hayan sido desarrolladas con la [https://launchpad.net/kumbia/0.5 versión 0.5] para llevarlas hasta la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>), esto con la finalidad de garantizar compatibilidad entre versiones.
+
Como se menciona al principio muchos de estos cambios son a nivel de '''core''', esto significa que haremos pocas adecuaciones para migrar nuestras aplicaciones que hayan sido desarrolladas con la [https://launchpad.net/kumbia/0.5 versión 0.5] para llevarlas hasta la [https://launchpad.net/kumbia/1.0 versión 1.0](<s>antigua 0.5.1</s>), esto con la finalidad de garantizar compatibilidad entre versiones.
 
===¿Por qué Spirit?===
 
===¿Por qué Spirit?===
−
"Hemos llamado Spirit a la version 1.0 porque Spirit, [http://es.wikipedia.org/wiki/Spirit nuestro robot de Marte], tiene como características principales, fuerza y velocidad. Fuerza, porque su comunidad cada vez mas grande hace que nuestro framework KumbiaPHP avance a pasos agigantados. Velocidad, porque nuestro core team que pertenece a otro planeta, continuamente esta aplicando las ultimas técnicas y haciendo que otros frameworks se queden atrás día a día. En definitiva Spirit, hace que tus aplicaciones vuelen, resulten mas atractivas y fáciles de mantener."
+
"Hemos llamado Spirit a la versión 1.0 porque Spirit, [http://es.wikipedia.org/wiki/Spirit nuestro robot de Marte], tiene como características principales, fuerza y velocidad. Fuerza, porque su comunidad cada vez mas grande hace que nuestro framework KumbiaPHP avance a pasos agigantados. Velocidad, porque nuestro core team que pertenece a otro planeta, continuamente esta aplicando las ultimas técnicas y haciendo que otros framework's se queden atrás día a día. En definitiva Spirit, hace que tus aplicaciones vuelen, resulten mas atractivas y fáciles de mantener."
  
 
== Migración Rápida ==
 
== Migración Rápida ==
−
En esta sección se explica de forma rápida y sencilla como migrar nuestras aplicaciones de la versión [https://launchpad.net/kumbia/0.5 0.5] a la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) en las próximas secciones se explican en detalle los cambios.
+
En esta sección se explica de forma rápida y sencilla como migrar nuestras aplicaciones de la <s>versión [https://launchpad.net/kumbia/0.5 0.5]</s> a la [https://launchpad.net/kumbia/1.0 versión 1.0](<s>antigua 0.5.1</s>) en las próximas secciones se explican en detalle los cambios.
−
*Si has modificado el archivo '''views/index.phtml''' este fue ubicado en el directorio '''views/templates/default.phtml''', es decir que lo debes sobreescribir o aplicar los cambios que quieras.
+
 
−
*Para inicializar tu aplicación es mejor utilizar el archivo '''config/routes.ini''' agregando una regla de enrutamiento estático, por ejemplo.
+
*Con la nueva estructura de directorio migrar nuestras aplicaciones de la <s>versión [https://launchpad.net/kumbia/0.5 0.5]</s> es sumamente simple solo se ha copiar nuestra carpeta '''apps/default/''' (donde estan los controllers, models, views, etc) hacia el directorio '''app/''' de [[KumbiaPHP_Framework_Versi%C3%B3n_1.0_Spirit#Nueva_Estructura_de_Directorios |Nueva Estructura]]
−
  ;con esta regla cada vez que inicie la aplicación http://localhost/kumbia/ irá hacia un controlador admin y una acción autenticar
+
 
−
/ = admin/autenticar
+
*En el Controlador los métodos '''initialize, finalize, before_filter y after_filter''' ahora son '''protected''' por motivos de seguridad.
−
Esto sustituye editar el archivo '''apps/default/controllers/application.php''' en su acción '''init()''', solo se ha de agregar en el '''routes.ini''' la ruta que hacemos en el método '''init()'''
+
 
 +
*Si has modificado el archivo '''views/index.phtml''' este fue ubicado en el directorio '''views/templates/default.phtml''', es decir que le debes aplicar los cambios que quieras.
 +
 
 +
* Sustituye la función <s>content()</s> por View::content() y <s>render_partial()</s> por View::partial().
 +
 
 +
*Para inicializar tu aplicación se ha de utilizar el '''config/routes.ini''' agregando una regla de enrutamiento estático, por ejemplo:
 +
  ;con esta regla cada vez que inicie la aplicación http://localhost/kumbia/ irá hacia un controlador  
 +
admin y una acción autenticar / = admin/autenticar
 +
 
 +
Esto sustituye editar el archivo '''<s>apps/default/controllers/application.php</s>''' en su acción '''init()''', solo se ha de agregar en el '''routes.ini''' la ruta que hacemos en el método '''<s>init()</s>'''
 +
 
 
*Si en tus modelos utilizas el atributo '''$mode''' para establecer otros datos de conexión, debes reemplazarlo por '''$database''', [[KumbiaPHP_Framework_Versión_1.0_Spirit#databases.ini| ver mas]].
 
*Si en tus modelos utilizas el atributo '''$mode''' para establecer otros datos de conexión, debes reemplazarlo por '''$database''', [[KumbiaPHP_Framework_Versión_1.0_Spirit#databases.ini| ver mas]].
 +
*Si Cargas librerias vía boot.ini ahora se usa libs= en vez de extensions= Y también se quita el prefijo '''kumbia.'''
 +
 +
'''KumbiaPHP 0.5'''
 +
<pre>
 +
[modules]
 +
extensions = kumbia.logger, kumbia.auth
 +
</pre>
 +
'''KumbiaPHP 1.0'''
 +
<pre>
 +
[modules]
 +
libs = logger, auth
 +
</pre>
 +
 +
== Constante en KumbiaPHP==
 +
En la version 1.0 Spirit, se ha creado tres constantes cada cual cumple un objetivo especifico con el fin de brindar mayor flexibilidad al momento de manejar rutas (paths) en el framework.
 +
 +
=== APP_PATH ===
 +
Constante que contiene la ruta absoluta al directorio donde se encuentra nuestra aplicación (app).
 +
 +
Ejemplo:
 +
<pre>
 +
echo APP_PATH; //la salida es: /var/www/kumbiaphp/app/ 
 +
</pre>
 +
 +
Esta constante es posible utilizarla para incluir archivos que se encuentre bajo el arbol de directorio de la aplicación, por ejemplo imagine que quiere incluir un archivo que esta en el directio '''app/libs/test.php''' la forma de hacerlo seria.
 +
 +
<pre>
 +
  include_once APP_PATH.'libs/test.php';
 +
</pre>
 +
 +
'''NOTA: siempre será mejor utilizar el [[KumbiaPHP_Framework_Versión_1.0_Spirit#Carga_Selectiva.2C_Inyecci.C3.B3n_de_Dependencias_y_el_Componente_Load |Componente Load]] para incluir dependencias.'''
 +
 +
=== CORE_PATH ===
 +
Constante que contiene la ruta absoluta al directorio donde se encuentra el [[KumbiaPHP_Framework_Versión_1.0_Spirit#Explicando_dir_core.2F |core]] de KumbiaPHP.
 +
 +
Ejemplo:
 +
<pre>
 +
echo CORE_PATH; //la salida es: /var/www/kumbiaphp/core/ 
 +
</pre>
 +
 +
Para incluir archivos que se encuentre bajo este arbol de directorio es el mismo procedimiento que se explico para la constante APP_PATH
 +
 +
'''NOTA: El core de KumbiaPHP en la version 1.0 esta totalmente desacoplado del directorio de la aplicación. [[KumbiaPHP_Framework_Versión_1.0_Spirit#Ventajas_de_esta_nueva_estructura_de_directorios|Ventajas de la Estructura de directorio]]'''
 +
 +
=== PUBLIC_PATH ===
 +
Constante que contiene la URL para el navegador (browser) y apunta a '''app/public/''' para enlazar imágenes, CSS, JavaScript y todo lo que sea ruta para browser.
 +
 +
Ejemplo:
 +
<pre>
 +
//Genera un link que ira al controller: controller y action: action
 +
<a href="<?php echo PUBLIC_PATH ?>controller/action/" title="Mi Link">Mi Link</a>
 +
 +
//Enlaza una imagen que esta en public/img/imagen.jpg
 +
<img src="<?php echo PUBLIC_PATH ?>img/imagen.jpg" alt="Una Imagen" />
 +
 +
//Enlaza el archivo CSS en public/css/style.css
 +
<link rel="stylesheet" type="text/css" href="<?php echo PUBLIC_PATH ?>css/style.css"/>
 +
</pre>
 +
 +
'''NOTA: siempre será mejor hacer uso de los helpers'''
 +
 +
== Nueva Estructura de Directorios ==
 +
En la versión de KumbiaPHP se incorpora la siguiente estructura de directorios, a continuación se detallan los elementos mas relevantes:
 +
 +
<pre>
 +
spirit/
 +
|-- app
 +
|  |-- application.php
 +
|  |-- config
 +
|  |-- controllers
 +
|  |-- extensions
 +
|  |  |-- filters
 +
|  |  |-- helpers
 +
|  |  `-- scaffolds
 +
|  |-- index.php
 +
|  |-- libs
 +
|  |-- locale
 +
|  |-- model_base.php
 +
|  |-- models
 +
|  |-- public
 +
|  |-- temp
 +
|  `-- views
 +
|      |-- errors
 +
|      |-- pages
 +
|      |-- partials
 +
|      `-- templates
 +
|-- core
 +
|  |-- console
 +
|  |-- docs
 +
|  |-- extensions
 +
|  |  |-- helpers
 +
|  |  `-- scaffolds
 +
|  |-- kumbia
 +
|  |-- libs
 +
|  |-- tests
 +
|  |-- vendors
 +
|  `-- views
 +
|      |-- errors
 +
|      |-- partials
 +
|      `-- templates
 +
</pre>
 +
 +
Anteriormente [http://www.kumbiaphp.com KumbiaPHP] utilizaba un fichero '''index.php''' el cual servía para enrutar a cada aplicación utilizando inversión de control, esto erá poco flexible y resultaba en un consumo inadecuado de recursos, por lo tanto en esta nueva versión se preparó una nueva estructura de directorios donde cada aplicación posee un directorio independiente con su '''index.php''' (Front Controller) correspondiente el cual se encarga de cargar las librerías del framework.
 +
 +
Copiando el directorio '''app''', tenemos toda la estructura para un nueva aplicación. Ya que podemos tener tantas aplicaciones como necesitemos con un único core.
 +
 +
Asimismo el núcleo, las extensiones de KumbiaPHP y otras herramientas que utilizarán las aplicaciones de manera global fueron agrupadas en el directorio core.
 +
 +
===Ventajas de esta nueva estructura de directorios===
 +
* Mayor Velocidad :-)
 +
* Cada aplicación tiene su propio front controller (index.php)
 +
* '''Independencia''' total de nuestra aplicación respecto al core del framework.
 +
* Cada aplicación tendrá sus '''propios directorios''' (public, temp, libraries, etc). En versiones anteriores si se tenia 40 aplicaciones significaba que todo iba al mismo public (css, img, js, etc).
 +
* En cada '''actualización''' de KumbiaPHP, sólo se ha de pasar la carpeta de tu aplicación ("app") a la nueva versión de kumbiaPHP Framework y ya tendremos la última versión del Framework.
 +
 +
===Explicando dir app===
 +
Este será el directorio sobre el cual trabajamos el 90% mientras desarrollamos nuestra aplicación. A continuación se explica en detalle cada uno de los directorios disponible para cada aplicación.
 +
 +
{| cellpadding="2" cellspacing="2" border="2" style="background: #eee; border: 1px #666 solid; border-collapse: collapse; "
 +
!Directorio!!Descripción
 +
|-
 +
|config||Archivos de configuración de nuestra aplicación (config.ini, routes.ini, databases.ini y boot.ini)
 +
|-
 +
|controllers||Estan agrupados los controladores (controllers) y/o módulos. Por defecto se encuentra el controller '''pages_controller.php'''
 +
|-
 +
|models||Estan agrupados los modelos (models).
 +
|-
 +
|views||Estan agrupados las vistas de los controladores (controllers). Por defecto se encuentran los directorios '''templates/''', '''pages/''', '''partials/''' y '''errors/'''
 +
|-
 +
|extensions||En este directorio se ubican las extensiones para nuestra aplicación, una extensión te permite adicionar nuevas características que serán utilizadas e integradas a la aplicación por medio de las librerías que proporciona [http://www.kumbiaphp.com KumbiaPHP]
 +
|-
 +
|libs||En este directorio se pueden colocar clases propias con fines específicos o librerías externas al framework (vendors). Estas para ser utilizadas en los controladores (controllers) y/o Modelos (models).
 +
|-
 +
|temp||Este directorio contiene las carpetas y archivos creados cuando [http://www.kumbiaphp.com/ KumbiaPHP] está cacheando un template, view o partial y cuando realiza operaciones de logs. '''Este directorio necesita permisos de escritura'''.
 +
|-
 +
|public||Agrupa las imágenes, css, javascript y files que serán utilizados por nuestra aplicación
 +
|-
 +
|locale||Agrupa los archivos para el soporte a la internacionalización i18n para la aplicación.
 +
|-
 +
|'''application.php'''||Super class de los controladores (ApplicationController). 
 +
|-
 +
|'''model_base.php'''||Super class de los modelos (ActiveRecord). 
 +
|}
 +
 +
===application.php===
 +
Cada vez es mas usado en las aplicaciones creadas en PHP la Programación Orientada a Objetos (POO), KumbiaPHP Framework fomenta el uso de la misma, debemos hacer especial hincapié en el archivo '''application.php''' el cual fue concebido como una superclase (ApplicationController) padre de todos los controladores.
 +
 +
[[Archivo:Application_kumbiaphp_framework.png|center|thumb|200px|application.php]]
 +
 +
Como se aprecia en la imagen existe una estrecha relación entre '''application.php''' y los controladores disponibles en el directorio controllers/. Esta relación se basa principalmente en que las variables y métodos creados en el '''ApplicationController''' (application.php) estarán disponibles para ser usados en cualquier controlador que tengamos en nuestra aplicación.
 +
 +
En esta clase se encuentran dos métodos principales, dichos métodos se comportan como un filtro antes y después de ejecutar un controller.
 +
 +
El método '''initialize()''' se ejecuta antes de llamar al controller.
 +
 +
El método '''finalize()''' se ejecuta despúes de haber llamado al controller.
 +
 +
 +
----
 +
 +
=== Ejemplo de application.php ===
 +
 +
[[Archivo:Ejemplo_application_kumbiaphp_framework.png|center|thumb|600px|application.php]]
 +
 +
=== model_base.php ===
 +
De la misma manera como se relacionan los controladores con application.php, existe otra relación muy importante entre el '''model_base.php''' y los modelos. Todo lo que se define en model_base.php estará disponible en los modelos ya que es la class padre.
 +
 +
model_base.php es donde esta definida la super clase '''ActiveRecord'''.
 +
 +
  NOTA: Los modelos representan las tablas de nuestra Base de Datos.
 +
 +
 +
[[Archivo:Model_base_kumbiaphp_framework.png|center|thumb|600px|application.php]]
 +
 +
=== Explicando dir core/ ===
 +
 +
{| cellpadding="2" cellspacing="2" border="2" style="background: #eee; border: 1px #666 solid; border-collapse: collapse; "
 +
!Directorio!!Descripción
 +
|-
 +
|console||En este directorio se ubican los scripts de terminal que te ayudarán a construir y manejar algunos aspectos de nuestra aplicación
 +
|-
 +
|docs||En este directorio se encuentran los detalles de licencia y otros archivos inherentes a la documentación de [http://www.kumbiaphp.com KumbiaPHP]
 +
|-
 +
|extensions|| En este directorio se encuentran las extensiones compartidas por todas las aplicaciones
 +
|-
 +
|kumbia|| En este directorio se ubica el núcleo de [http://www.kumbiaphp.com KumbiaPHP]
 +
|-
 +
|libs|| En este directorio se encuentran las librerias compartidas por todas las aplicaciones, las cuales el [http://wiki.kumbiaphp.com/Team_Development_KumbiaPHP_Framework Equipo de Desarrollo] se responsabiliza por su mantenimiento.
 +
|-
 +
|tests||En este directorio se ubican las pruebas unitarias para [http://www.kumbiaphp.com KumbiaPHP]
 +
|-
 +
|vendors||En este directorio se ubican las librerias de terceros que son compartidas por todas las aplicaciones
 +
|}
  
 
== config.ini ==
 
== config.ini ==
−
Se agregan opciones para un manejo mas apropiado de la configuración del framework.
+
Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.
  
−
*'''databases''' cuando se necesite trabajar con el framework pero sin interactuar con una Base de Datos.
 
−
*'''models_autoload''' Auto carga de modelos, util para cuando se manejan muchos modelos no tener la necesidad de cargarlos todos en un momento, sino que se cargan se de acuerdo lo que se necesiten en el controller, todo esto se traduce en mejor rendimiento, [[KumbiaPHP_Framework_Versi%C3%B3n_1.0_Spirit#Carga_selectiva_de_modelos| leer mas]]
 
 
*'''metadata_lifetime''' Tiempo de vida de la metadata cacheada.
 
*'''metadata_lifetime''' Tiempo de vida de la metadata cacheada.
 
*'''database''' Base de datos a utilizar, especificada en databases.ini.
 
*'''database''' Base de datos a utilizar, especificada en databases.ini.
 
*'''production''' Indica si se encuentra en producción.
 
*'''production''' Indica si se encuentra en producción.
 +
*'''cache_driver''' driver que se utilizara para el manejo de cache. KumbiaPHP cuenta con tres (3) driver: file, sqlite y memsqlite.
 +
*'''locale''' Localización.
 +
*'''routes''' Activar enrutamiento estatico.
  
−
<pre>
+
<pre>;; Configuracion de Aplicacion
−
;; Configuracion de Aplicaciones
 
  
 
; Explicación de la Configuración:
 
; Explicación de la Configuración:
  
−
; default_app: es la aplicacion por defecto
 
−
; mode: Es el entorno en el que se esta trabajando que esta definido en config/config
 
 
; name: Es el nombre de la aplicación
 
; name: Es el nombre de la aplicación
 
; timezone: Es la zona horaria que usará el framework
 
; timezone: Es la zona horaria que usará el framework
−
; interactive: Indica si la aplicación se encuentra en modo interactivo
+
; production: Indica si esta en producción
 +
; database: base de datos a utilizar
 
; dbdate: Formato de Fecha por defecto de la Applicación
 
; dbdate: Formato de Fecha por defecto de la Applicación
−
; charset: codificación de caracteres
+
; debug: muestra los errores en pantalla (On|off)
−
; databases: Habilita la carga de modelos automática
+
; log_exceptions: muestra las excepciones en pantalla (On|off)
−
; models_autoload: Habilita la autocarga de modelos
+
; charset: codificacion de caracteres
 +
; cache_driver: driver para la cache (file, sqlite, memsqlite)
 
; metadata_lifetime: Tiempo de vida de la metadata cacheada
 
; metadata_lifetime: Tiempo de vida de la metadata cacheada
−
; locale: Localicazion
+
; locale: Localizacion
−
; database: base de datos a utilizar
+
; routes: Activar enrutamiento estatico
−
; production: indica si se encuentra en produccion
 
  
  
Línea 62: Línea 271:
 
; la metadata
 
; la metadata
  
−
[kumbia]
+
[application]
−
default_app = default
 
−
timezone = "America/New_York"
 
−
 
 
−
[default]
 
−
mode = development
 
 
name = "KUMBIA PROJECT"
 
name = "KUMBIA PROJECT"
−
interactive = On
+
;timezone = "America/New_York"
−
controllers_dir = default/controllers
+
production = Off
−
models_dir = default/models
+
database = development
 
dbdate = YYYY-MM-DD
 
dbdate = YYYY-MM-DD
 
debug = On
 
debug = On
 
log_exceptions = On
 
log_exceptions = On
 
charset = UTF-8
 
charset = UTF-8
−
databases = off
+
cache_driver = file
−
models_autoload = On
 
 
;metadata_lifetime = "+1 year"
 
;metadata_lifetime = "+1 year"
 
;locale = es_ES
 
;locale = es_ES
 +
;routes = On
 
</pre>
 
</pre>
  
Línea 89: Línea 293:
 
Lo mismo sucede para los modelos, el atributo <s>$mode</s> fue reemplazado por '''$database'''
 
Lo mismo sucede para los modelos, el atributo <s>$mode</s> fue reemplazado por '''$database'''
  
−
<pre>
+
<source lang=php>
 
class Usuarios extends ActiveRecord
 
class Usuarios extends ActiveRecord
 
{
 
{
 
     public $database = 'test';
 
     public $database = 'test';
 
}
 
}
−
</pre>
+
</source>
  
 
Ahora KumbiaPHP Framework buscara los datos de conexión de la sección '''[test]''', para el modelo Usuarios.
 
Ahora KumbiaPHP Framework buscara los datos de conexión de la sección '''[test]''', para el modelo Usuarios.
Línea 107: Línea 311:
 
host = localhost
 
host = localhost
 
username = root
 
username = root
−
password =
+
password = 1qaz2WSX
−
name = innogest
+
name = test
 
type = mysql
 
type = mysql
  
Línea 114: Línea 318:
 
host = localhost
 
host = localhost
 
username = root
 
username = root
−
password =
+
password = 1qaz2WSX
 
name = test
 
name = test
−
type = mysql
+
type = mssql
  
 
[test]
 
[test]
 
host = localhost
 
host = localhost
 
username = root
 
username = root
−
password =
+
password = 1qaz2WSX
 
name = test
 
name = test
−
type = mysql
+
type = mssql
 
</pre>
 
</pre>
  
 
== boot.ini ==
 
== boot.ini ==
−
En este archivo es donde el usuario carga las extensiones (librerías) que trae el framework o bien alguna que deseen agregar.
+
En este archivo fue eliminado, ahora se recomienda la carga explicita con '''require''' o '''include''' o en su defecto aprovechar la autocarga de librerias de KumbiaPHP.
−
En este archivo se agregan dos atributos '''kumbia''' y '''extensions''' para que la lectura del mismo sea mas rápida.
+
O mejor usar el Load::lib('lib')
−
 
 
−
Extensiones Propias de Kumbiaphp Framework
 
−
*logger
 
−
*auth
 
−
*date
 
−
*standard_form
 
−
*filter
 
−
*acl
 
−
*benchmark
 
−
*security
 
−
 
 
−
Extensiones externas al framework
 
−
*excel
 
−
*fpdf
 
−
*mail
 
−
*smarty
 
−
 
 
−
<pre>
 
−
; Cargar los modulos de Kumbia en library/
 
−
; CONVENCIONES
 
−
; La convención para la carga de extensiones (librerías) por medio
 
−
; de este archivo es la siguiente:
 
−
; kumbia = logger indica que en el directorio library/kumbia/logger
 
−
; y a su vez este tiene un archivo logger.php kumbia incluira library/kumbia/logger/logger.php
 
−
; lo mismo sucede para las extensiones externas al core del framework, solo que estas no estan
 
−
; kumbia, sino en la variable extensions
 
−
 
 
−
; kumbia: Modulos del framework que se cargaran library/kumbia
 
−
; extensions: Modulos a cargar library/
 
−
 
 
−
[modules]
 
−
kumbia = logger, filter
 
−
extensions =
 
−
</pre>
 
  
 
== Router ==
 
== Router ==
Línea 186: Línea 356:
 
Los [http://en.wikipedia.org/wiki/Template_(file_format) Template] son un tipo de archivo pre-formateado utilizado como base para otros archivos.
 
Los [http://en.wikipedia.org/wiki/Template_(file_format) Template] son un tipo de archivo pre-formateado utilizado como base para otros archivos.
  
−
En este directorio esta la capa mas externa de nuestras vistas, para aclarar esta idea en esta es donde se coloca la estructura del documento XHTML (doctype, html, head, etc) en la forma como se trabaja en la '''versión 0.5''' esto es representado por el archivo '''views/index.phtml''' de esta forma no existe una flexibilidad de manera que podamos cambiar ese template, en la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) se crea un directorio '''views/templates/''' por defecto existe el archivo '''default.phtml''' pero podemos podemos agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma:
+
En este directorio esta la capa mas externa de nuestras vistas, para aclarar esta idea en esta es donde se coloca la estructura del documento XHTML (doctype, html, head, etc) en la forma como se trabaja en la <s>versión 0.5</s> esto es representado por el archivo <s>'''views/index.phtml'''</s> de esta forma no existe una flexibilidad de manera que podamos cambiar ese template, en la [https://launchpad.net/kumbia/1.0 versión 1.0] se crea un directorio '''views/templates/''' por defecto existe el archivo '''default.phtml''' pero podemos agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma:
−
+
 
 +
<source lang=php>
 
  class PruebaController extends ApplicationController  
 
  class PruebaController extends ApplicationController  
 
  {
 
  {
 
     public $template = 'plantilla';
 
     public $template = 'plantilla';
 
  }
 
  }
 +
</source>
 +
 +
El atributo '''$template''' existe en la super clase '''Controller''' y tiene un valor por defecto (default) esto significa que el sistema de plantillas de KumbiaPHP Framework buscara dentro de directorio views/templates/ el valor que le demos, por defecto buscara '''default.phtml''' pero en otro caso que veamos conveniente podría ser otro template tal como se muestra en el ejemplo seria '''plantilla.phtml'''
  
−
El atributo '''$template''' existe en la super clase '''Controller''' y tiene un valor por defecto (default) esto significa que el sistema de plantillas del framework buscara dentro de directorio views/templates/ el valor que le demos, por defecto buscara '''default.phtml''' pero en otro caso que veamos conveniente podría ser otro template tal como se muestra en el ejemplo seria '''plantilla.phtml'''
+
En la '''version 0.5''' para determinar en que parte del template se debe renderizar se hacia uso de la función "content", ahora esa función se encapsuló en la clase View y se utiliza de la siguiente manera.
 +
 
 +
<source lang=php >
 +
 
 +
Este es mi template
 +
 
 +
<?php View::content() ?>
 +
</source>
 +
 
 +
'''View::content()''' puede ubicarse en cualquier lugar del template.
  
 
=== views/partials/ ===
 
=== views/partials/ ===
Línea 202: Línea 385:
  
 
'''views/partials/fecha.phtml'''
 
'''views/partials/fecha.phtml'''
−
<pre>
+
<source lang=php >
 
  <div style='background: #333eee; padding: 15px 10px 15px 10px; text-align: center'>
 
  <div style='background: #333eee; padding: 15px 10px 15px 10px; text-align: center'>
 
       <i><?php echo date('Y-m-d'); ?></i>
 
       <i><?php echo date('Y-m-d'); ?></i>
 
  </div>
 
  </div>
−
</pre>
+
</source>
−
Como se aprecia este partials solo mostrará la fecha actual cuando sea invocado, pero como se menciono antes puede contener cualquier información para el usuario, pero aun falta hacer un llamado a este partials para que el mismo sea mostrado este llamado puede ser desde cualquier nivel del sistema de plantilla que ofrece el framework y basta con hacer en la vista (Templates, views) lo siguiente.
+
 
 +
Como se aprecia este partials solo mostrará la fecha actual cuando sea invocado, pero como se menciono antes puede contener cualquier información para el usuario, pero aun falta hacer un llamado a este partials para que el mismo sea mostrado este llamado puede ser desde cualquier nivel del sistema de plantilla que ofrece el framework, en la'''versión 0.5''' se hacia uso de la funcion "render_partial", sin embargo con la finalidad de obtener mayor orden e intuitividad, esta función se encapsulo en la clase '''View''',  y basta con hacer en la vista (Templates, views) lo siguiente.
  
−
<pre>
+
<source lang=php >
−
  <?php render_partial('fecha') ?>
+
  <?php View::partial('fecha') ?>
−
</pre>
+
</source>
  
  
 
'''Describiendo la función de manera mas detallada:'''
 
'''Describiendo la función de manera mas detallada:'''
−
<pre>
+
<source lang=php >
−
render_partial($partial, $time=false, $params=array())
+
  View::partial($partial, $time=false, $params=array())
−
</pre>
+
</source>
  
 
Para cachear los partials, el tiempo de cacheo debe indicarse con el formato de strtotime tal como lo utiliza el componente cache.
 
Para cachear los partials, el tiempo de cacheo debe indicarse con el formato de strtotime tal como lo utiliza el componente cache.
  
−
<pre>
+
<source lang=php >
−
<?php render_partial('fecha', '+4 days') ?>
+
  <?php View::partial('fecha', '+4 days') ?>
−
</pre>  
+
</source>  
  
 
Si no se desea cachear, se indica como segundo argumento "false", el cual es el valor por defecto
 
Si no se desea cachear, se indica como segundo argumento "false", el cual es el valor por defecto
  
−
<pre>
+
<source lang=php >
−
<?php render_partial('fecha', false) ?>
+
  <?php View::partial('fecha', false) ?>
−
</pre>  
+
</source>  
 +
 
 +
También es posible pasar variables al partial utilizando parámetros con nombre o utilizando como argumento un array. Si estos parámetros se pasan en forma de array soporta cualquier tipo de dato (objecto, array, etc).
  
−
También es posible pasar variables al partial utilizando parámetros con nombre o utilizando como argumento un array. Si estos parámetros son se pasan en forma de array soporta cualquier tipo de dato (objecto, array, etc).
+
<source lang=php >
 +
  <?php View::partial('fecha', false, 'var: valor, var2: valor2') ?>
 +
</source>
  
−
<pre>
 
−
<?php render_partial('fecha', false, 'var: valor') ?>
 
−
</pre>
 
  
−
<pre>
+
<source lang=php >
−
  <?php render_partial('fecha', false, array('var' => 'valor')) ?>
+
  <?php View::partial('fecha', false, array('var' => 'valor')) ?>
−
</pre>  
+
</source>  
  
 
Y esta es accesible en el partial como $var
 
Y esta es accesible en el partial como $var
Línea 245: Línea 430:
 
Los modelos ya no se cargan directamente en los partials, esto mejora la velocidad, para hacer uso de los modelos en los partials, el usuario puede instanciar directamente el modelo, la desventaja de esta manera es que el usuario debe haber cargado previamente el modelo haciendo uso de "load_models" en el controller en caso de utilizar carga selectiva de modelos:
 
Los modelos ya no se cargan directamente en los partials, esto mejora la velocidad, para hacer uso de los modelos en los partials, el usuario puede instanciar directamente el modelo, la desventaja de esta manera es que el usuario debe haber cargado previamente el modelo haciendo uso de "load_models" en el controller en caso de utilizar carga selectiva de modelos:
  
−
<pre>
+
<source lang=php >
 
  <?php  
 
  <?php  
 
     $Usuario = new Usuario();
 
     $Usuario = new Usuario();
 
     $usuario = $Usuario->find(1);
 
     $usuario = $Usuario->find(1);
 
  ?>
 
  ?>
−
</pre>
+
</source>
 +
 
 +
También es posible utilizar el método '''Load::models($model)''', el cual se encarga de cargar la clase de ser necesario, este método solo debe usarse para obtener un modelo para efectuar consultas de recuperación de datos (find, findBy, find_first, etc) preferiblemente.
 +
 
 +
<source lang=php >
 +
<?php
 +
  Load::models('usuario');
 +
  $usuario = new Usuario();
 +
  $result = $usuario->find(1);
 +
?>
 +
</source>
 +
 
 +
Con la intención de ofrecer mayor comodidad, KumbiaPHP también hace posible obtener una instancia de un modelo directamente haciendo uso del método '''[[KumbiaPHP_Framework_Versión_1.0_Spirit#Load::model.28.24model.29 |Load::model($modelo)]]'''.
 +
 
 +
<source lang=php >
 +
<?php
 +
  $result = Load::model('usuario')->find(1);
 +
?>
 +
</source>
 +
 
 +
=== View::content()===
 +
Este método de la clase '''View''' viene a remplazar la función '''content()''', esta se utiliza para indicar donde [http://www.kumbiaphp.com KumbiaPHP] debe renderizar (mostrar) el contenido almacenado en el buffer de salida, es decir el próximo nivel de la vista.
 +
 
 +
Su uso para las vistas de las acciones esta íntimamente ligado a los '''echo''' o '''print''' que efectué el usuario, asimismo determina el lugar donde se mostrarán los mensajes '''Flash''' provenientes de ActiveRecord o los propios. Ejemplo:
 +
 
 +
<source lang=php >
 +
<?php
 +
  class SaludoController extends ApplicationController
 +
  {
 +
      public function hola()
 +
      {
 +
          Flash::success('Hola mundo');
 +
      }
 +
  }
 +
?>
 +
</source>
 +
 
 +
Y en mi vista "hola.phtml"
 +
 
 +
<source lang=php >
 +
  Saludo realizado:
 +
 
 +
  <?php View::content() ?>
 +
</source>
 +
 
 +
===View::helpers($helper)===
 +
Un '''''helpers''''' representa una ayuda a nivel de las vistas (view), esto quiere decir siendo consistente con el m'''V'''c solo deben ser utilizados en las vistas.
 +
 
 +
Los '''''helpers''''' estan ubicados en '''miapp/extensions/helpers/''', en ese directorio pueden existir tantos helpers como necesitemos [http://www.kumbiaphp.com KumbiaPHP], pero tambien pueden existir helpers en '''core/extensions/helpers/''' en estos casos el framework da prioridad a los helpers ubicados en el directorio de la aplicación, esto quiere decir que si existen dos archivos con el mismo nombre en los directorios helpers antes descrito [http://www.kumbiaphp.com KumbiaPHP] cargara el que se encuentra ubicado en el directorio de la aplicación (app).
 +
 
 +
Estos '''''helpers''''' pueden ser métodos con fines como formatear fechas, creación de tags HTML personalizados adecuados a las necesidades de nuestra aplicación, etc. veamos un ejemplo de un helpers.
 +
 
 +
<source lang=php >
 +
 
 +
//Ubicamos este código en un fichero de nombre: miapp/extensions/helpers/MiHelper.php
 +
 
 +
class MiHelper
 +
{
 +
/**
 +
* Construye una lista desplegable para países
 +
**/
 +
public static function paisSelect($id, $value=null) {
 +
    //carga el modelo models/pais.php
 +
    $Pais = Load::model('pais');
 +
 
 +
    $code = "<select name=\"$id\" id=\"$id\">";
 +
    foreach($Pais->find() as $pais) {
 +
        $code .= "<option value=\"$pais->id\"";
 +
        if($pais->id == $value) {
 +
            $code .= ' selected="selected"';
 +
        }
 +
        $nombre = htmlspecialchars($pais->nombre);
 +
        $code .= ">$nombre</option>";
 +
    }
 +
    $code .= '</select>';
 +
 
 +
    echo $code;
 +
}
 +
</source>
 +
 
 +
Como vemos en el helper anterior se construye un tag select de acuerdo a ciertas necesidades y este representa una salida, es decir un view por eso se utilizan en las vistas (views) para hacer buen uso del MVC, la forma de utilizar el helper anterior en cualquier vista seria de la siguiente manera.
 +
 
 +
<source lang=php >
 +
<?php
 +
//Esta es una vista cualquiera
 +
 
 +
//la convención para cargar el helpers es pasar el parámetro tal como llamamos al fichero
 +
//cargamos el helpers
 +
View::helpers('MiHelper')
 +
 
 +
//Hacemos uso del helpers, con esto tendremos un select en el view
 +
MiHelpers::paisSelect(1)
 +
 
 +
?>
 +
 
 +
</source>
 +
 
 +
=== Utilizando el método render($view, [$template]) ===
 +
El método '''render($view, [$template])''' se encuentra en la super clase ApplicationController es decir lo tenemos disponible solo en los controladores.
 +
 
 +
Este es un método que es muy poderoso con una utilización correcta del mismo, en la versión 1.0 lo hemos extendido para ofrecer mas flexibilidad en el manejo de las vistas, el cual nos permite de forma dinámica poder cambiar un view y un [[#views.2Ftemplates.2F | Template]] (el template es opcional) esto nos permite tener varias vistas (views) para la misma action incluso varios [[#views.2Ftemplates.2F | Template]].
 +
 
 +
==== ¿De que sirve esto? ====
 +
Esto es una de las ventajas del manejo de vistas de [http://www.kumbiaphp.com KumbiaPHP] y nos sirve para muchas cosas. Por ej: Si tenemos una aplicación web y también se quiere que esta pueda ser accedida desde dispositivos móviles (celular, PDA, etc.) no es necesario programar toda la aplicación de nuevo, sino que simplemente se cambia la vista pero lo mas importante es que el controlador sigue siendo el mismo.
 +
 
 +
==== Vamos a lo Práctico ====
 +
Tenemos un controlador con una acción, pero deseamos que dicha acción tenga dos vistas asociadas y poderlas cambiar según sea el caso, el cambio de vista se dará de acuerdo a un parámetro que recibirá la acción del controlador.
 +
 
 +
'''NOTA: KumbiaPHP muestra el view con el mismo nombre de la acción.'''
 +
 
 +
<source lang=php>
 +
<?php
 +
class BlogController extends ApplicationController
 +
{
 +
    public function saludo($var=null)
 +
    {
 +
        $this->usuario = 'Usuario';
 +
    if($var == 'adios'){
 +
            //cambiamos el view
 +
            $this->render('adios');
 +
    }
 +
    }
 +
}
 +
</source>
 +
 
 +
Como se aprecia se cambiara el view de la acción si el parámetro es "adios" sino es pasado ningún parámetro KumbiaPHP seguirá la convención que buscara el directorio de views la vista asociada al nombre de la acción.
 +
 
 +
Ahora tenemos las vistas.
 +
 
 +
'''app/views/blog/saludo.phtml'''  (vista por defecto de la acción).
 +
 
 +
<source lang=php>
 +
  <?php echo "Bienvenido $usuario" ?>
 +
</source>
 +
 
 +
La vista anterior se renderizara (mostrar) cuando tengamos la siguiente URL:
 +
 
 +
  http://dominio.com/blog/saludo/
 +
 
 +
'''app/views/blog/adios.phtml'''  (vista cuando existe el parámetro).
 +
 
 +
<source lang=php>
 +
  <?php echo "Adios $usuario" ?>
 +
</source>
 +
 
 +
La vista anterior se renderizara (mostrar) cuando tengamos la siguiente URL:
 +
 
 +
  http://dominio.com/blog/saludo/adios/
 +
 
 +
===== Cambiando el Template con método render($view, $template) =====
 +
Pero también es posible cambiar el [[#views.2Ftemplates.2F | Template]] veamos la misma acción pero ahora cambiara el template.
 +
 
 +
<source lang=php>
 +
<?php
 +
class BlogController extends ApplicationController
 +
{
 +
    public function saludo($var=null)
 +
    {
 +
        $this->usuario = 'Usuario';
 +
    if($var == 'adios'){
 +
            //cambiamos el view y el template
 +
            $this->render('adios', 'otro_template');
 +
    }
 +
    }
 +
}
 +
</source>
 +
 
 +
Ahora mostramos un nuevo [[#views.2Ftemplates.2F | Template]] llamado '''otro_template''' para cuando cambiamos el views a '''adios'''.
 +
 
 +
===== Ahora sin Template render($view, null) =====
 +
Ahora indicamos que no deseamos mostrar el [[#views.2Ftemplates.2F | Template]] veamos la misma acción pero sin el template.
 +
 
 +
<source lang=php>
 +
<?php
 +
class BlogController extends ApplicationController
 +
{
 +
    public function saludo($var=null)
 +
    {
 +
        $this->usuario = 'Usuario';
 +
    if($var == 'adios'){
 +
            //cambiamos el view y sin template
 +
            $this->render('adios', null);
 +
    }
 +
    }
 +
}
 +
</source>
 +
 
 +
Cuando vayan a http://dominio.com/blog/saludo/adios/ KumbiaPHP cargara solamente el view adios.phtml sin template ya que así lo indicamos.
 +
 
 +
===== Ahora sin view render(null, [$template]) =====
 +
Ahora indicamos que no deseamos mostrar el View de la acción, veamos la misma acción pero sin el view.
 +
 
 +
<source lang=php>
 +
<?php
 +
class BlogController extends ApplicationController
 +
{
 +
    public function saludo($var=null)
 +
    {
 +
        $this->usuario = 'Usuario';
 +
    if($var == 'adios'){
 +
            //Mostrando un mensaje desde la acción
 +
            Flash::notice('Adios '.$this->usuario);
 +
 
 +
            //sin el view y con el template por defecto
 +
            $this->render(null);
 +
    }
 +
    }
 +
}
 +
</source>
  
−
También es posible utilizar el método '''Kumbia::model($model)''', el cual se encarga de cargar la clase de ser necesario y maneja un singleton del objeto, este metodo solo debe usarse para obtener un modelo para efectuar consultas de recuperación de datos (find, findBy, find_first, etc) preferiblemente.
+
===== Ahora sin view y sin template render(null, null) =====
 +
Ahora indicamos que no deseamos mostrar el View de la acción y el Template, veamos la misma acción pero sin el view y sin template.
  
−
<pre>
+
<source lang=php>
−
<?php $usuario = Kumbia::model('Usuario')->find(1); ?>
+
<?php
−
</pre>
+
class BlogController extends ApplicationController
 +
{
 +
    public function saludo($var=null)
 +
    {
 +
        $this->usuario = 'Usuario';
 +
    if($var == 'adios'){
 +
            //KumbiaPHP no mostrará nada
 +
            $this->render(null, null);
 +
           
 +
            //enrutamos a otro controller
 +
            return Router::route_to('controller: otro_controller');
 +
    }
 +
    }
 +
}
 +
</source>
  
 
== Logger ==
 
== Logger ==
Línea 291: Línea 699:
  
 
==Cache==
 
==Cache==
−
El componente cache fué mejorado y ahora posee una implementación estática, para hacer uso de la cache es necesario tener permisos de escritura en el directorio "cache". Los métodos de la clase Cache son los siguientes:
+
El componente cache fué mejorado y ahora posee una implementación utilizando los patrones de diseño factory y singleton, para hacer uso de la cache es necesario tener permisos de escritura en el directorio "cache" (para el caso de los manejadores "sqlite" y "file").  
 +
 
 +
Puedes obtener un driver de Cache utilizando el metodo '''driver''' que te proporciona la clase Cache.
 +
 
 +
===Cache::driver($driver=null)===
 +
Este metodo permite obtener un manejador de cache específico, si no se indica, se obtiene el manejador de cache por defecto indicado en el '''config.ini'''.
 +
 
 +
Ejemplos:
 +
 
 +
<source lang=php>
 +
// cache por defecto
 +
$data = Cache::driver()->get('data');
 +
 
 +
// manejador para memcache
 +
$data_memcache = Cache::driver('memcache')->get('data');
 +
 
 +
// manejador para cache con APC
 +
$data_apc = Cache::driver('APC')->get('data');
 +
</source>
  
−
===Cache::get($id, $group='default')===
+
 
 +
Todos los manejadores de cache comparten métodos comunes indicados através de la clase abstracta '''Cache''' he implementados especificamente en cada manejador, los metodos de los manejadores de cache son los siguientes:
 +
 
 +
===get($id, $group='default')===
 
Obtiene los datos cacheados. Los elementos cacheados pueden agruparse en grupos, lo cual permite evitar colisiones entre elementos cacheados con igual $id.
 
Obtiene los datos cacheados. Los elementos cacheados pueden agruparse en grupos, lo cual permite evitar colisiones entre elementos cacheados con igual $id.
  
Línea 299: Línea 728:
 
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
 
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
  
−
<pre>
+
<source lang=php>
−
$data = Cache::get('data');
+
$data = Cache::driver()->get('data');
−
</pre>
+
</source>
  
−
===Cache::save($value, $lifetime=null, $id=false, $group='default')===
+
===save($value, $lifetime=null, $id=false, $group='default')===
 
Guarda los datos a cachear.
 
Guarda los datos a cachear.
  
 
mixed '''$value''': valor a cachear (automaticamente es serializado antes de guardar)<br>
 
mixed '''$value''': valor a cachear (automaticamente es serializado antes de guardar)<br>
−
string '''$lifetime''': tiempo de vida de los datos (formato de [http://fr.php.net/manual/es/function.strtotime.php strtotime]), si es null, los datos no expiran nunca.<br>
+
string '''$lifetime''': tiempo de vida de los datos (formato de [http://es2.php.net/manual/en/function.strtotime.php strtotime]), si es null, los datos no expiran nunca.<br>
 
string '''$id''': identificador del elemento a almacenar, si no se especifica, se toma el id y grupo del ultimo get efectuado<br>
 
string '''$id''': identificador del elemento a almacenar, si no se especifica, se toma el id y grupo del ultimo get efectuado<br>
 
string '''$group''': grupo al cual pertenece
 
string '''$group''': grupo al cual pertenece
  
−
<pre>
+
<source lang=php>
−
<?php if($data = Cache::get('data')): ?>
+
<?php if($data = Cache::driver()->get('data')): ?>
 
     <?php echo $data ?>
 
     <?php echo $data ?>
 
<?php else: ?>
 
<?php else: ?>
Línea 319: Línea 748:
 
     <?php  
 
     <?php  
 
         $data = ob_get_contents();
 
         $data = ob_get_contents();
−
         Cache::save($data, '+21 days');
+
         Cache::driver()->save($data, '+21 days');
 
         ob_end_flush();         
 
         ob_end_flush();         
 
     ?>
 
     ?>
 
<?php endif; ?>     
 
<?php endif; ?>     
−
</pre>
+
</source>
 +
 
  
−
<pre>
+
<source lang=php>
−
Cache::save('hola', null, 'data');
+
Cache::driver()->save('hola', null, 'data');
−
$data = Cache::get('hola');
+
$data = Cache::driver()->get('data');
−
</pre>
+
</source>
  
−
Nota: el grupo "kumbia.*" esta reservado para el uso exclusivo de Kumbia.
+
Nota: el grupo "kumbia.*" esta reservado para el uso exclusivo de KumbiaPHP.
  
−
===Cache::start($lifetime, $id, $group='default')===
+
===start($lifetime, $id, $group='default')===
−
Cachea capturando el buffer de salida, se debe utilizar en conjunto a "Cache::end()" para terminar la captura, si el elemento esta cacheado entonces lo retorna.
+
Cachea capturando el buffer de salida, se debe utilizar en conjunto a "end()" para terminar la captura, si el elemento esta cacheado entonces lo retorna.
  
 
string '''$lifetime''': tiempo de vida de los datos (formato de strtotime), si es null, los datos no expiran nunca.<br>
 
string '''$lifetime''': tiempo de vida de los datos (formato de strtotime), si es null, los datos no expiran nunca.<br>
Línea 339: Línea 769:
 
string '''$group''': grupo al cual pertenece
 
string '''$group''': grupo al cual pertenece
  
−
<pre>
+
<source lang=php>
−
<?php if($data = Cache::start('+1 day','data')): ?>
+
<?php if($data = Cache::driver()->start('+1 day','data')): ?>
 
     <?php echo $data ?>
 
     <?php echo $data ?>
 
<?php else: ?>
 
<?php else: ?>
 
     Hola
 
     Hola
−
     <?php Cache::end()?>
+
     <?php Cache::driver()->end()?>
 
<?php endif; ?>     
 
<?php endif; ?>     
−
</pre>
+
</source>
  
−
===Cache::end()===
+
===end()===
 
Guarda los datos en la cache tomados del buffer de salida.
 
Guarda los datos en la cache tomados del buffer de salida.
  
−
===Cache::clean($group=false)===
+
===clean($group=false)===
 
Limpia la cache. Si no se indica grupo limpia toda la cache.
 
Limpia la cache. Si no se indica grupo limpia toda la cache.
  
−
<pre>
+
<source lang=php>
−
Cache::clean('default');
+
Cache::driver()->clean('default');
−
</pre>
+
</source>
  
−
===Cache::remove($id, $group='default')===
+
===remove($id, $group='default')===
 
Elimina un elemento específico de la cache
 
Elimina un elemento específico de la cache
  
−
<pre>
+
<source lang=php>
−
Cache::remove('data');
+
Cache::driver()->remove('data');
−
</pre>
+
</source>
−
 
 
−
===Cache::active($active)===
 
−
Activa el uso de la cache
 
−
 
 
−
<pre>
 
−
Cache::active(true);
 
−
</pre>
 
  
 
==Cacheo automático de views y templates==
 
==Cacheo automático de views y templates==
Línea 394: Línea 817:
 
Ahora se ha definido una forma concreta para el paso de parámetros en los validadores y asimismo se adicionaron parámetros para personalizar los mensajes de error.
 
Ahora se ha definido una forma concreta para el paso de parámetros en los validadores y asimismo se adicionaron parámetros para personalizar los mensajes de error.
  
−
<pre>
+
<source lang=php>
 
class Model extends ActiveRecord
 
class Model extends ActiveRecord
 
{
 
{
Línea 403: Línea 826:
 
     }
 
     }
 
}
 
}
−
</pre>
+
</source>
  
 
NOTA: El método '''initialize''' hace las veces de constructor y se ejecuta siempre por eso nuestros validadores deberían estar alli...
 
NOTA: El método '''initialize''' hace las veces de constructor y se ejecuta siempre por eso nuestros validadores deberían estar alli...
Línea 415: Línea 838:
 
Parametros con nombre:<br>
 
Parametros con nombre:<br>
 
message: mensaje a mostrar<br>
 
message: mensaje a mostrar<br>
−
field: nombre del campo
+
field: nombre del campo (muestra un mensaje con el valor del campo)
 +
 
 +
'''Nota:''' Solo un parametro con nombre se muestra a la vez, teniendo prioridad el parametro con nombre '''message'''.
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_uniqueness_of('cedula', 'message: La cedula ya existe')
 
$this->validates_uniqueness_of('cedula', 'message: La cedula ya existe')
 
$this->validates_uniqueness_of('cedula', array('message'=>'La cedula ya existe'))
 
$this->validates_uniqueness_of('cedula', array('message'=>'La cedula ya existe'))
−
</pre>
+
...
 +
</source>
 +
 
 +
o
 +
 
 +
<source lang=php>
 +
...
 +
$this->validates_uniqueness_of('cedula', 'field: cedula')
 +
$this->validates_uniqueness_of('cedula', array('field'=>'cedula'))
 +
...
 +
</source>
  
 
===validates_date_in($field, $params=array())===
 
===validates_date_in($field, $params=array())===
Línea 432: Línea 868:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_date_in('fecha', 'message: Fecha invalida')
 
$this->validates_date_in('fecha', 'message: Fecha invalida')
 
$this->validates_date_in('fecha', array('message'=>'Fecha invalida'))
 
$this->validates_date_in('fecha', array('message'=>'Fecha invalida'))
−
</pre>
+
...
 +
</source>
  
  
Línea 448: Línea 886:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_presence_of('fecha_opt', 'field: Fecha')
 
$this->validates_presence_of('fecha_opt', 'field: Fecha')
−
</pre>
+
...
 +
</source>
  
  
 
===validates_length_of($field, $max, $min=0, $params=array())===
 
===validates_length_of($field, $max, $min=0, $params=array())===
−
Valida que el campo no sea nulo
+
Valida el tamaño mínimo y máximo de caracteres permitidos en el campo
  
 
string '''$field''': campo a validar<br>
 
string '''$field''': campo a validar<br>
Línea 466: Línea 906:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_length_of('nombre', '25')
 
$this->validates_length_of('nombre', '25')
 
$this->validates_length_of('nombre', '25', 0,'too_long: Nombre muy largo')
 
$this->validates_length_of('nombre', '25', 0,'too_long: Nombre muy largo')
 
$this->validates_length_of('nombre', '25', 0,array('too_long'=>'Nombre muy largo'))
 
$this->validates_length_of('nombre', '25', 0,array('too_long'=>'Nombre muy largo'))
−
</pre>
+
...
−
 
+
</source>
  
 
===validates_inclusion_in($field, $list, $params=array())===
 
===validates_inclusion_in($field, $list, $params=array())===
Línea 484: Línea 925:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_inclusion_in('seleccion', array('a', 'b'))
 
$this->validates_inclusion_in('seleccion', array('a', 'b'))
−
</pre>
+
...
 +
</source>
  
  
Línea 500: Línea 943:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_exclusion_of('seleccion', array('a', 'b'))
 
$this->validates_exclusion_of('seleccion', array('a', 'b'))
−
</pre>
+
...
 +
</source>
  
 
===validates_format_of($field, $pattern, $params=array())===
 
===validates_format_of($field, $pattern, $params=array())===
Línea 515: Línea 960:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_format_of('seleccion', '/^\d{3}[A-Z]/')
 
$this->validates_format_of('seleccion', '/^\d{3}[A-Z]/')
−
</pre>
+
...
 +
</source>
  
−
===validates_format_of($field, $pattern, $params=array())===
 
−
Valida que el campo coincida con el patron indicado
 
−
 
−
string '''$field''': campo a validar<br>
 
−
array '''$pattern''': expresion regular compatible con perl<br>
 
−
array '''$params''': array de parametros con nombre
 
−
 
−
Parametros con nombre:<br>
 
−
message: mensaje a mostrar<br>
 
−
field: nombre del campo
 
−
 
−
<pre>
 
−
$this->validates_format_of('seleccion', '/^\d{3}[A-Z]/')
 
−
</pre>
 
  
  
Línea 545: Línea 978:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_numericality_of('cedula')
 
$this->validates_numericality_of('cedula')
−
</pre>
+
...
 +
</source>
  
  
Línea 560: Línea 995:
 
field: nombre del campo
 
field: nombre del campo
  
−
<pre>
+
<source lang=php>
 +
...
 
$this->validates_email_in('email')
 
$this->validates_email_in('email')
−
</pre>
+
...
 +
</source>
  
 
==Modos de una Aplicación==
 
==Modos de una Aplicación==
Línea 568: Línea 1005:
  
 
===Production===
 
===Production===
−
Indicando en el config.ini '''"production = On"''', se entra en el modo de producción, en este la cache de kumbiaphp framework esta activada y se cachea información necesaria para agilizar la carga de la aplicación tal como la metadata de la base datos (información de tablas y campos), asimismo las vistas que el usuario desee cachear.  
+
Indicando en el config.ini '''"production = On"''', se entra en el modo de producción, en este la cache de kumbiaphp framework esta activada y se cachea información necesaria para agilizar la carga de la aplicación tal como la metadata de la base datos (información de tablas y campos), asimismo las vistas que el usuario desee cachear.
  
 
===Development===
 
===Development===
−
Indicando en el config.ini '''"production = Off"''', se entra en el modo de desarrollo, en este la cache de kumbiaphp framework esta desactivada y cualquier cambio que se haga en los campos y tablas de la base de datos (adición de campos, etc), vistas de la aplicación que se cacheen, surtirán efecto inmediatamente.
+
Indicando en el config.ini '''"production = Off"''', se entra en el modo de desarrollo, en este la cache de [http://www.kumbiaphp.com KumbiaPHP] esta desactivada y cualquier cambio que se haga en los campos y tablas de la base de datos (adición de campos, etc), vistas de la aplicación que se cacheen, surtirán efecto inmediatamente.
  
−
La cache de kumbiaphp framework se puede activar nuevamente utilizando el método active de la clase Cache.
+
La para utilizar manualmente la cache de [http://www.kumbiaphp.com KumbiaPHP] debes cargarla explicitamente indicándola en el boot.ini o utilizando el componente '''Load'''.
  
−
<pre>
+
<source lang=php>
−
Cache::active(true);
+
Load::lib('cache');
−
</pre>
+
</source>
  
−
'''Cuando se cambia de modo, es necesario limpiar la cache que kumbiaphp framework ha creado para que se pueda renovar los nuevos metadatos y vistas, esto se hace simplemente eliminando el contenido del directorio de cache para la aplicación, en el caso de la aplicación por defecto sería el directorio cache/default/.'''
+
'''Cuando se cambia de modo, es necesario limpiar la cache que [http://www.kumbiaphp.com KumbiaPHP] ha creado para que se pueda renovar los nuevos metadatos y vistas, esto se hace simplemente eliminando el contenido del directorio de cache para la aplicación.'''
  
 
== Carga selectiva de modelos ==
 
== Carga selectiva de modelos ==
 
En la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) se puede cargar solo los modelos que el controlador requiera, de esa manera se optimiza los procesos de la aplicación y consume menos recursos. Para utilizar la carga selectiva, es conveniente deshabilitar la autocarga de modelos en el config.ini con '''"models_autoload = Off"'''.
 
En la [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) se puede cargar solo los modelos que el controlador requiera, de esa manera se optimiza los procesos de la aplicación y consume menos recursos. Para utilizar la carga selectiva, es conveniente deshabilitar la autocarga de modelos en el config.ini con '''"models_autoload = Off"'''.
  
−
Para cargar los modelos en el controlador se utiliza el método '''"load_models"'''
+
==== Load::models($model) ====
 +
Carga los modelos, se pueden cargar varios de manera simultánea indicándolos como argumentos múltiples del método o mediante un array. Asimismo se pueden cargar directorios completos de modelos.
 +
 
 +
Si la carga se efectúa en el controlador, automaticamente una instancia del modelo es cargada en un atributo del controlador correspondiente al nombre del modelo en notación camelcase.
  
−
<pre>
+
''NOTA: El parámetro '''$model''' puede ser un directorio y/o archivo, en el caso de ser el archivo debe ser igual al nombre del mismo.''
−
class UsuarioController extends ApplicationController {
+
 
 +
<source lang=php >
 +
class UsuarioController extends ApplicationController  
 +
{
 
   public function index()
 
   public function index()
 
   {
 
   {
 
     //Se cargan los modelos Usuario y DatosPersonales
 
     //Se cargan los modelos Usuario y DatosPersonales
−
     $this->load_models('Usuario', 'DatosPersonales');
+
     //usuario.php y datos_personales.php
 +
    Load::models('usuario', 'datos_personales');
 
   }
 
   }
 
}
 
}
−
</pre>
+
</source>
  
−
Asimismo se puede indicar con el atributo de controlador $models.
+
Asimismo se puede indicar con el atributo de controlador $models y estos serán cargados en cada acción.
  
−
<pre>
+
<source lang=php >
 
class UsuarioController extends ApplicationController {
 
class UsuarioController extends ApplicationController {
  
 
   //Se cargan los modelos Usuario y DatosPersonales
 
   //Se cargan los modelos Usuario y DatosPersonales
−
   public $models = array('Usuario', 'DatosPersonales');
+
   public $models = array('usuario', 'datos_personales');
 +
 
 +
  public function index()
 +
  {}
 +
}
 +
</source>
 +
 
 +
Cargando un directorio de modelos
 +
 
 +
<source lang=php >
 +
class UsuarioController extends ApplicationController {
 
    
 
    
 
   public function index()
 
   public function index()
 
   {
 
   {
 +
    /** se cargan los modelos en:
 +
    * mi_app/models/dir/*
 +
    * mi_app/models/dir2/model1.php
 +
    * mi_app/models/model2.php
 +
    */
 +
    Load::models('dir', 'dir2/model1', 'model2')
 
   }
 
   }
 +
 +
}
 +
</source>
 +
 +
==== Load::model($model) ====
 +
Obtiene una instancia del modelo indicado, esto permite hacer uso de modelos en cualquier lugar de la aplicación de manera intuitiva.
 +
 +
'''NOTA: el nombre del modelo que recibe como parámetro este método debe ser pasado en notación smallcase'''
 +
 +
<source lang=php >
 +
/**
 +
* Construye una lista desplegable para países
 +
**/
 +
function pais_select($id, $value=null) {
 +
    //carga el modelo models/pais.php
 +
    $Pais = Load::model('pais');
 +
 +
    $code = "<select name=\"$id\" id=\"$id\">";
 +
    foreach($Pais->find() as $pais) {
 +
        $code .= "<option value=\"$pais->id\"";
 +
        if($pais->id == $value) {
 +
            $code .= ' selected="selected"';
 +
        }
 +
        $nombre = htmlspecialchars($pais->nombre);
 +
        $code .= ">$nombre</option>";
 +
    }
 +
    $code .= '</select>';
 +
 +
    return $code;
 
}
 
}
−
</pre>
+
</source>
 +
 
 +
Uso avanzado...
 +
 
 +
<source lang=php >
 +
...
 +
    //busca el país con ID 1
 +
    Load::model('pais')->find(1);
 +
 
 +
    //carga el modelo ubicado en models/dir/user.php
 +
    Load::model('dir/user')->find();
 +
 
 +
    //carga el modelo ubicado en models/user_group.php
 +
    Load::model('user_group')->find();
 +
 
 +
...
 +
</source>
  
 
== Pages Controller ==
 
== Pages Controller ==
Línea 636: Línea 1141:
 
   
 
   
 
Ademas se pueden utilizar los Helpers y Partials dentro de estos views.
 
Ademas se pueden utilizar los Helpers y Partials dentro de estos views.
−
<pre>
+
<source lang=php>
 
<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>
 
<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>
−
</pre>
+
</source>
 
Mostrará un enlace que al hacer clic ira a dominio.com/pages/show/aviso
 
Mostrará un enlace que al hacer clic ira a dominio.com/pages/show/aviso
−
 
−
 
  
 
== Nuevo Helper ==
 
== Nuevo Helper ==
Línea 661: Línea 1164:
 
El componente Filter, es un componente que permite filtrar y validar datos de una manera intuitiva, facil y simple.
 
El componente Filter, es un componente que permite filtrar y validar datos de una manera intuitiva, facil y simple.
  
−
Filter dispone de un método estático "Filter::get" el cuál permite filtrar el elemento indicado.
+
Filter dispone de una serie de métodos estaticos que le permitirán filtrar los elementos indicados.
  
 
=== Filter::get($s, $options=array()) ===
 
=== Filter::get($s, $options=array()) ===
  
−
'''$s (string, array, object)''': array, objeto, o string a filtrar.
+
'''$s (mixed)''': el valor a filtrar.
 
<br>
 
<br>
 
'''$options (array)''': array de configuración del filtro.
 
'''$options (array)''': array de configuración del filtro.
  
−
Los filtros se aplican de manera recursiva en los arrays y objetos.
+
Los filtros se aplican al valor indicado.
  
 
Ejemplo:
 
Ejemplo:
−
<pre>
+
<source lang=php>  
 
$value = Filter::get($s, 'htmlspecialchars', array('charset' => 'UTF-8'));
 
$value = Filter::get($s, 'htmlspecialchars', array('charset' => 'UTF-8'));
−
</pre>
+
</source>
  
 
Asimismo se pueden aplicar filtros en cadena.
 
Asimismo se pueden aplicar filtros en cadena.
−
<pre>
+
<source lang=php>  
 
$value = Filter::get($s, 'trim', 'addslashes');
 
$value = Filter::get($s, 'trim', 'addslashes');
−
</pre>
+
</source>
 +
 
 +
Los filtros en cadena no aceptan opciones de configuración, por lo tanto toman las opciones por defecto.
 +
 
 +
=== Filter::get_array($array, $options=array()) ===
 +
 
 +
'''$array (array)''': un array de elementos a filtrar.
 +
<br>
 +
'''$options (array)''': array de configuración del filtro.
 +
 
 +
Los filtros se aplican a cada elemento del array.
 +
 
 +
Ejemplo:
 +
<source lang=php>
 +
$array = Filter::get_array(array('<b>Hola</b>', '<b>Adios</b>'), 'htmlspecialchars', array('charset' => 'UTF-8'));
 +
</source>
 +
 
 +
 
 +
<source lang=php>
 +
$array = Filter::get_array(array('saludo' => '<b>Hola</b>'), 'htmlspecialchars', array('charset' => 'UTF-8'));
 +
</source>
 +
 
 +
=== Filter::get_object($object, $options=array()) ===
 +
 
 +
'''$object (object)''': objeto a filtrar.
 +
<br>
 +
'''$options (array)''': array de configuración del filtro.
 +
 
 +
Los filtros se aplican a cada atributo del objeto.
  
−
Los filtros en cadena no aceptan opciones de configuración, tomando las opciones por defecto.
+
Ejemplo:
 +
<source lang=php>
 +
$object = Filter::get_object($usuario, 'htmlspecialchars', array('charset' => 'UTF-8'));
 +
</source>
  
 
=== Filtros ===
 
=== Filtros ===
Línea 689: Línea 1223:
 
Escapa las comillas dobles y simples en una cadena de texto.
 
Escapa las comillas dobles y simples en una cadena de texto.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('hola "gente"', 'addslashes');
 
$value = Filter::get('hola "gente"', 'addslashes');
−
</pre>
+
</source>
  
 
==== alnum ====
 
==== alnum ====
 
Filtra la cadena eliminando los caracteres que no son alfanumericos o espacios.
 
Filtra la cadena eliminando los caracteres que no son alfanumericos o espacios.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('hola "gente112"', 'alnum');
 
$value = Filter::get('hola "gente112"', 'alnum');
−
</pre>
+
</source>
  
 
==== alpha ====
 
==== alpha ====
 
Filtra la cadena eliminando los caracteres que no son alfabéticos o espacios.
 
Filtra la cadena eliminando los caracteres que no son alfabéticos o espacios.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('hola "gente112"', 'alpha');
 
$value = Filter::get('hola "gente112"', 'alpha');
−
</pre>
+
</source>
  
 
==== date ====
 
==== date ====
 
Verifica que sea una fecha valida en el formato YYYY-MM-DD.
 
Verifica que sea una fecha valida en el formato YYYY-MM-DD.
  
−
<pre>
+
<source lang=php>
−
$value = Filter::date('2009-10-20', 'date');
+
if(Filter::get($s, 'date')) {
−
</pre>
+
    ...
 +
}
 +
</source>
  
 
==== digits ====
 
==== digits ====
−
Filtra la cadena eliminando los caracteres que nos son digitos.
+
Filtra la cadena eliminando los caracteres que no son digitos.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('hola "gente112"', 'digits');
 
$value = Filter::get('hola "gente112"', 'digits');
−
</pre>
+
</source>
  
 
==== htmlentities ====
 
==== htmlentities ====
 
Escapa los elementos del lenguaje html con sus correspondientes entidades.
 
Escapa los elementos del lenguaje html con sus correspondientes entidades.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('<p>"hola"</p>', 'htmlentities');
 
$value = Filter::get('<p>"hola"</p>', 'htmlentities');
−
</pre>
+
</source>
  
 
'''Opciones:'''<br>
 
'''Opciones:'''<br>
Línea 734: Línea 1270:
 
Escapa caracteres especial de html.
 
Escapa caracteres especial de html.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('<p>"hola"</p>', 'htmlspecialchars');
 
$value = Filter::get('<p>"hola"</p>', 'htmlspecialchars');
−
</pre>
+
</source>
  
 
'''Opciones:'''<br>
 
'''Opciones:'''<br>
Línea 744: Línea 1280:
 
Convierte un valor a tipo entero.
 
Convierte un valor a tipo entero.
  
−
<pre>
+
<source lang=php>
 
$value = Filter::get('1.2', 'int');
 
$value = Filter::get('1.2', 'int');
−
</pre>
+
</source>
  
 
==== ipv4 ====
 
==== ipv4 ====
 
Verifica si la cadena tiene el formato ipv4.
 
Verifica si la cadena tiene el formato ipv4.
  
−
<pre>
+
<source lang=php>
 
if(Filter::get($s, 'ipv4')) {
 
if(Filter::get($s, 'ipv4')) {
 
     ...
 
     ...
 
}
 
}
−
</pre>
+
</source>
 +
 
 +
==== lower ====
 +
Convierte una cadena de texto a minusculas.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('TEXTO', 'lower');
 +
</source>
 +
 
 +
==== md5 ====
 +
Calcula el hash md5 para el valor indicado.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('TEXTO', 'md5', array('binary' => true));
 +
</source>
 +
 
 +
'''Opciones:'''<br>
 +
'''binary:''' indica si se usa modo binario
 +
 
 +
==== nl2br ====
 +
Convierte el caracter de nueva linea a "&lt;br&gt;".
 +
 
 +
<source lang=php>
 +
$value = Filter::get('TEXTO\nTexto2', 'nl2br');
 +
</source>
 +
 
 +
==== numeric ====
 +
Filtra una cadena solo permitiendo valores numericos.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('a1.2', 'numeric');
 +
</source>
 +
 
 +
==== stripslashes ====
 +
Filtra una cadena haciendo la operación inversa a addslashes.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('\"Hola\"', 'stripslashes');
 +
</source>
 +
 
 +
==== stripspace ====
 +
Elimina los espacios.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('  Hola  ', 'stripspace');
 +
</source>
 +
 
 +
==== striptags ====
 +
Elimina las etiquetas HTML.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('<p>Hola</p>', 'striptags');
 +
</source>
 +
 
 +
==== trim ====
 +
Elimina los espacios en blanco a la izquiera y a la derecha.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('  Hola  ', 'trim');
 +
</source>
 +
 
 +
==== upper ====
 +
Convierte la cadena a mayúsculas.
 +
 
 +
<source lang=php>
 +
$value = Filter::get('hola', 'upper');
 +
</source>
  
 
=== Extendiendo el componente Filter ===
 
=== Extendiendo el componente Filter ===
 +
El componente Filter puede extenderse permitiendo al usuario crear sus propios filtros, para este fin el usuario debe hacer uso de la interface "FilterInterface", la cual se describe a continuación:
 +
 +
<source lang=php>
 +
interface FilterInterface
 +
{
 +
    /**
 +
    * Metodo para ejecutar el filtro
 +
    *
 +
    * @param string $s cadena a filtrar
 +
    * @param array $options opciones para el filtro
 +
    **/
 +
    public static function execute ($s, $options);
 +
}
 +
</source>
 +
 +
Los filtros de usuario deben ubicarse en el directorio "app/extensions/filters/".
 +
 +
Por convenio la clase que corresponde al filtro debe llevar el sufijo "Filter" y el archivo debe llamarse igual que la clase pero en notación smallcase.
 +
 +
'''Ejemplo:'''
 +
Un filtro que permite obtener la extension de un archivo, pasandole como valor el nombre del archivo.
 +
 +
app/extensions/filters/file_extension_filter.php
 +
<source lang=php >
 +
/**
 +
* Filtro para obtener la extensión de un archivo
 +
**/
 +
class FileExtensionFilter implements FilterInterface
 +
{
 +
  public static function execute($s, $options=array())
 +
  {
 +
      return strchr($s,".");
 +
  }
 +
}
 +
</source>
 +
 +
Y se utilizaría de la siguiente manera:
 +
<source lang=php>
 +
$ext = Filter::get('/home/yo/prueba.php', 'file_extension');
 +
</source>
 +
 +
=== Filtrando datos enviados en el Request ===
 +
El controller dispone de ciertas facilidades, en sus métodos: post, get y request, se puede indicar diversos filtros para aplicar al valor recibido.
 +
 +
Ejemplo:
 +
<source lang=php >
 +
class UsuarioController extends ApplicationController
 +
{
 +
    public function save()
 +
    {
 +
        if($this->has_post('usuario')) {
 +
            $usuario = new Usuario($this->post('usuario', 'trim'));
 +
            $usuario->save();
 +
        }
 +
    }
 +
}
 +
</source>
 +
 +
En el ejemplo anterior, los datos enviados en el array de campos "usuario", son filtrados con un trim, cargados por el constructor del objecto ActiveRecord y posteriormente se guarda en la base de datos.
 +
 +
== Carga Selectiva, Inyección de Dependencias y el Componente Load ==
 +
El componente '''Load''', esta diseñado especialmente para satisfacer las necesidades de Carga Selectiva e Inyección de Dependencias, con este componente disponemos de los elementos de [http://www.kumbiaphp.com KumbiaPHP Framework] (vendors, libraries y models) donde así lo necesite nuestra aplicación.
 +
 +
=== Load::lib($lib) ===
 +
 +
El método library del componente Load nos permite cargar dinámicamente aquellas clases que tengamos definidas en el dir '''app/libs/''' a fin de utilizarlas en los controladores(controllers) y/o Modelos(models).
 +
 +
<source lang=php >
 +
class UsuarioController extends ApplicationController
 +
{
 +
  public function index()
 +
  {
 +
    //Se carga la librería app/libs/my_util.php
 +
    Load::lib('my_util');
 +
  }
 +
}
 +
</source>
 +
 +
'''NOTA: Por convención del método Load::lib($lib) busca primero en el directorio app/libs/ y en caso de no encontrar la biblioteca requerida pasaría a buscar en el directorio core/libs/, por lo que podríamos cargar dinámicamente la librería Auth del core de la siguiente forma'''
 +
 +
<source lang=php >
 +
class UsuarioController extends ApplicationController
 +
{
 +
  public function index()
 +
  {
 +
    //Se carga core/libs/auth/auth.php, siempre que no exista algún archivo
 +
    //con el mismo nombre en app/libs/ ya que KumbiaPHP da prioridad a tu app sobre el core.
 +
    Load::lib('auth');
 +
  }
 +
}
 +
</source>
 +
 +
==Persistencia de Datos en el Controller==
 +
En ocasiones se necesita la persistencia de algunas variables en la ejecución de nuestros controladores, lo mas común en estos casos es guardar consultas avanzadas o bien pudiera los articulos de carro de compras. Para estos casos y mas que se puedan presentar [http://www.kumbiaphp.com KumbiaPHP] hace persistente las variables para el controlador dependiendo el caso.
 +
 +
Para suplir esta necesidad se incoporan los siguientes métodos.
 +
 +
<source lang=php>
 +
...
 +
//hace persistente la variable $data
 +
$this->set_persistent('data', 'valor');
 +
...
 +
</source>
 +
 +
 +
<source lang=php>
 +
...
 +
//recupera la persistencia de la variable $data
 +
$this->get_persistent('data');
 +
...
 +
</source>
 +
 +
 +
<source lang=php>
 +
...
 +
//destruye la persistencia de la variable $data
 +
$this->destroy_persistent('data');
 +
...
 +
</source>
 +
 +
==Session==
 +
En la extensions ''Session'' se quitan dos métodos que estaban descontinuado ('''deprecated''') los cuales son:
 +
* set_data()
 +
* get_data()
 +
 +
Quedando la extensions Session con los siguientes métodos para el manejo de la sessiones.
 +
 +
===set($index, $value, $namespace='default')===
 +
Crear o especifica el valor para un indice de la sesión actual.
 +
 +
<source lang=php>
 +
Session::set('usuario', 'Administrador');
 +
</source>
 +
 +
===get($index, $namespace='default')===
 +
Obtener el valor para un indice de la sesión actual.
 +
 +
<source lang=php>
 +
Session::get('usuario');//retorna 'Administrador'
 +
</source>
 +
 +
===delete($index, $namespace='default')===
 +
Elimina el valor para un indice de la sesión actual.
 +
 +
<source lang=php>
 +
Session::delete('usuario');
 +
</source>
 +
 +
===has($index, $namespace='default')===
 +
Verifica que este definido el indice en la sesión actual.
 +
 +
<source lang=php>
 +
Session::has('id_usuario');//retorna false.
 +
</source>
 +
 +
 +
NOTA: '''$namespace''' es un espacio individual en el cual se pueden contener las variables de sesión, permitiendo evitar colisiones con nombres de variables.
 +
 +
==Upload==
 +
Anteriormente en los controladores, estaban disponibles los métodos
 +
'''upload_file''' y '''upload_image''', ya que realmente el controlador no depende de estos para su correcto funcionamiento, estos fueron agrupados en el componente '''Upload'''. Este componente permite subir tanto archivos e imagenes al servidor donde se aloja tu aplicación.
 +
 +
=== Upload::file_in_path($name, $path, $new_name=null) ===
 +
Sube un archivo la ruta indicada.
 +
 +
$name (string): nombre del archivo en el formulario (se revisa en $_FILES)
 +
 +
$path (string): ruta donde se subira. Ejemplo: "/var/www/public/app/temp/files/"
 +
 +
$new_name (string): indica el nuevo nombre para el archivo, por defecto se toma el nombre original.
 +
 +
<source lang=php>
 +
...
 +
Upload::file_in_path('archivo', APP_PATH . 'temp/mis_archivos/');
 +
...
 +
</source>
 +
 +
 +
=== Upload::file($name, $new_name=null) ===
 +
Sube un archivo al directorio público "files/upload".
 +
 +
$name (string): nombre del archivo en el formulario
 +
 +
$new_name (string): indica el nuevo nombre para el archivo
 +
 +
<source lang=php>
 +
...
 +
Upload::file('archivo');
 +
...
 +
</source>
 +
 +
 +
=== Upload::image($name, $new_name=null) ===
 +
Sube una imagen al directorio público "img/upload".
 +
 +
$name (string): nombre del archivo en el formulario
 +
 +
$new_name (string): indica el nuevo nombre para el archivo
 +
 +
<source lang=php>
 +
...
 +
Upload::image('archivo');
 +
...
 +
</source>
 +
 +
==Partials de Paginación==
 +
Como complemento para el paginador de ActiveRecord, através de vistas parciales se implementan los tipos de vistas de paginación más comunes, estos se ubican en el directorio "core/views/partials/paginators" y estas en capacidad de personalizarlos en tu aplicación aprovechando las características de renderizado de vistas parciales.
 +
 +
=== Classic ===
 +
[[Archivo:Paginado classic.JPG|thumb|right|Resultado Final]]
 +
 +
 +
Vista de paginación clásica.
 +
 +
Parametros de configuración:
 +
 +
'''page:''' objeto obtenido al invocar al paginador.
 +
 +
'''show:''' número de paginas que se mostraran en el paginador, por defecto 10.
 +
 +
'''url:''' url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina.
 +
 +
 +
<source lang=php>
 +
View::partial('paginators/classic', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))
 +
</source>
 +
 +
=== Digg ===
 +
Vista de paginación estilo digg.
 +
 +
Parametros de configuración:
 +
 +
'''page:''' objeto obtenido al invocar al paginador.
 +
 +
'''show:''' número de paginas que se mostraran en el paginador, por defecto 10.
 +
 +
'''url:''' url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina.
 +
 +
 +
<source lang=php>
 +
View::partial('paginators/digg', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))
 +
</source>
 +
 +
 +
=== Extended ===
 +
[[Archivo:paginado_extended.JPG|thumb|right|Resultado Final]]
 +
 +
 +
 +
Vista de paginación extendida.
 +
 +
Parametros de configuración:
 +
 +
'''page:''' objeto obtenido al invocar al paginador.
 +
 +
'''url:''' url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina.
 +
 +
 +
<source lang=php>
 +
View::partial('paginators/extended', false, array('page' => $page, 'url' => 'usuario/lista'))
 +
</source>
 +
 +
=== Punbb ===
 +
Vista de paginación estilo punbb.
 +
 +
Parametros de configuración:
 +
 +
'''page:''' objeto obtenido al invocar al paginador.
 +
 +
'''show:''' número de paginas que se mostraran en el paginador, por defecto 10.
 +
 +
'''url:''' url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina.
 +
 +
 +
<source lang=php>
 +
View::partial('paginators/punbb', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))
 +
</source>
 +
 +
 +
=== Simple ===
 +
[[Archivo:paginado_simple.JPG|thumb|right|Resultado Final]]
 +
 +
 +
Vista de paginación simple.
 +
 +
 +
Parametros de configuración:
 +
 +
'''page:''' objeto obtenido al invocar al paginador.
 +
 +
'''url:''' url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina.
 +
 +
 +
 +
<source lang=php>
 +
View::partial('paginators/simple', false, array('page' => $page, 'url' => 'usuario/lista'))
 +
</source>
 +
 +
=== Ejemplo de uso ===
 +
 +
Supongamos que queremos paginar una lista de usuarios.
 +
 +
Para el modelo '''Usuario''' en '''models/usuario.php''':
 +
 +
<source lang=php>
 +
<?php
 +
class Usuario extends ActiveRecord
 +
{
 +
    /**
 +
    * Muestra los usuarios de cinco en cinco utilizando paginador
 +
    *
 +
    * @param int $page
 +
    * @return object
 +
    **/
 +
    public function ver($page=1)
 +
    {
 +
        return $this->paginate("page: $page", 'per_page: 5');
 +
    }
 +
}
 +
?>
 +
</source>
 +
 +
 +
Para el controlador '''UsuarioController''' en '''controllers/usuario_controller.php''':
 +
 +
<source lang=php>
 +
<?php
 +
class UsuarioController extends ApplicationController
 +
{
 +
    public $models = array('usuario');
 +
 +
    /**
 +
    * Accion de paginacion
 +
    *
 +
    * @param int $page
 +
    **/
 +
    public function page($page=1)
 +
    {
 +
        $this->page = $this->Usuario->ver($page);
 +
    }
 +
}
 +
?>
 +
</source>
 +
 +
Y en la vista '''views/usuario/page.phtml'''
 +
 +
<source lang=php>
 +
<table>
 +
<tr>
 +
  <th>Id</th>
 +
  <th>Nombre</th>
 +
</tr>
 +
<?php foreach($page->items as $p): ?>
 +
<tr>
 +
  <td><?php echo $p->id; ?></td>
 +
  <td><?php echo $p->nombre; ?></td>
 +
</tr>
 +
<?php endforeach; ?>
 +
</table>
 +
 +
<?php View::partial('paginators/classic', false, array('page' => $page)); ?>
 +
</source>

Revisión actual del 12:32 9 nov 2021

{{#if:Information icon4.png |}}

{{#if:Information icon4.png

|}}
Information icon4.pngEste manual corresponde la versión 1.0 beta 1(Desaconsejada).
Se recomienda ver la última versión del Manual de KumbiaPHP 1.0		 Information icon4.png



Sumario

Introducción[editar]

En la versión 1.0(antigua 0.5.1) el enfoque primordial que ha considerado el Equipo de Desarrollo gira en torno al rendimiento del framework a nivel de velocidad y mantenibilidad del framework en este sentido hemos desacoplado el core de kumbiaphp framework en una nueva estructura obteniendo grandes resultados, de manera que las pruebas en base a esta versión nos indica que vamos en buen camino y ademas es bastante rápida con los cambios aplicados siempre con las mejores practicas de desarrollo.

Entre los componentes a nivel del core que hemos tocado para lograr nuestros objetivos se encuentran:

  1. Estructura de Directorios
  2. environment.ini
  3. Router
  4. Dispatcher
  5. Clase Kumbia
  6. Vistas
    1. Templates y Partials
    2. Helpers
  7. Logger
  8. config.ini
  9. Cache


Como se menciona al principio muchos de estos cambios son a nivel de core, esto significa que haremos pocas adecuaciones para migrar nuestras aplicaciones que hayan sido desarrolladas con la versión 0.5 para llevarlas hasta la versión 1.0(antigua 0.5.1), esto con la finalidad de garantizar compatibilidad entre versiones.

¿Por qué Spirit?[editar]

"Hemos llamado Spirit a la versión 1.0 porque Spirit, nuestro robot de Marte, tiene como características principales, fuerza y velocidad. Fuerza, porque su comunidad cada vez mas grande hace que nuestro framework KumbiaPHP avance a pasos agigantados. Velocidad, porque nuestro core team que pertenece a otro planeta, continuamente esta aplicando las ultimas técnicas y haciendo que otros framework's se queden atrás día a día. En definitiva Spirit, hace que tus aplicaciones vuelen, resulten mas atractivas y fáciles de mantener."

Migración Rápida[editar]

En esta sección se explica de forma rápida y sencilla como migrar nuestras aplicaciones de la versión 0.5 a la versión 1.0(antigua 0.5.1) en las próximas secciones se explican en detalle los cambios.

  • Con la nueva estructura de directorio migrar nuestras aplicaciones de la versión 0.5 es sumamente simple solo se ha copiar nuestra carpeta apps/default/ (donde estan los controllers, models, views, etc) hacia el directorio app/ de Nueva Estructura
  • En el Controlador los métodos initialize, finalize, before_filter y after_filter ahora son protected por motivos de seguridad.
  • Si has modificado el archivo views/index.phtml este fue ubicado en el directorio views/templates/default.phtml, es decir que le debes aplicar los cambios que quieras.
  • Sustituye la función content() por View::content() y render_partial() por View::partial().
  • Para inicializar tu aplicación se ha de utilizar el config/routes.ini agregando una regla de enrutamiento estático, por ejemplo:
;con esta regla cada vez que inicie la aplicación http://localhost/kumbia/ irá hacia un controlador

admin y una acción autenticar / = admin/autenticar

Esto sustituye editar el archivo apps/default/controllers/application.php en su acción init(), solo se ha de agregar en el routes.ini la ruta que hacemos en el método init()

  • Si en tus modelos utilizas el atributo $mode para establecer otros datos de conexión, debes reemplazarlo por $database, ver mas.
  • Si Cargas librerias vía boot.ini ahora se usa libs= en vez de extensions= Y también se quita el prefijo kumbia.

KumbiaPHP 0.5 

[modules]
extensions = kumbia.logger, kumbia.auth

KumbiaPHP 1.0 

[modules]
libs = logger, auth

Constante en KumbiaPHP[editar]

En la version 1.0 Spirit, se ha creado tres constantes cada cual cumple un objetivo especifico con el fin de brindar mayor flexibilidad al momento de manejar rutas (paths) en el framework.

APP_PATH[editar]

Constante que contiene la ruta absoluta al directorio donde se encuentra nuestra aplicación (app).

Ejemplo: 

 echo APP_PATH; //la salida es: /var/www/kumbiaphp/app/

Esta constante es posible utilizarla para incluir archivos que se encuentre bajo el arbol de directorio de la aplicación, por ejemplo imagine que quiere incluir un archivo que esta en el directio app/libs/test.php la forma de hacerlo seria. 

  include_once APP_PATH.'libs/test.php';

NOTA: siempre será mejor utilizar el Componente Load para incluir dependencias.

CORE_PATH[editar]

Constante que contiene la ruta absoluta al directorio donde se encuentra el core de KumbiaPHP.

Ejemplo: 

 echo CORE_PATH; //la salida es: /var/www/kumbiaphp/core/

Para incluir archivos que se encuentre bajo este arbol de directorio es el mismo procedimiento que se explico para la constante APP_PATH

NOTA: El core de KumbiaPHP en la version 1.0 esta totalmente desacoplado del directorio de la aplicación. Ventajas de la Estructura de directorio

PUBLIC_PATH[editar]

Constante que contiene la URL para el navegador (browser) y apunta a app/public/ para enlazar imágenes, CSS, JavaScript y todo lo que sea ruta para browser.

Ejemplo: 

 //Genera un link que ira al controller: controller y action: action
 <a href="<?php echo PUBLIC_PATH ?>controller/action/" title="Mi Link">Mi Link</a> 

 //Enlaza una imagen que esta en public/img/imagen.jpg
 <img src="<?php echo PUBLIC_PATH ?>img/imagen.jpg" alt="Una Imagen" /> 

 //Enlaza el archivo CSS en public/css/style.css
 <link rel="stylesheet" type="text/css" href="<?php echo PUBLIC_PATH ?>css/style.css"/>

NOTA: siempre será mejor hacer uso de los helpers

Nueva Estructura de Directorios[editar]

En la versión de KumbiaPHP se incorpora la siguiente estructura de directorios, a continuación se detallan los elementos mas relevantes: 

spirit/
|-- app
|   |-- application.php
|   |-- config
|   |-- controllers
|   |-- extensions
|   |   |-- filters
|   |   |-- helpers
|   |   `-- scaffolds
|   |-- index.php
|   |-- libs
|   |-- locale
|   |-- model_base.php
|   |-- models
|   |-- public
|   |-- temp
|   `-- views
|       |-- errors
|       |-- pages
|       |-- partials
|       `-- templates
|-- core
|   |-- console
|   |-- docs
|   |-- extensions
|   |   |-- helpers
|   |   `-- scaffolds
|   |-- kumbia
|   |-- libs
|   |-- tests
|   |-- vendors
|   `-- views
|       |-- errors
|       |-- partials
|       `-- templates

Anteriormente KumbiaPHP utilizaba un fichero index.php el cual servía para enrutar a cada aplicación utilizando inversión de control, esto erá poco flexible y resultaba en un consumo inadecuado de recursos, por lo tanto en esta nueva versión se preparó una nueva estructura de directorios donde cada aplicación posee un directorio independiente con su index.php (Front Controller) correspondiente el cual se encarga de cargar las librerías del framework.

Copiando el directorio app, tenemos toda la estructura para un nueva aplicación. Ya que podemos tener tantas aplicaciones como necesitemos con un único core.

Asimismo el núcleo, las extensiones de KumbiaPHP y otras herramientas que utilizarán las aplicaciones de manera global fueron agrupadas en el directorio core.

Ventajas de esta nueva estructura de directorios[editar]

  • Mayor Velocidad :-)
  • Cada aplicación tiene su propio front controller (index.php)
  • Independencia total de nuestra aplicación respecto al core del framework.
  • Cada aplicación tendrá sus propios directorios (public, temp, libraries, etc). En versiones anteriores si se tenia 40 aplicaciones significaba que todo iba al mismo public (css, img, js, etc).
  • En cada actualización de KumbiaPHP, sólo se ha de pasar la carpeta de tu aplicación ("app") a la nueva versión de kumbiaPHP Framework y ya tendremos la última versión del Framework.

Explicando dir app[editar]

Este será el directorio sobre el cual trabajamos el 90% mientras desarrollamos nuestra aplicación. A continuación se explica en detalle cada uno de los directorios disponible para cada aplicación.

Directorio Descripción
config Archivos de configuración de nuestra aplicación (config.ini, routes.ini, databases.ini y boot.ini)
controllers Estan agrupados los controladores (controllers) y/o módulos. Por defecto se encuentra el controller pages_controller.php
models Estan agrupados los modelos (models).
views Estan agrupados las vistas de los controladores (controllers). Por defecto se encuentran los directorios templates/, pages/, partials/ y errors/
extensions En este directorio se ubican las extensiones para nuestra aplicación, una extensión te permite adicionar nuevas características que serán utilizadas e integradas a la aplicación por medio de las librerías que proporciona KumbiaPHP
libs En este directorio se pueden colocar clases propias con fines específicos o librerías externas al framework (vendors). Estas para ser utilizadas en los controladores (controllers) y/o Modelos (models).
temp Este directorio contiene las carpetas y archivos creados cuando KumbiaPHP está cacheando un template, view o partial y cuando realiza operaciones de logs. Este directorio necesita permisos de escritura.
public Agrupa las imágenes, css, javascript y files que serán utilizados por nuestra aplicación
locale Agrupa los archivos para el soporte a la internacionalización i18n para la aplicación.
application.php Super class de los controladores (ApplicationController).
model_base.php Super class de los modelos (ActiveRecord).

application.php[editar]

Cada vez es mas usado en las aplicaciones creadas en PHP la Programación Orientada a Objetos (POO), KumbiaPHP Framework fomenta el uso de la misma, debemos hacer especial hincapié en el archivo application.php el cual fue concebido como una superclase (ApplicationController) padre de todos los controladores.

application.php

Como se aprecia en la imagen existe una estrecha relación entre application.php y los controladores disponibles en el directorio controllers/. Esta relación se basa principalmente en que las variables y métodos creados en el ApplicationController (application.php) estarán disponibles para ser usados en cualquier controlador que tengamos en nuestra aplicación.

En esta clase se encuentran dos métodos principales, dichos métodos se comportan como un filtro antes y después de ejecutar un controller.

El método initialize() se ejecuta antes de llamar al controller.

El método finalize() se ejecuta despúes de haber llamado al controller.


Ejemplo de application.php[editar]

application.php

model_base.php[editar]

De la misma manera como se relacionan los controladores con application.php, existe otra relación muy importante entre el model_base.php y los modelos. Todo lo que se define en model_base.php estará disponible en los modelos ya que es la class padre.

model_base.php es donde esta definida la super clase ActiveRecord. 

 NOTA: Los modelos representan las tablas de nuestra Base de Datos.


application.php

Explicando dir core/[editar]

Directorio Descripción
console En este directorio se ubican los scripts de terminal que te ayudarán a construir y manejar algunos aspectos de nuestra aplicación
docs En este directorio se encuentran los detalles de licencia y otros archivos inherentes a la documentación de KumbiaPHP
extensions En este directorio se encuentran las extensiones compartidas por todas las aplicaciones
kumbia En este directorio se ubica el núcleo de KumbiaPHP
libs En este directorio se encuentran las librerias compartidas por todas las aplicaciones, las cuales el Equipo de Desarrollo se responsabiliza por su mantenimiento.
tests En este directorio se ubican las pruebas unitarias para KumbiaPHP
vendors En este directorio se ubican las librerias de terceros que son compartidas por todas las aplicaciones

config.ini[editar]

Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.

  • metadata_lifetime Tiempo de vida de la metadata cacheada.
  • database Base de datos a utilizar, especificada en databases.ini.
  • production Indica si se encuentra en producción.
  • cache_driver driver que se utilizara para el manejo de cache. KumbiaPHP cuenta con tres (3) driver: file, sqlite y memsqlite.
  • locale Localización.
  • routes Activar enrutamiento estatico.
;; Configuracion de Aplicacion

; Explicación de la Configuración:

; name: Es el nombre de la aplicación
; timezone: Es la zona horaria que usará el framework
; production: Indica si esta en producción
; database: base de datos a utilizar
; dbdate: Formato de Fecha por defecto de la Applicación
; debug: muestra los errores en pantalla (On|off)
; log_exceptions: muestra las excepciones en pantalla (On|off)
; charset: codificacion de caracteres
; cache_driver: driver para la cache (file, sqlite, memsqlite)
; metadata_lifetime: Tiempo de vida de la metadata cacheada
; locale: Localizacion
; routes: Activar enrutamiento estatico


; ¡¡¡ ADVERTENCIA !!!
; Cuando se efectua el cambio de production=Off, a production=On, es necesario eliminar
; el contenido del directorio de cache de la aplicacion para que se renueve
; la metadata

[application]
name = "KUMBIA PROJECT"
;timezone = "America/New_York"
production = Off
database = development
dbdate = YYYY-MM-DD
debug = On
log_exceptions = On
charset = UTF-8
cache_driver = file
;metadata_lifetime = "+1 year"
;locale = es_ES
;routes = On

databases.ini[editar]

Este archivo viene a remplazar a environment.ini para establecer la configuración de conexión a la base de datos, en este sentido se eliminó el prefijo database, cada sección esta asociada a unos datos de conexión al motor de BD y a su vez esta corresponde al atributo database del archivo config.ini.

Veamos un ejemplo, si en el archivo de configuración config/config.ini tenemos database = development KumbiaPHP Framework tomara los datos de conexión que estén en la sección [development]

Lo mismo sucede para los modelos, el atributo $mode fue reemplazado por $database 

class Usuarios extends ActiveRecord
{
    public $database = 'test';
}

Ahora KumbiaPHP Framework buscara los datos de conexión de la sección [test], para el modelo Usuarios. 

; KumbiaPHP Web Framework Configuration
; Parámetros de base de datos
; Utiliza el nombre del controlador nativo (mysql, pgsql, oracle)
; Coloca pdo = On si usas PHP Data Objects

[development]
host = localhost
username = root
password = 1qaz2WSX
name = test
type = mysql

[production]
host = localhost
username = root
password = 1qaz2WSX
name = test
type = mssql

[test]
host = localhost
username = root
password = 1qaz2WSX
name = test
type = mssql

boot.ini[editar]

En este archivo fue eliminado, ahora se recomienda la carga explicita con require o include o en su defecto aprovechar la autocarga de librerias de KumbiaPHP. O mejor usar el Load::lib('lib')

Router[editar]

Mejoras de Rendimiento.

Dispatcher[editar]

Mejoras de Rendimiento.

Clase Kumbia[editar]

Mejoras de Rendimiento.

Vistas[editar]

Estructura de Vistas KumbiaPHP Framework V1.0 Spirit

Kumbia posee un sistema de presentación basado en Vistas (Views) que viene siendo el tercer componente del sistema MVC, el framework permite mediante plantillas que son reutilizables para no repetir código.

Las vistas deberían contener una cantidad mínima de código en PHP para que fuese suficientemente entendible por un diseñador Web y además, para dejar a las vistas sólo las tareas de visualizar los resultados generados por los controladores y presentar las capturas de datos para usuarios.

En la versión 1.0(antigua 0.5.1) se incorporan dos(02) nuevos directorios en el directorio de vistas de nuestra aplicación los cuales son:

  1. views/templates/
  2. views/partials/

views/templates/[editar]

Los Template son un tipo de archivo pre-formateado utilizado como base para otros archivos.

En este directorio esta la capa mas externa de nuestras vistas, para aclarar esta idea en esta es donde se coloca la estructura del documento XHTML (doctype, html, head, etc) en la forma como se trabaja en la versión 0.5 esto es representado por el archivo views/index.phtml de esta forma no existe una flexibilidad de manera que podamos cambiar ese template, en la versión 1.0 se crea un directorio views/templates/ por defecto existe el archivo default.phtml pero podemos agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma: 

 
 class PruebaController extends ApplicationController 
 {
     public $template = 'plantilla';
 }

El atributo $template existe en la super clase Controller y tiene un valor por defecto (default) esto significa que el sistema de plantillas de KumbiaPHP Framework buscara dentro de directorio views/templates/ el valor que le demos, por defecto buscara default.phtml pero en otro caso que veamos conveniente podría ser otro template tal como se muestra en el ejemplo seria plantilla.phtml

En la version 0.5 para determinar en que parte del template se debe renderizar se hacia uso de la función "content", ahora esa función se encapsuló en la clase View y se utiliza de la siguiente manera. 

Este es mi template

<?php View::content() ?>

View::content() puede ubicarse en cualquier lugar del template.

views/partials/[editar]

Los partials (widget) son pequeñas vistas que pueden incluirse dentro de otra vista para evitar repetir código, en la versión 0.5 la convención que se tiene es que ha comenzar el nombre del archivo con un underscore(_) ejemplo, _partials.phtml y estar dentro del directorio de vistas de controlador que lo invoca, en la versión 1.0(antigua 0.5.1) con la finalidad de ofrecer mayor flexibilidad en el manejo de las vistas se ha creado el directorio views/partials/ donde se han de colocar los partials con esto quitamos la convención de los nombres de los partials, de igual forma ya no se encuentran atados a los controladores tal como pasaba en la versión 0.5. Los partials pueden representar cualquier tipo de Interfaz de Usuario, importante destacar que los partials pueden ser renderizados (mostrados) desde cualquier nivel de vista donde lo necesitemos.

Ejemplo:

views/partials/fecha.phtml 

 <div style='background: #333eee; padding: 15px 10px 15px 10px; text-align: center'>
       <i><?php echo date('Y-m-d'); ?></i>
 </div>

Como se aprecia este partials solo mostrará la fecha actual cuando sea invocado, pero como se menciono antes puede contener cualquier información para el usuario, pero aun falta hacer un llamado a este partials para que el mismo sea mostrado este llamado puede ser desde cualquier nivel del sistema de plantilla que ofrece el framework, en laversión 0.5 se hacia uso de la funcion "render_partial", sin embargo con la finalidad de obtener mayor orden e intuitividad, esta función se encapsulo en la clase View, y basta con hacer en la vista (Templates, views) lo siguiente. 

 <?php View::partial('fecha') ?>


Describiendo la función de manera mas detallada: 

  View::partial($partial, $time=false, $params=array())

Para cachear los partials, el tiempo de cacheo debe indicarse con el formato de strtotime tal como lo utiliza el componente cache. 

  <?php View::partial('fecha', '+4 days') ?>

Si no se desea cachear, se indica como segundo argumento "false", el cual es el valor por defecto 

  <?php View::partial('fecha', false) ?>

También es posible pasar variables al partial utilizando parámetros con nombre o utilizando como argumento un array. Si estos parámetros se pasan en forma de array soporta cualquier tipo de dato (objecto, array, etc). 

  <?php View::partial('fecha', false, 'var: valor, var2: valor2') ?>


 <?php View::partial('fecha', false, array('var' => 'valor')) ?>

Y esta es accesible en el partial como $var

Los modelos ya no se cargan directamente en los partials, esto mejora la velocidad, para hacer uso de los modelos en los partials, el usuario puede instanciar directamente el modelo, la desventaja de esta manera es que el usuario debe haber cargado previamente el modelo haciendo uso de "load_models" en el controller en caso de utilizar carga selectiva de modelos: 

 <?php 
    $Usuario = new Usuario();
    $usuario = $Usuario->find(1);
 ?>

También es posible utilizar el método Load::models($model), el cual se encarga de cargar la clase de ser necesario, este método solo debe usarse para obtener un modelo para efectuar consultas de recuperación de datos (find, findBy, find_first, etc) preferiblemente. 

 <?php 
   Load::models('usuario');
   $usuario = new Usuario();
   $result = $usuario->find(1);
 ?>

Con la intención de ofrecer mayor comodidad, KumbiaPHP también hace posible obtener una instancia de un modelo directamente haciendo uso del método Load::model($modelo). 

 <?php 
   $result = Load::model('usuario')->find(1);
 ?>

View::content()[editar]

Este método de la clase View viene a remplazar la función content(), esta se utiliza para indicar donde KumbiaPHP debe renderizar (mostrar) el contenido almacenado en el buffer de salida, es decir el próximo nivel de la vista.

Su uso para las vistas de las acciones esta íntimamente ligado a los echo o print que efectué el usuario, asimismo determina el lugar donde se mostrarán los mensajes Flash provenientes de ActiveRecord o los propios. Ejemplo: 

 <?php 
   class SaludoController extends ApplicationController
   {
       public function hola()
       {
           Flash::success('Hola mundo');
       }
   }
 ?>

Y en mi vista "hola.phtml" 

   Saludo realizado:

   <?php View::content() ?>

View::helpers($helper)[editar]

Un helpers representa una ayuda a nivel de las vistas (view), esto quiere decir siendo consistente con el mVc solo deben ser utilizados en las vistas.

Los helpers estan ubicados en miapp/extensions/helpers/, en ese directorio pueden existir tantos helpers como necesitemos KumbiaPHP, pero tambien pueden existir helpers en core/extensions/helpers/ en estos casos el framework da prioridad a los helpers ubicados en el directorio de la aplicación, esto quiere decir que si existen dos archivos con el mismo nombre en los directorios helpers antes descrito KumbiaPHP cargara el que se encuentra ubicado en el directorio de la aplicación (app).

Estos helpers pueden ser métodos con fines como formatear fechas, creación de tags HTML personalizados adecuados a las necesidades de nuestra aplicación, etc. veamos un ejemplo de un helpers. 

//Ubicamos este código en un fichero de nombre: miapp/extensions/helpers/MiHelper.php

class MiHelper 
{
/**
 * Construye una lista desplegable para países
 **/
public static function paisSelect($id, $value=null) {
    //carga el modelo models/pais.php
    $Pais = Load::model('pais');

    $code = "<select name=\"$id\" id=\"$id\">";
    foreach($Pais->find() as $pais) {
        $code .= "<option value=\"$pais->id\"";
        if($pais->id == $value) {
            $code .= ' selected="selected"';
        }
        $nombre = htmlspecialchars($pais->nombre);
        $code .= ">$nombre</option>";
    }
    $code .= '</select>';

    echo $code;
}

Como vemos en el helper anterior se construye un tag select de acuerdo a ciertas necesidades y este representa una salida, es decir un view por eso se utilizan en las vistas (views) para hacer buen uso del MVC, la forma de utilizar el helper anterior en cualquier vista seria de la siguiente manera. 

<?php
//Esta es una vista cualquiera

//la convención para cargar el helpers es pasar el parámetro tal como llamamos al fichero
//cargamos el helpers
View::helpers('MiHelper')

//Hacemos uso del helpers, con esto tendremos un select en el view
MiHelpers::paisSelect(1) 

?>

Utilizando el método render($view, [$template])[editar]

El método render($view, [$template]) se encuentra en la super clase ApplicationController es decir lo tenemos disponible solo en los controladores.

Este es un método que es muy poderoso con una utilización correcta del mismo, en la versión 1.0 lo hemos extendido para ofrecer mas flexibilidad en el manejo de las vistas, el cual nos permite de forma dinámica poder cambiar un view y un Template (el template es opcional) esto nos permite tener varias vistas (views) para la misma action incluso varios Template.

¿De que sirve esto?[editar]

Esto es una de las ventajas del manejo de vistas de KumbiaPHP y nos sirve para muchas cosas. Por ej: Si tenemos una aplicación web y también se quiere que esta pueda ser accedida desde dispositivos móviles (celular, PDA, etc.) no es necesario programar toda la aplicación de nuevo, sino que simplemente se cambia la vista pero lo mas importante es que el controlador sigue siendo el mismo.

Vamos a lo Práctico[editar]

Tenemos un controlador con una acción, pero deseamos que dicha acción tenga dos vistas asociadas y poderlas cambiar según sea el caso, el cambio de vista se dará de acuerdo a un parámetro que recibirá la acción del controlador.

NOTA: KumbiaPHP muestra el view con el mismo nombre de la acción. 

<?php
class BlogController extends ApplicationController 
{
    public function saludo($var=null)
    {
        $this->usuario = 'Usuario';
    	if($var == 'adios'){
            //cambiamos el view
            $this->render('adios');
    	}
    }
}

Como se aprecia se cambiara el view de la acción si el parámetro es "adios" sino es pasado ningún parámetro KumbiaPHP seguirá la convención que buscara el directorio de views la vista asociada al nombre de la acción.

Ahora tenemos las vistas.

app/views/blog/saludo.phtml (vista por defecto de la acción). 

   <?php echo "Bienvenido $usuario" ?>

La vista anterior se renderizara (mostrar) cuando tengamos la siguiente URL: 

 http://dominio.com/blog/saludo/

app/views/blog/adios.phtml (vista cuando existe el parámetro). 

   <?php echo "Adios $usuario" ?>

La vista anterior se renderizara (mostrar) cuando tengamos la siguiente URL: 

 http://dominio.com/blog/saludo/adios/
Cambiando el Template con método render($view, $template)[editar]

Pero también es posible cambiar el Template veamos la misma acción pero ahora cambiara el template. 

<?php
class BlogController extends ApplicationController 
{
    public function saludo($var=null)
    {
        $this->usuario = 'Usuario';
    	if($var == 'adios'){
            //cambiamos el view y el template
            $this->render('adios', 'otro_template');
    	}
    }
}

Ahora mostramos un nuevo Template llamado otro_template para cuando cambiamos el views a adios.

Ahora sin Template render($view, null)[editar]

Ahora indicamos que no deseamos mostrar el Template veamos la misma acción pero sin el template. 

<?php
class BlogController extends ApplicationController 
{
    public function saludo($var=null)
    {
        $this->usuario = 'Usuario';
    	if($var == 'adios'){
            //cambiamos el view y sin template
            $this->render('adios', null);
    	}
    }
}

Cuando vayan a http://dominio.com/blog/saludo/adios/ KumbiaPHP cargara solamente el view adios.phtml sin template ya que así lo indicamos.

Ahora sin view render(null, [$template])[editar]

Ahora indicamos que no deseamos mostrar el View de la acción, veamos la misma acción pero sin el view. 

<?php
class BlogController extends ApplicationController 
{
    public function saludo($var=null)
    {
        $this->usuario = 'Usuario';
    	if($var == 'adios'){
            //Mostrando un mensaje desde la acción
            Flash::notice('Adios '.$this->usuario);

            //sin el view y con el template por defecto
            $this->render(null);
    	}
    }
}
Ahora sin view y sin template render(null, null)[editar]

Ahora indicamos que no deseamos mostrar el View de la acción y el Template, veamos la misma acción pero sin el view y sin template. 

<?php
class BlogController extends ApplicationController 
{
    public function saludo($var=null)
    {
        $this->usuario = 'Usuario';
    	if($var == 'adios'){
            //KumbiaPHP no mostrará nada
            $this->render(null, null);
            
            //enrutamos a otro controller
            return Router::route_to('controller: otro_controller');
    	}
    }
}

Logger[editar]

La clase Logger para el manejo de Log fue reescrita de forma estática, esto quiere decir ya no es necesario crear una instancia de la clase Logger. Esta clase dispone de una variedad de métodos para manejar distintos tipos de Log. 

 <?php Logger::error('Mensaje de Error')?>

La salida de la instrucción anterior será lo siguiente: 

[Thu, 05 Feb 09 15:19:39 -0500][ERROR] Mensaje de Error

Por defecto los archivos log tienen el siguiente nombre logDDMMYYY.txt este nombre puede ser cambiado si así lo deseamos a través de un parámetro adicional al método. 

 <?php Logger::error('Mensaje de Error', 'mi_log')?>

Se puede apreciar el segundo parámetro ahora el archivo tendrá como nombre mi_log.txt

Métodos de la Clase Logger[editar]

Logger::warning ($msg);

Logger::error ($msg)

Logger::debug ($msg)

Logger::alert ($msg)

Logger::critical ($msg)

Logger::notice ($msg)

Logger::info ($msg)

Logger::emergence ($msg)

Logger::custom ($type='CUSTOM', $msg)

Cache[editar]

El componente cache fué mejorado y ahora posee una implementación utilizando los patrones de diseño factory y singleton, para hacer uso de la cache es necesario tener permisos de escritura en el directorio "cache" (para el caso de los manejadores "sqlite" y "file").

Puedes obtener un driver de Cache utilizando el metodo driver que te proporciona la clase Cache.

Cache::driver($driver=null)[editar]

Este metodo permite obtener un manejador de cache específico, si no se indica, se obtiene el manejador de cache por defecto indicado en el config.ini.

Ejemplos: 

// cache por defecto
$data = Cache::driver()->get('data');

// manejador para memcache
$data_memcache = Cache::driver('memcache')->get('data');

// manejador para cache con APC
$data_apc = Cache::driver('APC')->get('data');


Todos los manejadores de cache comparten métodos comunes indicados através de la clase abstracta Cache he implementados especificamente en cada manejador, los metodos de los manejadores de cache son los siguientes:

get($id, $group='default')[editar]

Obtiene los datos cacheados. Los elementos cacheados pueden agruparse en grupos, lo cual permite evitar colisiones entre elementos cacheados con igual $id.

string $id: identificador del elemento cacheado
string $group: grupo al cual pertenece el elemento cacheado (por defecto "default") 

$data = Cache::driver()->get('data');

save($value, $lifetime=null, $id=false, $group='default')[editar]

Guarda los datos a cachear.

mixed $value: valor a cachear (automaticamente es serializado antes de guardar)
string $lifetime: tiempo de vida de los datos (formato de strtotime), si es null, los datos no expiran nunca.
string $id: identificador del elemento a almacenar, si no se especifica, se toma el id y grupo del ultimo get efectuado
string $group: grupo al cual pertenece 

<?php if($data = Cache::driver()->get('data')): ?>
    <?php echo $data ?>
<?php else: ?>
    <?php ob_start() ?>
    Hola
    <?php 
        $data = ob_get_contents();
        Cache::driver()->save($data, '+21 days');
        ob_end_flush();        
    ?>
<?php endif; ?>


Cache::driver()->save('hola', null, 'data');
$data = Cache::driver()->get('data');

Nota: el grupo "kumbia.*" esta reservado para el uso exclusivo de KumbiaPHP.

start($lifetime, $id, $group='default')[editar]

Cachea capturando el buffer de salida, se debe utilizar en conjunto a "end()" para terminar la captura, si el elemento esta cacheado entonces lo retorna.

string $lifetime: tiempo de vida de los datos (formato de strtotime), si es null, los datos no expiran nunca.
string $id: identificador del elemento a almacenar, si no se especifica, se toma el id y grupo del ultimo get efectuado
string $group: grupo al cual pertenece 

<?php if($data = Cache::driver()->start('+1 day','data')): ?>
    <?php echo $data ?>
<?php else: ?>
    Hola
    <?php Cache::driver()->end()?>
<?php endif; ?>

end()[editar]

Guarda los datos en la cache tomados del buffer de salida.

clean($group=false)[editar]

Limpia la cache. Si no se indica grupo limpia toda la cache. 

Cache::driver()->clean('default');

remove($id, $group='default')[editar]

Elimina un elemento específico de la cache 

Cache::driver()->remove('data');

Cacheo automático de views y templates[editar]

Ahora el cacheo de views y templates desde el controller se hará utilizando el método cache().

cache($time, $type='view')[editar]

Para cachear una vista desde la acción: 

$this->cache('+1 day');

Para cachear un template: 

$this->cache('+1 day', 'template');

Si no desea cachear: 

$this->cache(false);

ActiveRecord[editar]

Ahora se ha definido una forma concreta para el paso de parámetros en los validadores y asimismo se adicionaron parámetros para personalizar los mensajes de error. 

class Model extends ActiveRecord
{
    public function initialize()
    {
        //valida que la cedula sea unica
        $this->validates_uniqueness_of('cedula', 'message: La cedula ya existe');
    }
}

NOTA: El método initialize hace las veces de constructor y se ejecuta siempre por eso nuestros validadores deberían estar alli...

validates_uniqueness_of($field, $params=array())[editar]

Valida que el campo sea único

string $field: campo a validar
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo (muestra un mensaje con el valor del campo)

Nota: Solo un parametro con nombre se muestra a la vez, teniendo prioridad el parametro con nombre message. 

...
$this->validates_uniqueness_of('cedula', 'message: La cedula ya existe')
$this->validates_uniqueness_of('cedula', array('message'=>'La cedula ya existe'))
...

o 

...
$this->validates_uniqueness_of('cedula', 'field: cedula')
$this->validates_uniqueness_of('cedula', array('field'=>'cedula'))
...

validates_date_in($field, $params=array())[editar]

Valida que el campo sea tipo fecha

string $field: campo a validar
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_date_in('fecha', 'message: Fecha invalida')
$this->validates_date_in('fecha', array('message'=>'Fecha invalida'))
...


validates_presence_of($field, $params=array())[editar]

Valida que el campo no sea nulo

string $field: campo a validar
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_presence_of('fecha_opt', 'field: Fecha')
...


validates_length_of($field, $max, $min=0, $params=array())[editar]

Valida el tamaño mínimo y máximo de caracteres permitidos en el campo

string $field: campo a validar
int $max: valor maximo
int $min: valor minimo
array $params: array de parametros con nombre

Parametros con nombre:
too_long: mensaje a mostrar cuando sea muy largo
too_short: mensaje a mostrar cuando sea muy corto
field: nombre del campo 

...
$this->validates_length_of('nombre', '25')
$this->validates_length_of('nombre', '25', 0,'too_long: Nombre muy largo')
$this->validates_length_of('nombre', '25', 0,array('too_long'=>'Nombre muy largo'))
...

validates_inclusion_in($field, $list, $params=array())[editar]

Valida que el campo este incluido en los valores de la lista

string $field: campo a validar
array $list: lista de elementos
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_inclusion_in('seleccion', array('a', 'b'))
...


validates_exclusion_of($field, $list, $params=array())[editar]

Valida que el campo no este incluido en los valores de la lista

string $field: campo a validar
array $list: lista de elementos
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_exclusion_of('seleccion', array('a', 'b'))
...

validates_format_of($field, $pattern, $params=array())[editar]

Valida que el campo coincida con el patron indicado

string $field: campo a validar
array $pattern: expresion regular compatible con perl
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_format_of('seleccion', '/^\d{3}[A-Z]/')
...


validates_numericality_of($field, $params=array())[editar]

Valida que el campo sea numerico

string $field: campo a validar
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_numericality_of('cedula')
...


validates_email_in($field, $params=array())[editar]

Valida que el campo sea un correo electronico

string $field: campo a validar
array $params: array de parametros con nombre

Parametros con nombre:
message: mensaje a mostrar
field: nombre del campo 

...
$this->validates_email_in('email')
...

Modos de una Aplicación[editar]

KumbiaPHP ofrece dos modos de ejecución de una aplicación el cual es indicado en el config.ini, estos se describen a continuación:

Production[editar]

Indicando en el config.ini "production = On", se entra en el modo de producción, en este la cache de kumbiaphp framework esta activada y se cachea información necesaria para agilizar la carga de la aplicación tal como la metadata de la base datos (información de tablas y campos), asimismo las vistas que el usuario desee cachear.

Development[editar]

Indicando en el config.ini "production = Off", se entra en el modo de desarrollo, en este la cache de KumbiaPHP esta desactivada y cualquier cambio que se haga en los campos y tablas de la base de datos (adición de campos, etc), vistas de la aplicación que se cacheen, surtirán efecto inmediatamente.

La para utilizar manualmente la cache de KumbiaPHP debes cargarla explicitamente indicándola en el boot.ini o utilizando el componente Load. 

Load::lib('cache');

Cuando se cambia de modo, es necesario limpiar la cache que KumbiaPHP ha creado para que se pueda renovar los nuevos metadatos y vistas, esto se hace simplemente eliminando el contenido del directorio de cache para la aplicación.

Carga selectiva de modelos[editar]

En la versión 1.0(antigua 0.5.1) se puede cargar solo los modelos que el controlador requiera, de esa manera se optimiza los procesos de la aplicación y consume menos recursos. Para utilizar la carga selectiva, es conveniente deshabilitar la autocarga de modelos en el config.ini con "models_autoload = Off".

Load::models($model)[editar]

Carga los modelos, se pueden cargar varios de manera simultánea indicándolos como argumentos múltiples del método o mediante un array. Asimismo se pueden cargar directorios completos de modelos.

Si la carga se efectúa en el controlador, automaticamente una instancia del modelo es cargada en un atributo del controlador correspondiente al nombre del modelo en notación camelcase.

NOTA: El parámetro $model puede ser un directorio y/o archivo, en el caso de ser el archivo debe ser igual al nombre del mismo. 

class UsuarioController extends ApplicationController 
{
  public function index()
  {
    //Se cargan los modelos Usuario y DatosPersonales
    //usuario.php y datos_personales.php
    Load::models('usuario', 'datos_personales');
  }
}

Asimismo se puede indicar con el atributo de controlador $models y estos serán cargados en cada acción. 

class UsuarioController extends ApplicationController {

  //Se cargan los modelos Usuario y DatosPersonales
  public $models = array('usuario', 'datos_personales');
  
  public function index()
  {}
}

Cargando un directorio de modelos 

class UsuarioController extends ApplicationController {
  
  public function index()
  {
    /** se cargan los modelos en: 
     * mi_app/models/dir/* 
     * mi_app/models/dir2/model1.php
     * mi_app/models/model2.php
     */
    Load::models('dir', 'dir2/model1', 'model2')
  }

}

Load::model($model)[editar]

Obtiene una instancia del modelo indicado, esto permite hacer uso de modelos en cualquier lugar de la aplicación de manera intuitiva.

NOTA: el nombre del modelo que recibe como parámetro este método debe ser pasado en notación smallcase 

/**
 * Construye una lista desplegable para países
 **/
function pais_select($id, $value=null) {
    //carga el modelo models/pais.php
    $Pais = Load::model('pais');

    $code = "<select name=\"$id\" id=\"$id\">";
    foreach($Pais->find() as $pais) {
        $code .= "<option value=\"$pais->id\"";
        if($pais->id == $value) {
            $code .= ' selected="selected"';
        }
        $nombre = htmlspecialchars($pais->nombre);
        $code .= ">$nombre</option>";
    }
    $code .= '</select>';

    return $code;
}

Uso avanzado... 

...
    //busca el país con ID 1
    Load::model('pais')->find(1);

    //carga el modelo ubicado en models/dir/user.php
    Load::model('dir/user')->find();

    //carga el modelo ubicado en models/user_group.php
    Load::model('user_group')->find();

...

Pages Controller[editar]

Es un nuevo controlador para el manejo de páginas estáticas (views estáticos), aunque se puede utilizar como cualquier otro controlador haciendo uso de los Templates y Partials.

Los parámetros pasados al método show() indican vistas que están en views/pages/ manteniendo su estructura de directorios

Ejemplos: 

http://www.dominio.com/pages/show/organizacion/privacidad

enseñará la vista views/pages/organizacion/privacidad.phtml 

http://www.dominio.com/pages/show/aviso

enseñara la vista views/pages/aviso.phtml

También se puede usar el routes.ini para llamarlo con otro nombre, 

/aviso = pages/show/aviso

Asi al ir a www.dominio.com/aviso enseñara la vista views/pages/aviso.phtml 

/organizacion/* = pages/show/organizacion/*

Al ir a www.dominio.com/organizacion/privacidad enseñará la vista en views/pages/organizacion/privacidad.phtml (si existe).

Ademas se pueden utilizar los Helpers y Partials dentro de estos views. 

<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>

Mostrará un enlace que al hacer clic ira a dominio.com/pages/show/aviso

Nuevo Helper[editar]

swf_tag($src)[editar]

Con este helper tendremos la posibilidad de agregar archivos flash a nuestras páginas de una manera fácil, rápida y sencilla, este helper utiliza una librería hecha en JavaScript y lo mejor de todo es que es Open Source, el helper object_tag("archivo.swf"), recibe como parámetro el nombre del archivo flash el cual debe estar ubicado en la carpeta public/swf, además de eso recibe parámetros por nombre como son "width", "height" y "wmode", el ancho y alto deben ser colocados para que el flash sea visible, de otra manera no se vera por las dimensiones. Veamos el siguiente ejemplo realizado en la vista index.phtml 

<?php echo swf_tag("archivo.swf", "height: 300", "width: 300", "wmode: transparent") ?>

Este Helper nos garantiza que el código XHTML generado es validado por la W3C.

Filter[editar]

Uso de Filter[editar]

El componente Filter, es un componente que permite filtrar y validar datos de una manera intuitiva, facil y simple.

Filter dispone de una serie de métodos estaticos que le permitirán filtrar los elementos indicados.

Filter::get($s, $options=array())[editar]

$s (mixed): el valor a filtrar.
$options (array): array de configuración del filtro.

Los filtros se aplican al valor indicado.

Ejemplo: 

 
$value = Filter::get($s, 'htmlspecialchars', array('charset' => 'UTF-8'));

Asimismo se pueden aplicar filtros en cadena. 

 
$value = Filter::get($s, 'trim', 'addslashes');

Los filtros en cadena no aceptan opciones de configuración, por lo tanto toman las opciones por defecto.

Filter::get_array($array, $options=array())[editar]

$array (array): un array de elementos a filtrar.
$options (array): array de configuración del filtro.

Los filtros se aplican a cada elemento del array.

Ejemplo: 

 
$array = Filter::get_array(array('<b>Hola</b>', '<b>Adios</b>'), 'htmlspecialchars', array('charset' => 'UTF-8'));


 
$array = Filter::get_array(array('saludo' => '<b>Hola</b>'), 'htmlspecialchars', array('charset' => 'UTF-8'));

Filter::get_object($object, $options=array())[editar]

$object (object): objeto a filtrar.
$options (array): array de configuración del filtro.

Los filtros se aplican a cada atributo del objeto.

Ejemplo: 

$object = Filter::get_object($usuario, 'htmlspecialchars', array('charset' => 'UTF-8'));

Filtros[editar]

Los filtros que existen actualmente son los siguientes:

addslashes[editar]

Escapa las comillas dobles y simples en una cadena de texto. 

$value = Filter::get('hola "gente"', 'addslashes');

alnum[editar]

Filtra la cadena eliminando los caracteres que no son alfanumericos o espacios. 

$value = Filter::get('hola "gente112"', 'alnum');

alpha[editar]

Filtra la cadena eliminando los caracteres que no son alfabéticos o espacios. 

$value = Filter::get('hola "gente112"', 'alpha');

date[editar]

Verifica que sea una fecha valida en el formato YYYY-MM-DD. 

if(Filter::get($s, 'date')) {
    ...
}

digits[editar]

Filtra la cadena eliminando los caracteres que no son digitos. 

$value = Filter::get('hola "gente112"', 'digits');

htmlentities[editar]

Escapa los elementos del lenguaje html con sus correspondientes entidades. 

$value = Filter::get('<p>"hola"</p>', 'htmlentities');

Opciones:
charset: codificación de caracteres de la cadena a escapar.

htmlspecialchars[editar]

Escapa caracteres especial de html. 

$value = Filter::get('<p>"hola"</p>', 'htmlspecialchars');

Opciones:
charset: codificación de caracteres de la cadena a escapar.

int[editar]

Convierte un valor a tipo entero. 

$value = Filter::get('1.2', 'int');

ipv4[editar]

Verifica si la cadena tiene el formato ipv4. 

if(Filter::get($s, 'ipv4')) {
    ...
}

lower[editar]

Convierte una cadena de texto a minusculas. 

$value = Filter::get('TEXTO', 'lower');

md5[editar]

Calcula el hash md5 para el valor indicado. 

$value = Filter::get('TEXTO', 'md5', array('binary' => true));

Opciones:
binary: indica si se usa modo binario

nl2br[editar]

Convierte el caracter de nueva linea a "<br>". 

$value = Filter::get('TEXTO\nTexto2', 'nl2br');

numeric[editar]

Filtra una cadena solo permitiendo valores numericos. 

$value = Filter::get('a1.2', 'numeric');

stripslashes[editar]

Filtra una cadena haciendo la operación inversa a addslashes. 

$value = Filter::get('\"Hola\"', 'stripslashes');

stripspace[editar]

Elimina los espacios. 

$value = Filter::get('  Hola  ', 'stripspace');

striptags[editar]

Elimina las etiquetas HTML. 

$value = Filter::get('<p>Hola</p>', 'striptags');

trim[editar]

Elimina los espacios en blanco a la izquiera y a la derecha. 

$value = Filter::get('   Hola   ', 'trim');

upper[editar]

Convierte la cadena a mayúsculas. 

$value = Filter::get('hola', 'upper');

Extendiendo el componente Filter[editar]

El componente Filter puede extenderse permitiendo al usuario crear sus propios filtros, para este fin el usuario debe hacer uso de la interface "FilterInterface", la cual se describe a continuación: 

interface FilterInterface
{
    /**
     * Metodo para ejecutar el filtro
     *
     * @param string $s cadena a filtrar
     * @param array $options opciones para el filtro
     **/
    public static function execute ($s, $options);
}

Los filtros de usuario deben ubicarse en el directorio "app/extensions/filters/".

Por convenio la clase que corresponde al filtro debe llevar el sufijo "Filter" y el archivo debe llamarse igual que la clase pero en notación smallcase.

Ejemplo: Un filtro que permite obtener la extension de un archivo, pasandole como valor el nombre del archivo.

app/extensions/filters/file_extension_filter.php 

/**
 * Filtro para obtener la extensión de un archivo
 **/
class FileExtensionFilter implements FilterInterface
{
   public static function execute($s, $options=array()) 
   {
       return strchr($s,".");
   }
}

Y se utilizaría de la siguiente manera: 

$ext = Filter::get('/home/yo/prueba.php', 'file_extension');

Filtrando datos enviados en el Request[editar]

El controller dispone de ciertas facilidades, en sus métodos: post, get y request, se puede indicar diversos filtros para aplicar al valor recibido.

Ejemplo: 

class UsuarioController extends ApplicationController
{
    public function save()
    {
        if($this->has_post('usuario')) {
            $usuario = new Usuario($this->post('usuario', 'trim'));
            $usuario->save();
        }
    }
}

En el ejemplo anterior, los datos enviados en el array de campos "usuario", son filtrados con un trim, cargados por el constructor del objecto ActiveRecord y posteriormente se guarda en la base de datos.

Carga Selectiva, Inyección de Dependencias y el Componente Load[editar]

El componente Load, esta diseñado especialmente para satisfacer las necesidades de Carga Selectiva e Inyección de Dependencias, con este componente disponemos de los elementos de KumbiaPHP Framework (vendors, libraries y models) donde así lo necesite nuestra aplicación.

Load::lib($lib)[editar]

El método library del componente Load nos permite cargar dinámicamente aquellas clases que tengamos definidas en el dir app/libs/ a fin de utilizarlas en los controladores(controllers) y/o Modelos(models). 

class UsuarioController extends ApplicationController 
{
  public function index()
  {
    //Se carga la librería app/libs/my_util.php
    Load::lib('my_util');
  }
}

NOTA: Por convención del método Load::lib($lib) busca primero en el directorio app/libs/ y en caso de no encontrar la biblioteca requerida pasaría a buscar en el directorio core/libs/, por lo que podríamos cargar dinámicamente la librería Auth del core de la siguiente forma 

class UsuarioController extends ApplicationController 
{
  public function index()
  {
    //Se carga core/libs/auth/auth.php, siempre que no exista algún archivo
    //con el mismo nombre en app/libs/ ya que KumbiaPHP da prioridad a tu app sobre el core.
    Load::lib('auth');
  }
}

Persistencia de Datos en el Controller[editar]

En ocasiones se necesita la persistencia de algunas variables en la ejecución de nuestros controladores, lo mas común en estos casos es guardar consultas avanzadas o bien pudiera los articulos de carro de compras. Para estos casos y mas que se puedan presentar KumbiaPHP hace persistente las variables para el controlador dependiendo el caso.

Para suplir esta necesidad se incoporan los siguientes métodos. 

...
//hace persistente la variable $data
$this->set_persistent('data', 'valor');
...


...
//recupera la persistencia de la variable $data
$this->get_persistent('data');
...


...
//destruye la persistencia de la variable $data
$this->destroy_persistent('data');
...

Session[editar]

En la extensions Session se quitan dos métodos que estaban descontinuado (deprecated) los cuales son:

  • set_data()
  • get_data()

Quedando la extensions Session con los siguientes métodos para el manejo de la sessiones.

set($index, $value, $namespace='default')[editar]

Crear o especifica el valor para un indice de la sesión actual. 

Session::set('usuario', 'Administrador');

get($index, $namespace='default')[editar]

Obtener el valor para un indice de la sesión actual. 

Session::get('usuario');//retorna 'Administrador'

delete($index, $namespace='default')[editar]

Elimina el valor para un indice de la sesión actual. 

Session::delete('usuario');

has($index, $namespace='default')[editar]

Verifica que este definido el indice en la sesión actual. 

Session::has('id_usuario');//retorna false.


NOTA: $namespace es un espacio individual en el cual se pueden contener las variables de sesión, permitiendo evitar colisiones con nombres de variables.

Upload[editar]

Anteriormente en los controladores, estaban disponibles los métodos upload_file y upload_image, ya que realmente el controlador no depende de estos para su correcto funcionamiento, estos fueron agrupados en el componente Upload. Este componente permite subir tanto archivos e imagenes al servidor donde se aloja tu aplicación.

Upload::file_in_path($name, $path, $new_name=null)[editar]

Sube un archivo la ruta indicada.

$name (string): nombre del archivo en el formulario (se revisa en $_FILES)

$path (string): ruta donde se subira. Ejemplo: "/var/www/public/app/temp/files/"

$new_name (string): indica el nuevo nombre para el archivo, por defecto se toma el nombre original. 

...
Upload::file_in_path('archivo', APP_PATH . 'temp/mis_archivos/');
...


Upload::file($name, $new_name=null)[editar]

Sube un archivo al directorio público "files/upload".

$name (string): nombre del archivo en el formulario

$new_name (string): indica el nuevo nombre para el archivo 

...
Upload::file('archivo');
...


Upload::image($name, $new_name=null)[editar]

Sube una imagen al directorio público "img/upload".

$name (string): nombre del archivo en el formulario

$new_name (string): indica el nuevo nombre para el archivo 

...
Upload::image('archivo');
...

Partials de Paginación[editar]

Como complemento para el paginador de ActiveRecord, através de vistas parciales se implementan los tipos de vistas de paginación más comunes, estos se ubican en el directorio "core/views/partials/paginators" y estas en capacidad de personalizarlos en tu aplicación aprovechando las características de renderizado de vistas parciales.

Classic[editar]

Resultado Final


Vista de paginación clásica.

Parametros de configuración:

page: objeto obtenido al invocar al paginador.

show: número de paginas que se mostraran en el paginador, por defecto 10.

url: url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina. 


View::partial('paginators/classic', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))

Digg[editar]

Vista de paginación estilo digg.

Parametros de configuración:

page: objeto obtenido al invocar al paginador.

show: número de paginas que se mostraran en el paginador, por defecto 10.

url: url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina. 


View::partial('paginators/digg', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))


Extended[editar]

Resultado Final


Vista de paginación extendida.

Parametros de configuración:

page: objeto obtenido al invocar al paginador.

url: url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina. 


View::partial('paginators/extended', false, array('page' => $page, 'url' => 'usuario/lista'))

Punbb[editar]

Vista de paginación estilo punbb.

Parametros de configuración:

page: objeto obtenido al invocar al paginador.

show: número de paginas que se mostraran en el paginador, por defecto 10.

url: url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina. 


View::partial('paginators/punbb', false, array('page' => $page, 'show' => 8, 'url' => 'usuario/lista'))


Simple[editar]

Resultado Final


Vista de paginación simple.


Parametros de configuración:

page: objeto obtenido al invocar al paginador.

url: url para la accion que efectua la paginacion, por defecto "module/controller/page/" y se envia por parametro el numero de pagina. 


View::partial('paginators/simple', false, array('page' => $page, 'url' => 'usuario/lista'))

Ejemplo de uso[editar]

Supongamos que queremos paginar una lista de usuarios.

Para el modelo Usuario en models/usuario.php: 

<?php
class Usuario extends ActiveRecord
{
    /**
     * Muestra los usuarios de cinco en cinco utilizando paginador
     *
     * @param int $page
     * @return object
     **/
    public function ver($page=1)
    {
        return $this->paginate("page: $page", 'per_page: 5');
    } 
}
?>


Para el controlador UsuarioController en controllers/usuario_controller.php: 

<?php
class UsuarioController extends ApplicationController
{
    public $models = array('usuario');

    /**
     * Accion de paginacion
     *
     * @param int $page
     **/
    public function page($page=1)
    {
        $this->page = $this->Usuario->ver($page);
    } 
}
?>

Y en la vista views/usuario/page.phtml 

<table>
 <tr>
  <th>Id</th>
  <th>Nombre</th>
 </tr>
 <?php foreach($page->items as $p): ?>
 <tr>
  <td><?php echo $p->id; ?></td>
  <td><?php echo $p->nombre; ?></td>
 </tr>
 <?php endforeach; ?>
</table>

<?php View::partial('paginators/classic', false, array('page' => $page)); ?>
Obtenido de «https://wiki.kumbiaphp.com/index.php?title=KumbiaPHP_Framework_Versión_1.0_Spirit&oldid=5444»