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

De KumbiaPHP Framework Wiki

Advertencia: no has iniciado sesión. Tu dirección IP se hará pública si haces cualquier edición. Si inicias sesión o creas una cuenta, tus ediciones se atribuirán a tu nombre de usuario, además de otros beneficios.

Puedes deshacer la edición. 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í efectuar la reversión.

Revisión actual Tu texto
Línea 1: Línea 1:
{{cleanupbox
 
|image=[[Archivo:Information_icon4.png|45px]]
 
|imageright=[[Archivo:Information_icon4.png|45px]]
 
|texto ='''Este manual corresponde la versión 1.0 beta 1(Desaconsejada). <br />Se recomienda ver la última versión del [https://github.com/KumbiaPHP/Documentation/tree/master/es Manual de KumbiaPHP 1.0]'''
 
}}
 
 
 
== Introducción ==
 
== Introducción ==
 
En la [https://launchpad.net/kumbia/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 57: Línea 51:
 
</pre>
 
</pre>
  
== Constante en KumbiaPHP==
+
== Nueva Estructura de Directorios ==
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.
+
En la versión de KumbiaPHP se incorpora la siguiente estructura de directorios, a continuación se detallan los elementos mas relevantes:
  
=== APP_PATH ===
 
Constante que contiene la ruta absoluta al directorio donde se encuentra nuestra aplicación (app).
 
 
Ejemplo:
 
 
<pre>
 
<pre>
echo APP_PATH; //la salida es: /var/www/kumbiaphp/app
+
spirit/
</pre>
+
|-- app
 
+
|  |-- application.php
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.
+
|  |-- config
 
+
|  |-- controllers
<pre>
+
|  |-- extensions
   include_once APP_PATH.'libs/test.php';
+
|  |  |-- filters
</pre>
+
|  |  |-- helpers
 
+
|  |  `-- scaffolds
'''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.'''
+
|  |-- index.php
 
+
|  |-- libs
=== CORE_PATH ===
+
|  |-- locale
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.
+
|   |-- model_base.php
 
+
|  |-- models
Ejemplo:
+
|  |-- public
<pre>
+
|  |-- temp
echo CORE_PATH; //la salida es: /var/www/kumbiaphp/core/ 
+
|  `-- views
 +
|      |-- errors
 +
|       |-- pages
 +
|      |-- partials
 +
|      `-- templates
 +
|-- core
 +
|  |-- console
 +
|  |-- docs
 +
|  |-- extensions
 +
|  |  |-- helpers
 +
|  |  `-- scaffolds
 +
|  |-- kumbia
 +
|  |-- libs
 +
|  |-- tests
 +
|  |-- vendors
 +
|  `-- views
 +
|      |-- errors
 +
|      |-- partials
 +
|      `-- templates
 
</pre>
 
</pre>
  
Para incluir archivos que se encuentre bajo este arbol de directorio es el mismo procedimiento que se explico para la constante APP_PATH
+
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.
  
'''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]]'''
+
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.
  
=== PUBLIC_PATH ===
+
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.
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:
+
===Ventajas de esta nueva estructura de directorios===
<pre>
+
* Mayor Velocidad :-)
//Genera un link que ira al controller: controller y action: action
+
* Cada aplicación tiene su propio front controller (index.php)
<a href="<?php echo PUBLIC_PATH ?>controller/action/" title="Mi Link">Mi Link</a>
+
* '''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.
  
//Enlaza una imagen que esta en public/img/imagen.jpg
+
===Explicando dir app===
<img src="<?php echo PUBLIC_PATH ?>img/imagen.jpg" alt="Una Imagen" />
+
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.
  
//Enlaza el archivo CSS en public/css/style.css
+
{| cellpadding="2" cellspacing="2" border="2" style="background: #eee; border: 1px #666 solid; border-collapse: collapse; "
<link rel="stylesheet" type="text/css" href="<?php echo PUBLIC_PATH ?>css/style.css"/>
+
!Directorio!!Descripción
</pre>
+
|-
 
+
|config||Archivos de configuración de nuestra aplicación (config.ini, routes.ini, databases.ini y boot.ini)
'''NOTA: siempre será mejor hacer uso de los helpers'''
+
|-
 
+
|controllers||Estan agrupados los controladores (controllers) y/o módulos. Por defecto se encuentra el controller '''pages_controller.php'''
== 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:
+
|models||Estan agrupados los modelos (models).
 
+
|-
<pre>
+
|views||Estan agrupados las vistas de los controladores (controllers). Por defecto se encuentran los directorios '''templates/''', '''pages/''', '''partials/''' y '''errors/'''
spirit/
+
|-
|-- app
+
|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]
|   |-- application.php
+
|-
|   |-- config
+
|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).
|   |-- controllers
+
|-
|-- extensions
+
|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'''.
|   |   |-- filters
+
|-
|  |  |-- helpers
+
|public||Agrupa las imágenes, css, javascript y files que serán utilizados por nuestra aplicación
|   |   `-- scaffolds
+
|-
|   |-- index.php
+
|locale||Agrupa los archivos para el soporte a la internacionalización i18n para la aplicación.
|-- libs
+
|-
|   |-- locale
+
|'''application.php'''||Super class de los controladores (ApplicationController). 
|   |-- model_base.php
+
|-
|  |-- models
+
|'''model_base.php'''||Super class de los modelos (ActiveRecord). 
|-- public
+
|}
|   |-- temp
+
 
|   `-- views
+
===application.php===
|       |-- errors
+
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.
|       |-- pages
+
 
