Edición de «KumbiaPHP Framework Versión 1.0 Spirit»

Saltar a: navegación, buscar

Advertencia: No has iniciado sesión. Tu dirección IP será visible públicamente si haces cualquier edición. Si inicias sesión o creas una cuenta, tus ediciones se atribuirán a tu nombre de usuario, junto con otros beneficios.

La edición puede deshacerse. Antes de deshacer la edición, comprueba la siguiente comparación para verificar que realmente es lo que quieres hacer, y entonces guarda los cambios para así deshacer la edición.
Revisión actual Tu texto
Línea 1: Línea 1:
{{cleanupbox
 
|image=[[Archivo:Information_icon4.png|45px]]
 
|texto ='''Este manual corresponde la versión 1.0 beta 1(Desaconsejada). Se recomineda ver la última versión del [https://github.com/KumbiaPHP/Documentation/tree/master/es Manual de KumbiaPHP 1.0]'''<br />
 
}}
 
 
 
== Introducción ==
 
== Introducción ==
 
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.
 
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.
Línea 23: Línea 18:
 
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.
 
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 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."
+
"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 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."
  
 
== Migración Rápida ==
 
== Migración Rápida ==
Línea 29: Línea 24:
  
 
*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 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]]
 
*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.
 
*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.
Línea 37: Línea 30:
  
 
*Para inicializar tu aplicación se ha de utilizar el '''config/routes.ini''' agregando una regla de enrutamiento estático, por ejemplo:
 
*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  
+
  ;con esta regla cada vez que inicie la aplicación http://localhost/kumbia/ irá hacia un controlador admin y una acción autenticar
admin y una acción autenticar / = admin/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>'''
 
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 ==
 
== Nueva Estructura de Directorios ==
Línea 118: Línea 51:
 
|  |  `-- scaffolds
 
|  |  `-- scaffolds
 
|  |-- index.php
 
|  |-- index.php
|  |-- libs
+
|  |-- libraries
 
|  |-- locale
 
|  |-- locale
 
|  |-- model_base.php
 
|  |-- model_base.php
Línea 136: Línea 69:
 
|  |  `-- scaffolds
 
|  |  `-- scaffolds
 
|  |-- kumbia
 
|  |-- kumbia
|  |-- libs
+
|  |-- libraries
 
|  |-- tests
 
|  |-- tests
 
|  |-- vendors
 
|  |-- vendors
 
|  `-- views
 
|  `-- views
 
|      |-- errors
 
|      |-- errors
|      |-- partials
 
 
|      `-- templates
 
|      `-- templates
 
</pre>
 
</pre>
Línea 172: Línea 104:
 
|views||Estan agrupados las vistas de los controladores (controllers). Por defecto se encuentran los directorios '''templates/''', '''pages/''', '''partials/''' y '''errors/'''
 
|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]
+
|extensions||---
 
|-
 
|-
|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).
+
|libraries||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'''.
+
|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  
 
|public||Agrupa las imágenes, css, javascript y files que serán utilizados por nuestra aplicación  
Línea 192: Línea 124:
 
[[Archivo:Application_kumbiaphp_framework.png|center|thumb|200px|application.php]]
 
[[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.
+
Como se aprecia en la imagen existe una estrecha relación entre '''apllication.php''' y los controladores disponibles en el directorio controllers/. Esta relación se basa principalmente en que las variables y metodos 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.
 
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.
Línea 222: Línea 154:
 
!Directorio!!Descripción
 
!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
+
|console||
 
|-
 
|-
|docs||En este directorio se encuentran los detalles de licencia y otros archivos inherentes a la documentación de [http://www.kumbiaphp.com KumbiaPHP]
+
|docs||
 
|-
 
|-
|extensions|| En este directorio se encuentran las extensiones compartidas por todas las aplicaciones
+
|extensions||
 
|-
 
|-
|kumbia|| En este directorio se ubica el núcleo de [http://www.kumbiaphp.com KumbiaPHP]
+
|kumbia||
 
|-
 
|-
|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.
+
|libraries||---
 
|-
 
|-
|tests||En este directorio se ubican las pruebas unitarias para [http://www.kumbiaphp.com KumbiaPHP]
+
|tests||
 
|-
 
|-
|vendors||En este directorio se ubican las librerias de terceros que son compartidas por todas las aplicaciones
+
|vendors||
 
|}
 
|}
  
Línea 240: Línea 172:
 
Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.
 
Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.
  
 +
*'''models_autoload''' Auto carga de modelos, útil 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.
 
*'''cache_driver''' driver que se utilizara para el manejo de cache. KumbiaPHP cuenta con tres (3) driver: file, sqlite y memsqlite.
*'''locale''' Localización.
+
*'''locale''' Localicazión
*'''routes''' Activar enrutamiento estatico.
+
  
 
<pre>;; Configuracion de Aplicacion
 
<pre>;; Configuracion de Aplicacion
Línea 259: Línea 191:
 
; log_exceptions: muestra las excepciones en pantalla (On|off)
 
; log_exceptions: muestra las excepciones en pantalla (On|off)
 
; charset: codificacion de caracteres
 
; charset: codificacion de caracteres
 +
; models_autoload: Habilita la autocarga de modelos
 
; cache_driver: driver para la cache (file, sqlite, memsqlite)
 
; 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: Localizacion
+
; locale: Localicazion
; routes: Activar enrutamiento estatico
+
  
  
Línea 279: Línea 211:
 
log_exceptions = On
 
log_exceptions = On
 
charset = UTF-8
 
charset = UTF-8
 +
models_autoload = On
 
cache_driver = file
 
cache_driver = file
 
;metadata_lifetime = "+1 year"
 
;metadata_lifetime = "+1 year"
 
;locale = es_ES
 
;locale = es_ES
;routes = On
 
 
</pre>
 
</pre>
  
Línea 310: Línea 242:
 
host = localhost
 
host = localhost
 
username = root
 
username = root
password = 1qaz2WSX
+
password =
name = test
+
name = innogest
 
type = mysql
 
type = mysql
  
Línea 317: Línea 249:
 
host = localhost
 
host = localhost
 
username = root
 
username = root
password = 1qaz2WSX
+
password =
 
name = test
 
name = test
type = mssql
+
type = mysql
  
 
[test]
 
[test]
 
host = localhost
 
host = localhost
 
username = root
 
username = root
password = 1qaz2WSX
+
password =
 
name = test
 
name = test
type = mssql
+
type = mysql
 
</pre>
 
</pre>
  
 
== boot.ini ==
 
== boot.ini ==
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 es donde el usuario carga las extensiones (librerías) que trae el framework o bien alguna que deseen agregar.
O mejor usar el Load::lib('lib')
+
 
 +
Extensiones Propias de Kumbiaphp Framework
 +
*session
 +
*logger
 +
*auth
 +
*date
 +
*filter
 +
*acl
 +
*benchmark
 +
*security
 +
 
 +
Extensiones externas al framework
 +
*excel
 +
*fpdf
 +
*phpmailer
 +
*libchart
 +
 
 +
<pre>
 +
; LIBRERIAS DISPONIBLES
 +
; Librerias Propias de KumbiaPHP Framework (libraries)
 +
;  * session
 +
;  * logger
 +
;  * auth
 +
;  * date
 +
;  * filter
 +
;  * acl
 +
;  * benchmark
 +
;  * security
 +
;
 +
; Cargadores en libraries para librerias de terceros (vendors)
 +
;  * excel
 +
;  * fpdf
 +
;  * phpmailer
 +
;  * libchart
 +
 
 +
 
 +
[modules]
 +
libraries = logger
 +
</pre>
  
 
== Router ==
 
== Router ==
Línea 355: Línea 325:
 
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 <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:
+
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 podemos agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma:
  
 
<source lang=php>  
 
<source lang=php>  
Línea 390: Línea 360:
 
</source>
 
</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, 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.
+
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 myor orden e intuitividad, esta función se encapsulo en la clase '''View''',  y basta con hacer en la vista (Templates, views) lo siguiente.
  
 
<source lang=php >
 
<source lang=php >
Línea 414: Línea 384:
 
</source>  
 
</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 >
 
<source lang=php >
Línea 446: Línea 416:
 
</source>
 
</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)]]'''.
+
KumbiaPHP con la intención de ofrecer mayor comodidad tambien 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 >
 
<source lang=php >
Línea 454: Línea 424:
 
</source>
 
</source>
  
=== View::content()===
+
=== View::content() en las vistas de acciones ===
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.
+
Este método de la clase '''View''' viene a remplazar la función '''content''', esta se utiliza para indicar donde KumbiaPHP debe renderizar el contenido almacenado en el buffer de salida.
  
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:
+
Su uso para las vistas de las acciones esta intimamente ligado a los '''echo''' o '''print''' que efectue el usuario, asimismo determina el lugar donde se mostrarán los los mensajes '''Flash''' provenientes de ActiveRecord o los propios. Ejemplo:
  
 
<source lang=php >
 
<source lang=php >
Línea 477: Línea 447:
  
 
   <?php View::content() ?>
 
   <?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>
 
 
===== 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.
 
 
<source lang=php>
 
<?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');
 
    }
 
    }
 
}
 
 
</source>
 
</source>
  
Línea 698: Línea 482:
  
 
==Cache==
 
==Cache==
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").
+
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:
  
Puedes obtener un driver de Cache utilizando el metodo '''driver''' que te proporciona la clase Cache.
+
===Cache::get($id, $group='default')===
 
+
===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>
+
 
+
 
+
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 727: Línea 490:
 
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
 
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
  
<source lang=php>
+
<pre>
$data = Cache::driver()->get('data');
+
$data = Cache::get('data');
</source>
+
</pre>
  
===save($value, $lifetime=null, $id=false, $group='default')===
+
===Cache::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://es2.php.net/manual/en/function.strtotime.php strtotime]), si es null, los datos no expiran nunca.<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 '''$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
  
 
<source lang=php>
 
