Integrar KumbiaPHP Spirit con jQuery

De KumbiaPHP Framework Wiki
Saltar a: navegación, buscar


En el siguiente ejemplo veremos como se puede integrar KumbiaPHP Framework versión 1.0 con jQuery de forma rápida y sencilla para explotar las bondades que ofrece este framework de javascript.

Se estima que en la versión 1.o de KumbiaPHP los helpers para el manejo de ajax estarán migrado hacia jQuery.

Instalar jQuery[editar]

Lo primero es descargar la versión mas actual de jQuery, en este caso la versión 1.3.2, una vez descargada se colocaran las librerías en el directorio:

[app]/public/javascript/jquery/

application.js[editar]

Este archivo ha sido creado para hacer mas simple el manejo de jQuery dentro de KumbiaPHP.

Creamos el archivo application.js y lo ubicamos en el directorio [app]/public/javascript/kumbia/ con el siguiente contenido.

jQuery(function($) {
 
	$("a.jsShow").live('click' , function(event) {
				event.preventDefault();
				$(this.rel).show();
				});
 
	$("a.jsHide").live('click', function(event) {
				event.preventDefault();
				$(this.rel).hide();
				});
 
	$("a.jsToggle").live('click', function(event) {
				event.preventDefault();
				$(this.rel).toggle();
				});
 
	$("a.jsRemote").live('click', function(event) {
				event.preventDefault();
				$(this.rel).load(this.href)
				});
 
});

Este archivo cuenta con una serie de class utiles para el manejo de AJAX.

  • jsRemote hace peticiones al servidor, es decir carga una action en KumbiaPHP y su vista si asi nuestra lógica lo indicara.
  • jsHide Oculta un objeto del DOM.
  • jsShow Muestra el objeto del DOM oculto.
  • jsToggle Muestra/Oculta un Objeto del DOM.

Incluir jQuery y application.js en el template[editar]

Ahora se necesita incluir estas librerias en el Template para que comiencen a realizar su trabajo y esto se aprecia en la líneas 7 y 8, muy importante el orden en la que se incluyen ya que el archivo application.js depende de jQuery por ende estas deben estar cargadas para cuando este archivo iniciado.

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3.  <head>
  4.   <meta http-equiv='Content-type' content='text/html; charset=<?php echo APP_CHARSET ?>' />
  5.   <title>KumbiaPHP web &amp; app Framework</title>
  6.   <?php echo stylesheet_link_tag('bienvenida') ?>
  7.   <?php echo javascript_include_tag('jquery/jquery-1.3.2.min') ?>
  8.   <?php echo javascript_library_tag('application') ?>
  9.   <?php echo stylesheet_link_tag('style') ?>
  10.   <?php echo stylesheet_link_tags(); ?>
  11. </head>
  12. <body>
  13.     <div id='content'>
  14.         <div id='head'>
  15.             <h1 id='logo'>KumbiaPHP</h1><div id='info-app'>web &amp; app Framework versión <?php echo Kumbia::KUMBIA_VERSION ?></div>
  16.  
  17.             <div class='alignright'>
  18.                 <p id='config'>
  19.                     <span class='app'><?php echo APP ?></span> 
  20.                     <?php echo link_to('status/', 'Config', 'title: Ver configuración de '.APP) ?>
  21.                 </p>
  22.              </div>
  23.         </div>
  24.  
  25.         <?php View::content(); ?>
  26.  
  27.         <?php View::partial('kumbia/footer') ?>
  28.     </div>
  29. </body>
  30. </html>

Veamos un Ejemplo[editar]

Ahora veremos un ejemplo para apreciar de formas precisa lo que podemos hacer. El ejemplo estará en base al mismo Template que viene en la instalación de KumbiaPHP donde se muestra la bienvenida y la petición AJAX irá específicamente para mostrar la página de status (link Config).

Antes de continuar veamos el comportamiento al hacer click en el link Config, Ver detalles de la Nueva Pantalla de Bienvenida de KumbiaPHP

Eso lo cambiaremos por una petición donde no se cargara todo el Template sino solo el View

Los cambios son triviales solo se le indicara al link Config que ahora enviara una petición asíncrona y actualizara un objeto del DOM (en este caso un DIV), entonces son dos cambios.

Agregamos dos elementos al helpers link_to un rel y una class, ambos tienen un significado.

rel: indica el objeto del DOM a actualizar, en este caso sera el id mi-div.

class: Es quien activa el evento en jQuery, en este caso esa class realiza una petición asíncrona.

<?php echo link_to('status/', 'Config', 'title: Ver configuración de '.APP, 'rel: #mi-div', 'class: jsRemote') ?>
<div id="mi-div"><?php View::content(); ?></div>

Quedando el Template [app]/views/templates/default.phtml de la siguiente forma con los cambios de arriba aplicados.

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3.  <head>
  4.   <meta http-equiv='Content-type' content='text/html; charset=<?php echo APP_CHARSET ?>' />
  5.   <title>KumbiaPHP web &amp; app Framework</title>
  6.   <?php echo stylesheet_link_tag('bienvenida') ?>
  7.   <?php echo javascript_include_tag('jquery/jquery-1.3.2.min') ?>
  8.   <?php echo javascript_library_tag('application') ?>
  9.   <?php echo stylesheet_link_tag('style') ?>
  10.   <?php echo Kumbia::stylesheet_link_tags(); ?>
  11. </head>
  12. <body>
  13.     <div id='content'>
  14.         <div id='head'>
  15.             <h1 id='logo'>KumbiaPHP</h1><div id='info-app'>web &amp; app Framework versión <?php echo Kumbia::KUMBIA_VERSION ?></div>
  16.  
  17.             <div class='alignright'>
  18.                 <p id='config'>
  19.                     <span class='app'><?php echo APP ?></span> 
  20.                     <?php echo link_to('status/', 'Config', 'title: Ver configuración de '.APP, 'rel: #mi-div', 'class: jsRemote') ?>
  21.                 </p>
  22.              </div>
  23.         </div>
  24.  
  25.         <div id="mi-div"><?php View::content(); ?></div>
  26.  
  27.         <?php View::partial('kumbia/footer') ?>
  28.     </div>
  29. </body>
  30. </html>
.