|       |-- partials
+
[[Archivo:Application_kumbiaphp_framework.png|center|thumb|200px|application.php]]
|       `-- templates
+
 
|-- core
+
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.
|   |-- console
+
 
|   |-- docs
+
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.
|-- extensions
+
 
|   |   |-- helpers
+
El método '''initialize()''' se ejecuta antes de llamar al controller.
|   |  `-- scaffolds
 
|   |-- kumbia
 
|   |-- libs
 
|  |-- tests
 
|  |-- vendors
 
|  `-- views
 
|       |-- errors
 
|       |-- partials
 
|      `-- templates
 
</pre>
 
  
Anteriormente [http://www.kumbiaphp.com KumbiaPHP] utilizaba un fichero '''index.php''' el cual servía para enrutar a cada aplicación utilizando inversión de control, esto erá poco flexible y resultaba en un consumo inadecuado de recursos, por lo tanto en esta nueva versión se preparó una nueva estructura de directorios donde cada aplicación posee un directorio independiente con su '''index.php''' (Front Controller) correspondiente el cual se encarga de cargar las librerías del framework.
+
El método '''finalize()''' se ejecuta despúes de haber llamado al controller.
  
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===
+
=== Ejemplo de application.php ===
* 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===
+
[[Archivo:Ejemplo_application_kumbiaphp_framework.png|center|thumb|600px|application.php]]
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.
+
 
 +
=== 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; "
 
{| cellpadding="2" cellspacing="2" border="2" style="background: #eee; border: 1px #666 solid; border-collapse: collapse; "
 
!Directorio!!Descripción
 
!Directorio!!Descripción
 
|-
 
|-
|config||Archivos de configuración de nuestra aplicación (config.ini, routes.ini, databases.ini y boot.ini)
+
|console||En este directorio se ubican los scripts de terminal que te ayudarán a construir y manejar algunos aspectos de nuestra aplicación
 
|-
 
|-
|controllers||Estan agrupados los controladores (controllers) y/o módulos. Por defecto se encuentra el controller '''pages_controller.php'''
+
|docs||En este directorio se encuentran los detalles de licencia y otros archivos inherentes a la documentación de [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|-
|models||Estan agrupados los modelos (models).
+
|extensions|| En este directorio se encuentran las extensiones compartidas por todas las aplicaciones
 
|-
 
|-
|views||Estan agrupados las vistas de los controladores (controllers). Por defecto se encuentran los directorios '''templates/''', '''pages/''', '''partials/''' y '''errors/'''
+
|kumbia|| En este directorio se ubica el núcleo de [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|-
|extensions||En este directorio se ubican las extensiones para nuestra aplicación, una extensión te permite adicionar nuevas características que serán utilizadas e integradas a la aplicación por medio de las librerías que proporciona [http://www.kumbiaphp.com KumbiaPHP]
+
|libs|| En este directorio se 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.
 
|-
 
|-
|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).
+
|tests||En este directorio se ubican las pruebas unitarias para [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|-
|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'''.
+
|vendors||En este directorio se ubican las librerias de terceros que son compartidas por todas las aplicaciones
|-
 
|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===
+
== config.ini ==
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.
+
Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.
  
[[Archivo:Application_kumbiaphp_framework.png|center|thumb|200px|application.php]]
+
*'''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 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
  
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.
+
<pre>;; Configuracion de Aplicacion
  
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.
+
; Explicación de la Configuración:
  
El método '''initialize()''' se ejecuta antes de llamar al controller.
+
; name: Es el nombre de la aplicación
 
+
; timezone: Es la zona horaria que usará el framework
El método '''finalize()''' se ejecuta despúes de haber llamado al controller.
+
; 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
  
=== Ejemplo de application.php ===
+
[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>
  
[[Archivo:Ejemplo_application_kumbiaphp_framework.png|center|thumb|600px|application.php]]
+
== 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.
  
=== model_base.php ===
+
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]'''
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'''.
+
Lo mismo sucede para los modelos, el atributo <s>$mode</s> fue reemplazado por '''$database'''
  
  NOTA: Los modelos representan las tablas de nuestra Base de Datos.
+
<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.
  
[[Archivo:Model_base_kumbiaphp_framework.png|center|thumb|600px|application.php]]
+
<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
  
=== Explicando dir core/ ===
+
[development]
 
+
host = localhost
{| cellpadding="2" cellspacing="2" border="2" style="background: #eee; border: 1px #666 solid; border-collapse: collapse; "
+
username = root
!Directorio!!Descripción
+
password =
|-
+
name = innogest
|console||En este directorio se ubican los scripts de terminal que te ayudarán a construir y manejar algunos aspectos de nuestra aplicación
+
type = mysql
|-
 
|docs||En este directorio se encuentran los detalles de licencia y otros archivos inherentes a la documentación de [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|extensions|| En este directorio se encuentran las extensiones compartidas por todas las aplicaciones
 
|-
 
|kumbia|| En este directorio se ubica el núcleo de [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|libs|| En este directorio se encuentran las librerias compartidas por todas las aplicaciones, las cuales el [http://wiki.kumbiaphp.com/Team_Development_KumbiaPHP_Framework Equipo de Desarrollo] se responsabiliza por su mantenimiento.
 
|-
 
|tests||En este directorio se ubican las pruebas unitarias para [http://www.kumbiaphp.com KumbiaPHP]
 
|-
 
|vendors||En este directorio se ubican las librerias de terceros que son compartidas por todas las aplicaciones
 
|}
 
  
== config.ini ==
+
[production]
Se agregan opciones para un manejo mas apropiado de la configuración del framework, para la aplicación.
+
host = localhost
 +
username = root
 +
password =
 +
name = test
 +
type = mysql
  
*'''metadata_lifetime''' Tiempo de vida de la metadata cacheada.
+
[test]
*'''database''' Base de datos a utilizar, especificada en databases.ini.
+
host = localhost
*'''production''' Indica si se encuentra en producción.
+
username = root
*'''cache_driver''' driver que se utilizara para el manejo de cache. KumbiaPHP cuenta con tres (3) driver: file, sqlite y memsqlite.
+
password =
*'''locale''' Localización.
+
name = test
*'''routes''' Activar enrutamiento estatico.
+
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.
  
<pre>;; Configuracion de Aplicacion
+
Extensiones Propias de Kumbiaphp Framework
 +
*session
 +
*logger
 +
*auth
 +
*date
 +
*filter
 +
*acl
 +
*benchmark
 +
*security
  
; Explicación de la Configuración:
+
Extensiones externas al framework
 +
*excel
 +
*fpdf
 +
*phpmailer
 +
*libchart
  
; name: Es el nombre de la aplicación
+
<pre>
; timezone: Es la zona horaria que usará el framework
+
; LIBRERIAS DISPONIBLES
; production: Indica si esta en producción
+
; Librerias Propias de KumbiaPHP Framework (libraries)
; database: base de datos a utilizar
+
;   * session
; dbdate: Formato de Fecha por defecto de la Applicación
+
;   * logger
; debug: muestra los errores en pantalla (On|off)
+
;  * auth
; log_exceptions: muestra las excepciones en pantalla (On|off)
+
;  * date
; charset: codificacion de caracteres
+
;   * filter
; cache_driver: driver para la cache (file, sqlite, memsqlite)
+
;   * acl
; metadata_lifetime: Tiempo de vida de la metadata cacheada
+
;   * benchmark
; locale: Localizacion
+
;   * security
; routes: Activar enrutamiento estatico
+
;
 +
; Cargadores en libraries para librerias de terceros (vendors)
 +
;   * excel
 +
;  * fpdf
 +
;   * phpmailer
 +
;   * libchart
  
  
; ¡¡¡ ADVERTENCIA !!!
+
[modules]
; Cuando se efectua el cambio de production=Off, a production=On, es necesario eliminar
+
libs = logger
; el contenido del directorio de cache de la aplicacion para que se renueve
 
; la metadata
 
 
 
[application]
 
name = "KUMBIA PROJECT"
 
;timezone = "America/New_York"
 
production = Off
 
database = development
 
dbdate = YYYY-MM-DD
 
debug = On
 
log_exceptions = On
 
charset = UTF-8
 
cache_driver = file
 
;metadata_lifetime = "+1 year"
 
;locale = es_ES
 
;routes = On
 
 
</pre>
 
</pre>
  
== databases.ini ==
+
Es decir, se usa libs= en vez de extensions=
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.
+
Y también se quita el prefijo kumbia.
  
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]'''
+
'''KumbiaPHP 0.5'''
 
+
<pre>
Lo mismo sucede para los modelos, el atributo <s>$mode</s> fue reemplazado por '''$database'''
+
[modules]
 +
extensions = kumbia.logger, kumbia.auth
 +
</pre>
 +
'''KumbiaPHP 1.0'''
 +
<pre>
 +
[modules]
 +
libs = logger, auth
 +
</pre>
  
<source lang=php>
+
== Router ==
class Usuarios extends ActiveRecord
+
Mejoras de Rendimiento.
{
 
    public $database = 'test';
 
}
 
</source>
 
  
Ahora KumbiaPHP Framework buscara los datos de conexión de la sección '''[test]''', para el modelo Usuarios.
+
== Dispatcher ==
 +
Mejoras de Rendimiento.
  
<pre>
+
== Clase Kumbia ==
; KumbiaPHP Web Framework Configuration
+
Mejoras de Rendimiento.
; Parámetros de base de datos
 
; Utiliza el nombre del controlador nativo (mysql, pgsql, oracle)
 
; Coloca pdo = On si usas PHP Data Objects
 
  
[development]
+
== Vistas ==
host = localhost
+
[[Imagen:Vistas_1.0_spirit.jpg|Estructura de Vistas KumbiaPHP Framework V1.0 Spirit|right|frameless|400px]]
username = root
+
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.
password = 1qaz2WSX
 
name = test
 
type = mysql
 
  
[production]
+
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.
host = localhost
 
username = root
 
password = 1qaz2WSX
 
name = test
 
type = mssql
 
  
[test]
+
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:
host = localhost
+
#views/templates/
username = root
+
#views/partials/
password = 1qaz2WSX
 
name = test
 
type = mssql
 
</pre>
 
  
== boot.ini ==
+
=== views/templates/ ===
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.
+
Los [http://en.wikipedia.org/wiki/Template_(file_format) Template] son un tipo de archivo pre-formateado utilizado como base para otros archivos.
O mejor usar el Load::lib('lib')
 
  
== Router ==
+
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:
Mejoras de Rendimiento.
 
  
== Dispatcher ==
+
<source lang=php>  
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 agregar cuantos se desee y poderlo cambiar desde nuestro controlador de la siguiente forma:
 
 
 
<source lang=php>  
 
 
  class PruebaController extends ApplicationController  
 
  class PruebaController extends ApplicationController  
 
  {
 
  {
Línea 512: Línea 510:
  
 
     echo $code;
 
     echo $code;
 +
}
 
}
 
}
 
</source>
 
</source>
Línea 699: Línea 698:
  
 
==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')===
 +
Obtiene los datos cacheados. Los elementos cacheados pueden agruparse en grupos, lo cual permite evitar colisiones entre elementos cacheados con igual $id.
  
===Cache::driver($driver=null)===
+
string '''$id''': identificador del elemento cacheado<br>
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'''.
+
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
  
Ejemplos:
+
<pre>
 
+
$data = Cache::get('data');
<source lang=php>
+
</pre>
// 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.
 
 
 
string '''$id''': identificador del elemento cacheado<br>
 
string '''$group''': grupo al cual pertenece el elemento cacheado (por defecto "default")
 
 
 
<source lang=php>
 
$data = Cache::driver()->get('data');
 
</source>
 
  
===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.
  
Línea 741: Línea 719:
  
 
<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 748: Línea 726:
 
     <?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 756: Línea 734:
  
 
<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('data');
 
</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 770: Línea 748:
  
 
<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>
 
</source>
 +
 +
  
 
==Cacheo automático de views y templates==
 
==Cacheo automático de views y templates==
Línea 1005: Línea 985:
  
 
===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===
Línea 1375: Línea 1355:
 
</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 1447: Línea 1427:
 
     //Se carga core/libs/auth/auth.php, siempre que no exista algún archivo
 
     //Se carga core/libs/auth/auth.php, siempre que no exista algún archivo
 
     //con el mismo nombre en app/libs/ ya que KumbiaPHP da prioridad a tu app sobre el core.
 
     //con el mismo nombre en app/libs/ ya que KumbiaPHP da prioridad a tu app sobre el core.
     Load::lib('auth');
+
     Load::lib('Auth');
 
   }
 
   }
 
}
 
}
Línea 1487: Línea 1467:
 
Quedando la extensions Session con los siguientes métodos para el manejo de la sessiones.
 
Quedando la extensions Session con los siguientes métodos para el manejo de la sessiones.
  
===set($index, $value, $namespace='default')===
+
===set($index, $value, $namespace='default')===
Crear o especifica el valor para un indice de la sesión actual.
+
Crear o especifica el valor para un indice de la sesión actual.
 
+
 
<source lang=php>
+
<source lang=php>
Session::set('usuario', 'Administrador');
+
Session::set('usuario', 'Administrador');
</source>
+
</source>
 
+
 
===get($index, $namespace='default')===
+
===get($index, $namespace='default')===
Obtener el valor para un indice de la sesión actual.
+
Obtener el valor para un indice de la sesión actual.
 
+
 
<source lang=php>
+
<source lang=php>
Session::get('usuario');//retorna 'Administrador'
+
Session::get('usuario');//retorna 'Administrador'
</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>
 
+
 
 
+
 
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==
 
==Upload==

Ten en cuenta que todas las contribuciones a KumbiaPHP Framework Wiki pueden ser editadas, modificadas o eliminadas por otros colaboradores. Si no deseas que las modifiquen sin limitaciones, no las publiques aquí.
Al mismo tiempo, asumimos que eres el autor de lo que escribiste, o lo copiaste de una fuente en el dominio público o con licencia libre (véase Proyecto:Derechos de autor para más detalles). ¡No uses textos con copyright sin permiso!

Para editar esta página, responde la pregunta que aparece abajo (más información):

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

Plantilla usada en esta página: