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

== 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.

Entre los componentes a nivel del core que hemos tocado para lograr nuestros objetivos se encuentran:
#Estructura de Directorios
#environment.ini
#Router
#Dispatcher
#Clase Kumbia
#Vistas
##Templates y Partials
##Helpers
#Logger
#config.ini
#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 [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?===
"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 ==
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.

*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]]

*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]].

== 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
|   |-- libraries
|   |-- locale
|   |-- model_base.php
|   |-- models
|   |-- public
|   |-- temp
|   `-- views
|       |-- errors
|       |-- pages
|       |-- partials
|       `-- templates
|-- core
|   |-- console
|   |-- docs
|   |-- extensions
|   |   |-- helpers
|   |   `-- scaffolds
|   |-- kumbia
|   |-- libraries
|   |-- tests
|   |-- vendors
|   `-- views
|       |-- errors
|       `-- 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 he integradas a la aplicación por medio de las librerias que proporciona [http://www.kumbiaphp.com KumbiaPHP]
|-
|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 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 '''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.

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]
|-
|libraries|| 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 ==
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.
*'''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''' Localicazión

<pre>;; 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
; models_autoload: Habilita la autocarga de modelos
; cache_driver: driver para la cache (file, sqlite, memsqlite)
; metadata_lifetime: Tiempo de vida de la metadata cacheada
; locale: Localicazion


; ¡¡¡ 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
models_autoload = On
cache_driver = file
;metadata_lifetime = "+1 year"
;locale = es_ES
</pre>

== databases.ini ==
Este archivo viene a remplazar a <s>environment.ini</s> 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 <s>$mode</s> fue reemplazado por '''$database'''

<source lang=php>
class Usuarios extends ActiveRecord
{
    public $database = 'test';
}
</source>

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

<pre>
; 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 =
name = innogest
type = mysql

[production]
host = localhost
username = root
password =
name = test
type = mysql

[test]
host = localhost
username = root
password =
name = test
type = mysql
</pre>

== boot.ini ==
En este archivo es donde el usuario carga las extensiones (librerías) que trae el framework o bien alguna que deseen agregar.

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 ==
Mejoras de Rendimiento.

== Dispatcher ==
Mejoras de Rendimiento.

== Clase Kumbia ==
Mejoras de Rendimiento.

== Vistas ==
[[Imagen:Vistas_1.0_spirit.jpg|Estructura de Vistas KumbiaPHP Framework V1.0 Spirit|right|frameless|400px]]
Kumbia posee un sistema de presentación basado en Vistas (Views) que viene siendo el tercer componente del sistema [http://es.wikipedia.org/wiki/Modelo_Vista_Controlador 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 [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) se incorporan dos(02) nuevos directorios en el directorio de vistas de nuestra aplicación los cuales son:
#views/templates/
#views/partials/

=== views/templates/ ===
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 podemos agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma:

<source lang=php> 
 class PruebaController extends ApplicationController 
 {
     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'''

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/ ===
Los partials ([http://es.wikipedia.org/wiki/Widget#Los_widget_en_el_.C3.A1mbito_de_la_programaci.C3.B3n_gr.C3.A1fica 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 [https://launchpad.net/kumbia/0.5.1 versión 1.0](<s>antigua 0.5.1</s>) 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 [http://es.wikipedia.org/wiki/GUI 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'''
<source lang=php >
 <div style='background: #333eee; padding: 15px 10px 15px 10px; text-align: center'>
       <i><?php echo date('Y-m-d'); ?></i>
 </div>
</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 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 >
 <?php View::partial('fecha') ?>
</source>


'''Describiendo la función de manera mas detallada:'''
<source lang=php >
  View::partial($partial, $time=false, $params=array())
</source>

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

<source lang=php >
  <?php View::partial('fecha', '+4 days') ?>
</source> 

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

<source lang=php >
  <?php View::partial('fecha', false) ?>
</source> 

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> 


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

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:

<source lang=php >
 <?php 
    $Usuario = new Usuario();
    $usuario = $Usuario->find(1);
 ?>
</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>

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 >
 <?php 
   $result = Load::model('usuario')->find(1);
 ?>
</source>

=== 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 KumbiaPHP debe renderizar el contenido almacenado en el buffer de salida.

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 >
 <?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 vitas.

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 >
/**
 * 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>

== Logger ==
La clase Logger para el manejo de [http://es.wikipedia.org/wiki/Log_(registro) 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.
<pre>
 <?php Logger::error('Mensaje de Error')?>
</pre>
La salida de la instrucción anterior será lo siguiente:
<pre>[Thu, 05 Feb 09 15:19:39 -0500][ERROR] Mensaje de Error</pre>
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.
<pre>
 <?php Logger::error('Mensaje de Error', 'mi_log')?>
</pre>
Se puede apreciar el segundo parámetro ahora el archivo tendrá como nombre '''mi_log.txt'''
=== Métodos de la Clase Logger ===

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==
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:

===Cache::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.

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

<pre>
$data = Cache::get('data');
</pre>

===Cache::save($value, $lifetime=null, $id=false, $group='default')===
Guarda los datos a cachear.

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 '''$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

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


<source lang=php>
Cache::save('hola', null, 'data');
$data = Cache::get('hola');
</source>

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

===Cache::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.

string '''$lifetime''': tiempo de vida de los datos (formato de 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 '''$group''': grupo al cual pertenece

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

===Cache::end()===
Guarda los datos en la cache tomados del buffer de salida.

===Cache::clean($group=false)===
Limpia la cache. Si no se indica grupo limpia toda la cache.

<source lang=php>
Cache::clean('default');
</source>

===Cache::remove($id, $group='default')===
Elimina un elemento específico de la cache

<source lang=php>
Cache::remove('data');
</source>

===Cache::active($active)===
Activa el uso de la cache

<source lang=php>
Cache::active(true);
</source>

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

=== cache($time, $type='view') ===
Para cachear una vista desde la acción:
<pre>
$this->cache('+1 day');
</pre>

Para cachear un template:
<pre>
$this->cache('+1 day', 'template');
</pre>

Si no desea cachear:
<pre>
$this->cache(false);
</pre>

==ActiveRecord==
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.

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

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())===
Valida que el campo sea único

string '''$field''': campo a validar<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_uniqueness_of('cedula', 'message: La cedula ya existe')
$this->validates_uniqueness_of('cedula', array('message'=>'La cedula ya existe'))
...
</source>

===validates_date_in($field, $params=array())===
Valida que el campo sea tipo fecha

string '''$field''': campo a validar<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_date_in('fecha', 'message: Fecha invalida')
$this->validates_date_in('fecha', array('message'=>'Fecha invalida'))
...
</source>


===validates_presence_of($field, $params=array())===
Valida que el campo no sea nulo

string '''$field''': campo a validar<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_presence_of('fecha_opt', 'field: Fecha')
...
</source>


===validates_length_of($field, $max, $min=0, $params=array())===
Valida que el campo no sea nulo

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

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

<source lang=php>
...
$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'))
...
</source>


===validates_inclusion_in($field, $list, $params=array())===
Valida que el campo este incluido en los valores de la lista

string '''$field''': campo a validar<br>
array '''$list''': lista de elementos<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_inclusion_in('seleccion', array('a', 'b'))
...
</source>


===validates_exclusion_of($field, $list, $params=array())===
Valida que el campo no este incluido en los valores de la lista

string '''$field''': campo a validar<br>
array '''$list''': lista de elementos<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_exclusion_of('seleccion', array('a', 'b'))
...
</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>

===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>


===validates_numericality_of($field, $params=array())===
Valida que el campo sea numerico

string '''$field''': campo a validar<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_numericality_of('cedula')
...
</source>


===validates_email_in($field, $params=array())===
Valida que el campo sea un correo electronico

string '''$field''': campo a validar<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_email_in('email')
...
</source>

==Modos de una Aplicación==
'''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===
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===
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 cache de kumbiaphp framework se puede activar nuevamente utilizando el método active de la clase Cache.

<pre>
Cache::active(true);
</pre>

'''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 ==
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 estático '''"Load::models($modelo)"'''

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. 

<source lang=php >
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');
  }
}
</source>

Asimismo se puede indicar con el atributo de controlador $models.

<source lang=php >
class UsuarioController extends ApplicationController {

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

'''Uso avanzado'''

<source lang=php >
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')
  }

}
</source>

== Pages Controller ==
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 [[KumbiaPHP_Framework_Versión_1.0_Spirit#Vistas |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:
<pre>
http://www.dominio.com/pages/show/organizacion/privacidad
</pre>
enseñará la vista views/pages/organizacion/privacidad.phtml
<pre>
http://www.dominio.com/pages/show/aviso
</pre>
enseñara la vista views/pages/aviso.phtml
 
También se puede usar el routes.ini para llamarlo con otro nombre,
<pre>
/aviso = pages/show/aviso
</pre>
Asi al ir a www.dominio.com/aviso enseñara la vista views/pages/aviso.phtml
<pre>
/organizacion/* = pages/show/organizacion/*
</pre>
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.
<pre>
<?php echo link_to('pages/show/aviso', 'Ir Aviso') ?>
</pre>
Mostrará un enlace que al hacer clic ira a dominio.com/pages/show/aviso



== Nuevo Helper ==

=== swf_tag($src) ===

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'''

<source lang="php" line>
<?php echo swf_tag("archivo.swf", "height: 300", "width: 300", "wmode: transparent") ?>
</source>

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

== Filter ==

=== Uso de Filter ===

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::get($s, $options=array()) ===

'''$s (string, array, object)''': array, objeto, o string a filtrar.
<br>
'''$options (array)''': array de configuración del filtro.

Los filtros se aplican de manera recursiva en los arrays y objetos.

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

Asimismo se pueden aplicar filtros en cadena.
<pre>
$value = Filter::get($s, 'trim', 'addslashes');
</pre>

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

=== Filtros ===
Los filtros que existen actualmente son los siguientes:

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

<source lang=php>
$value = Filter::get('hola "gente"', 'addslashes');
</source>

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

<source lang=php>
$value = Filter::get('hola "gente112"', 'alnum');
</source>

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

<source lang=php>
$value = Filter::get('hola "gente112"', 'alpha');
</source>

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

<source lang=php>
if(Filter::date($s, 'date')) {
    ...
}
</source>

==== digits ====
Filtra la cadena eliminando los caracteres que nos son digitos.

<source lang=php>
$value = Filter::get('hola "gente112"', 'digits');
</source>

==== htmlentities ====
Escapa los elementos del lenguaje html con sus correspondientes entidades.

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

'''Opciones:'''<br>
'''charset''': codificación de caracteres de la cadena a escapar.

==== htmlspecialchars ====
Escapa caracteres especial de html.

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

'''Opciones:'''<br>
'''charset''': codificación de caracteres de la cadena a escapar.

==== int ====
Convierte un valor a tipo entero.

<source lang=php>
$value = Filter::get('1.2', 'int');
</source>

==== ipv4 ====
Verifica si la cadena tiene el formato ipv4.

<source lang=php>
if(Filter::get($s, 'ipv4')) {
    ...
}
</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('a1.2', 'numeric');
</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 ===
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/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/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, extensions, models, helpers, etc) donde así lo necesite nuestra aplicación para tal fin se dispone de los siguientes métodos:







==== 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 >
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');
  }
}
</source>

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

<source lang=php >
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()
  {
    /** 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::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 = 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>

==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', 'Administrado');
</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>

===unset_data($index, $namespace='default')===
Elimina el valor para un indice de la sesión actual.

<source lang=php>
Session::unset_data('usuario');
</source>

===isset_data($index, $namespace='default')===
Verifica que este definido el indice en la sesión actual.

<source lang=php>
Session::isset_data('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.

[[Categoría:PHP Framework Benchmarks]]