<source lang=php>
<?php if($data = Cache::driver()->get('data')): ?>
+
<?php if($data = Cache::get('data')): ?>
 
     <?php echo $data ?>
 
     <?php echo $data ?>
 
<?php else: ?>
 
<?php else: ?>
Línea 747: Línea 510:
 
     <?php  
 
     <?php  
 
         $data = ob_get_contents();
 
         $data = ob_get_contents();
         Cache::driver()->save($data, '+21 days');
+
         Cache::save($data, '+21 days');
 
         ob_end_flush();         
 
         ob_end_flush();         
 
     ?>
 
     ?>
Línea 755: Línea 518:
  
 
<source lang=php>
 
<source lang=php>
Cache::driver()->save('hola', null, 'data');
+
Cache::save('hola', null, 'data');
$data = Cache::driver()->get('data');
+
$data = Cache::get('hola');
 
</source>
 
</source>
  
 
Nota: el grupo "kumbia.*" esta reservado para el uso exclusivo de KumbiaPHP.
 
Nota: el grupo "kumbia.*" esta reservado para el uso exclusivo de KumbiaPHP.
  
===start($lifetime, $id, $group='default')===
+
===Cache::start($lifetime, $id, $group='default')===
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.
+
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.
  
 
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 769: Línea 532:
  
 
<source lang=php>
 
<source lang=php>
<?php if($data = Cache::driver()->start('+1 day','data')): ?>
+
<?php if($data = Cache::start('+1 day','data')): ?>
 
     <?php echo $data ?>
 
     <?php echo $data ?>
 
<?php else: ?>
 
<?php else: ?>
 
     Hola
 
     Hola
     <?php Cache::driver()->end()?>
+
     <?php Cache::end()?>
 
<?php endif; ?>     
 
<?php endif; ?>     
 
</source>
 
</source>
  
===end()===
+
===Cache::end()===
 
Guarda los datos en la cache tomados del buffer de salida.
 
Guarda los datos en la cache tomados del buffer de salida.
  
===clean($group=false)===
+
===Cache::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.
  
 
<source lang=php>
 
<source lang=php>
Cache::driver()->clean('default');
+
Cache::clean('default');
 
</source>
 
</source>
  
===remove($id, $group='default')===
+
===Cache::remove($id, $group='default')===
 
Elimina un elemento específico de la cache
 
Elimina un elemento específico de la cache
  
 
<source lang=php>
 
<source lang=php>
Cache::driver()->remove('data');
+
Cache::remove('data');
 +
</source>
 +
 
 +
===Cache::active($active)===
 +
Activa el uso de la cache
 +
 
 +
<source lang=php>
 +
Cache::active(true);
 
</source>
 
</source>
  
Línea 837: Línea 607:
 
Parametros con nombre:<br>
 
Parametros con nombre:<br>
 
message: mensaje a mostrar<br>
 
message: mensaje a mostrar<br>
field: nombre del campo (muestra un mensaje con el valor del campo)
+
field: nombre del campo
 
+
'''Nota:''' Solo un parametro con nombre se muestra a la vez, teniendo prioridad el parametro con nombre '''message'''.
+
  
 
<source lang=php>
 
<source lang=php>
Línea 845: Línea 613:
 
$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'))
...
 
</source>
 
 
o
 
 
<source lang=php>
 
...
 
$this->validates_uniqueness_of('cedula', 'field: cedula')
 
$this->validates_uniqueness_of('cedula', array('field'=>'cedula'))
 
 
...
 
...
 
</source>
 
</source>
Línea 893: Línea 652:
  
 
===validates_length_of($field, $max, $min=0, $params=array())===
 
===validates_length_of($field, $max, $min=0, $params=array())===
Valida el tamaño mínimo y máximo de caracteres permitidos en el campo
+
Valida que el campo no sea nulo
  
 
string '''$field''': campo a validar<br>
 
string '''$field''': campo a validar<br>
Línea 912: Línea 671:
 
...
 
...
 
</source>
 
</source>
 +
  
 
===validates_inclusion_in($field, $list, $params=array())===
 
===validates_inclusion_in($field, $list, $params=array())===
Línea 965: Línea 725:
 
</source>
 
</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
 +
 +
<source lang=php>
 +
...
 +
$this->validates_format_of('seleccion', '/^\d{3}[A-Z]/')
 +
...
 +
</source>
  
  
Línea 1004: Línea 780:
  
 
===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 [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.
+
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.
  
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'''.
+
La cache de kumbiaphp framework se puede activar nuevamente utilizando el método active de la clase Cache.
  
<source lang=php>
+
<pre>
Load::lib('cache');
+
Cache::active(true);
</source>
+
</pre>
  
'''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.'''
+
'''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/.'''
  
 
== 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"'''.
  
==== Load::models($model) ====
+
Para cargar los modelos en el controlador se utiliza el método estático '''"Load::models($modelo)"'''
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.
+
El parámetro '''$modelo''' puede ser un directorio y/o archivo, en el caso de ser el archivo debe ser igual al nombre del mismo.  
 
+
''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.''
+
  
 
<source lang=php >
 
<source lang=php >
class UsuarioController extends ApplicationController  
+
class UsuarioController extends ApplicationController {
{
+
 
   public function index()
 
   public function index()
 
   {
 
   {
Línea 1039: Línea 811:
 
</source>
 
</source>
  
Asimismo se puede indicar con el atributo de controlador $models y estos serán cargados en cada acción.
+
Asimismo se puede indicar con el atributo de controlador $models.
  
 
<source lang=php >
 
<source lang=php >
Línea 1052: Línea 824:
 
</source>
 
</source>
  
Cargando un directorio de modelos
+
'''Uso avanzado'''
  
 
<source lang=php >
 
<source lang=php >
Línea 1068: Línea 840:
  
 
}
 
}
</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;
 
}
 
</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>
 
</source>
  
Línea 1140: Línea 868:
 
   
 
   
 
Ademas se pueden utilizar los Helpers y Partials dentro de estos views.
 
Ademas se pueden utilizar los Helpers y Partials dentro de estos views.
<source lang=php>
+
<pre>
 
<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>
 
<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>
</source>
+
</pre>
 
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 1163: Línea 893:
 
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 una serie de métodos estaticos que le permitirán filtrar los elementos indicados.
+
Filter dispone de un método estático "Filter::get" el cuál permite filtrar el elemento indicado.
  
 
=== Filter::get($s, $options=array()) ===
 
=== Filter::get($s, $options=array()) ===
  
'''$s (mixed)''': el valor a filtrar.
+
'''$s (string, array, object)''': array, objeto, o string a filtrar.
 
<br>
 
<br>
 
'''$options (array)''': array de configuración del filtro.
 
'''$options (array)''': array de configuración del filtro.
  
Los filtros se aplican al valor indicado.
+
Los filtros se aplican de manera recursiva en los arrays y objetos.
  
 
Ejemplo:
 
Ejemplo:
<source lang=php>  
+
<pre>
 
$value = Filter::get($s, 'htmlspecialchars', array('charset' => 'UTF-8'));
 
$value = Filter::get($s, 'htmlspecialchars', array('charset' => 'UTF-8'));
</source>
+
</pre>
  
 
Asimismo se pueden aplicar filtros en cadena.
 
Asimismo se pueden aplicar filtros en cadena.
<source lang=php>  
+
<pre>
 
$value = Filter::get($s, 'trim', 'addslashes');
 
$value = Filter::get($s, 'trim', 'addslashes');
</source>
+
</pre>
  
Los filtros en cadena no aceptan opciones de configuración, por lo tanto toman las opciones por defecto.
+
Los filtros en cadena no aceptan opciones de configuración, tomando 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.
+
 
+
Ejemplo:
+
<source lang=php>
+
$object = Filter::get_object($usuario, 'htmlspecialchars', array('charset' => 'UTF-8'));
+
</source>
+
  
 
=== Filtros ===
 
=== Filtros ===
Línea 1244: Línea 943:
  
 
<source lang=php>
 
<source lang=php>
if(Filter::get($s, 'date')) {
+
if(Filter::date($s, 'date')) {
 
     ...
 
     ...
 
}
 
}
Línea 1250: Línea 949:
  
 
==== digits ====
 
==== digits ====
Filtra la cadena eliminando los caracteres que no son digitos.
+
Filtra la cadena eliminando los caracteres que nos son digitos.
  
 
<source lang=php>
 
<source lang=php>
Línea 1334: Línea 1033:
  
 
<source lang=php>
 
<source lang=php>
$value = Filter::get(' Hola  ', 'stripspace');
+
$value = Filter::get('a1.2', 'numeric');
 
</source>
 
</source>
  
Línea 1374: Línea 1073:
 
</source>
 
</source>
  
Los filtros de usuario deben ubicarse en el directorio "app/extensions/filters/".
+
Los filtros de usuario deben ubicarse en el directorio "app/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.
 
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.
Línea 1381: Línea 1080:
 
Un filtro que permite obtener la extension de un archivo, pasandole como valor el nombre del archivo.
 
Un filtro que permite obtener la extension de un archivo, pasandole como valor el nombre del archivo.
  
app/extensions/filters/file_extension_filter.php
+
app/filters/file_extension_filter.php
 
<source lang=php >
 
<source lang=php >
 
/**
 
/**
Línea 1419: Línea 1118:
 
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.
 
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 ==
+
=== 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.
+
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, extensions, models, helpers, etc) donde así lo necesite nuestra aplicación para tal fin se dispone de los siguientes métodos:
  
=== Load::lib($lib) ===
+
==== Load::extensions($extension) ====
 +
Carga las extensiones complementarias de [http://www.kumbiaphp.com KumbiaPHP Framework], se pueden indicar cargar extensiones de manera simultánea indicándolas como argumentos múltiples del método.
  
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>
 +
Load::extensions('auth', 'benchmark', 'filter');
 +
</source>
 +
 
 +
==== Load::vendors($vendor) ====
 +
Carga las librerías de terceros, es decir las cuales el [[Team_Development_KumbiaPHP_Framework Equipo de Desarrollo]] no es responsable por su desarrollo, ubicadas en el directorio '''vendors'''. Se pueden indicar cargar librerías de manera simultánea indicándolas como argumentos múltiples del método.
 +
 
 +
<source lang=php>
 +
//se cargara las librarias FPDF, ubicadas en mi_path/core/vendors/fpdf/fpdf.php
 +
Load::extensions('fpdf/fpdf');
 +
</source>
 +
 
 +
==== Load::helpers($helper) ====
 +
Carga los helpers para vistas, se pueden cargar varios de manera simultánea indicándolos como argumentos múltiples del método. Primero se buscará el helper en el directorio global '''core/helpers''', de no existir el helper se cargará del directorio de helpers de la aplicación.
 +
 
 +
<source lang=php>
 +
Load::helpers('html', 'mi_helper');
 +
</source>
 +
 
 +
==== 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.
 +
 
 +
''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.''
  
 
<source lang=php >
 
<source lang=php >
Línea 1431: Línea 1155:
 
   public function index()
 
   public function index()
 
   {
 
   {
     //Se carga la librería app/libs/my_util.php
+
     //Se cargan los modelos Usuario y DatosPersonales
     Load::lib('my_util');
+
    //usuario.php y datos_personales.php
 +
     Load::models('usuario', 'datos_personales');
 
   }
 
   }
 
}
 
}
 
</source>
 
</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'''
+
Asimismo se puede indicar con el atributo de controlador $models y estos serán cargados en cada acción.
  
 
<source lang=php >
 
<source lang=php >
class UsuarioController extends ApplicationController  
+
class UsuarioController extends ApplicationController {
{
+
 
 +
  //Se cargan los modelos Usuario y 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 carga core/libs/auth/auth.php, siempre que no exista algún archivo
+
     /** se cargan los modelos en:
    //con el mismo nombre en app/libs/ ya que KumbiaPHP da prioridad a tu app sobre el core.
+
    * mi_app/models/dir/*
     Load::lib('auth');
+
    * mi_app/models/dir2/model1.php
 +
    * mi_app/models/model2.php
 +
    */
 +
     Load::models('dir', 'dir2/model1', 'model2')
 
   }
 
   }
 +
 
}
 
}
 +
</source>
 +
 +
==== Load::all_models() ====
 +
Carga los modelos ubicados en la raíz del directorios '''models/'''. Si la carga se efectúa dentro del controlador, automáticamente se realiza una inyección de dependencias con instancias de los modelos cargadas en atributos del controlador con el nombre correspondiente al modelo.
 +
 +
<source lang=php line>
 +
class UsuarioController extends ApplicationController
 +
{
 +
    public function index()
 +
    {
 +
        Load::all_models();
 +
        $this->usuario = $this->Usuario->find();
 +
    }
 +
}
 +
</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 = Filter::get($pais->nombre, 'htmlspecialchars');
 +
        $code .= ">$nombre</option>";
 +
    }
 +
    $code .= '</select>';
 +
 +
    return $code;
 +
}
 +
</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>
 
</source>
  
Línea 1490: Línea 1290:
  
 
<source lang=php>
 
<source lang=php>
Session::set('usuario', 'Administrador');
+
Session::set('usuario', 'Administrado');
 
</source>
 
</source>
  
Línea 1500: Línea 1300:
 
</source>
 
</source>
  
===delete($index, $namespace='default')===
+
===unset_data($index, $namespace='default')===
 
Elimina el valor para un indice de la sesión actual.
 
Elimina el valor para un indice de la sesión actual.
  
 
<source lang=php>
 
<source lang=php>
Session::delete('usuario');
+
Session::unset_data('usuario');
 
</source>
 
</source>
  
===has($index, $namespace='default')===
+
===isset_data($index, $namespace='default')===
 
Verifica que este definido el indice en la sesión actual.
 
Verifica que este definido el indice en la sesión actual.
  
 
<source lang=php>
 
<source lang=php>
Session::has('id_usuario');//retorna false.
+
Session::isset_data('id_usuario');//retorna false.
 
</source>
 
</source>
  
Línea 1517: Línea 1317:
 
NOTA: '''$namespace''' es un espacio individual en el cual se pueden contener las variables de sesión, permitiendo evitar colisiones con nombres de variables.
 
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==
+
[[Categoría:PHP Framework Benchmarks]]
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>
+

Por favor observa que todas las contribuciones a KumbiaPHP Framework Wiki se consideran hechas públicas bajo la Attribution-Share Alike 3.0 Unported (véase KumbiaPHP Framework Wiki:Derechos de autor para más detalles). Si no deseas la modificación y distribución libre de tu obra, entonces no la pongas aquí.
También nos aseguras que tú escribiste esto y te pertenecen de los derechos de autor, o lo copiaste desde el dominio público u otra fuente libre. ¡No uses escritos con copyright sin permiso!

Cancelar | Ayuda de edición (se abre en una ventana nueva)

Plantilla usada en esta página: