Beruflich Dokumente
Kultur Dokumente
14.2 forms/config/config.ini ..................................................................................................... 14.3 forms/config/core.ini ........................................................................................................ 14.3.1 Cmo usar el parmetro extensions?.......................................................................... 14.4 forms/config/routes.ini ..................................................................................................... 15 A partir de un Modelo MVC........................................................................................................ 16 Explicando la Implementacin MVC............................................................................................ 16.1 Introduccin ...................................................................................................................... 16.2 Conceptos ......................................................................................................................... 16.3 Ejemplo ............................................................................................................................. 17 Primera Aplicacin en Kumbia.................................................................................................... 17.1 Creando una nueva aplicacin ........................................................................................... 17.2 Hola Kumbia ...................................................................................................................... 17.3 Kumbia URLS ..................................................................................................................... 17.4 Nuestra Primera Accin ..................................................................................................... 17.5 Agregando ms Contenido ................................................................................................ 17.6 Repitiendo la Historia ........................................................................................................ 18 Modelos y Bases de Datos en Kumbia......................................................................................... 18.1 Introduccin ...................................................................................................................... 18.2 Capa de Abstraccin Independiente ................................................................................... 18.3 Adaptadores Kumbia ......................................................................................................... 19 Esquema de Acceso a Bases de Datos en Kumbia ....................................................................... 19.1 Modelos ............................................................................................................................ 20 Acceso Directo a RDBMS............................................................................................................ 20.1 La Clase DB ....................................................................................................................... 20.2 Crear una instancia de DB .................................................................................................. Uso de la Funcin db::raw_connect() ........................................................................................... 20.3 Propiedades de la Clase DB ................................................................................................ 20.3.1 $db->Id_Connection................................................................................................... 20.3.2 $db->lastResultQuery ................................................................................................ 20.3.3 $db->dbUser.............................................................................................................. 20.3.4 $db->dbHost ............................................................................................................ 20.3.5 $db->dbPort ............................................................................................................. 20.3.6 $db->dbPass ............................................................................................................. 20.3.7 $db->lastError ........................................................................................................... 20.3.8 $db->dbName ........................................................................................................... 20.4 Mtodos de la Clase DB ..................................................................................................... 20.4.1 Connect ..................................................................................................................... 20.4.2 Query ........................................................................................................................ 20.4.3 Close ......................................................................................................................... 20.4.4 Fetch Array ................................................................................................................ 20.4.5 Num Rows ................................................................................................................. 20.4.6 Field Name ................................................................................................................. 20.4.7 Data Seek ................................................................................................................... 20.4.8 Affected Rows ............................................................................................................ 20.4.9 Error .......................................................................................................................... 20.4.10 No Error ...................................................................................................................
37 38 38 39 41 42 42 43 43 45 45 46 47 47 48 49 51 51 51 51 52 52 53 53 53 53 53 53 53 53 54 54 54 54 54 54 54 54 54 55 55 55 56 56 56 56
20.4.11 Find ......................................................................................................................... 56 20.4.12 In Query ................................................................................................................... 57 20.4.13 In Query Assoc ......................................................................................................... 57 20.4.14 In Query Num .......................................................................................................... 57 20.4.15 Fetch One ................................................................................................................ 57 20.4.16 Table Exists ............................................................................................................. 58 21 Por qu usar una capa de Abstraccin?..................................................................................... 59 22 La Vida sin ActiveRecord............................................................................................................ 60 23 Parmetros con Nombre!........................................................................................................... 61 24 ActiveRecord.............................................................................................................................. 62 24.1 Ventajas del Active Record ................................................................................................. 62 24.2 Crear un Modelo en Kumbia ............................................................................................... 62 24.3 Columnas y Atributos ........................................................................................................ 62 24.4 Llaves Primarias y el Uso de IDs ......................................................................................... 63 24.5 CRUD: Create (Crear), Read (Leer), Update (Actualizar), Delete (Borrar) ............................... 64 24.5.1 Creando Registros ..................................................................................................... 64 24.5.2 Consultando Registros ............................................................................................... 64 24.5.3 El poderoso Find ........................................................................................................ 65 24.5.4 Promedio, Contando, Sumando, Mnimo y Mximo ..................................................... 66 24.5.5 Actualizando Registros existentes .............................................................................. 67 24.5.6 Borrando Registros ..................................................................................................... 67 24.5.7 Propiedades Soportadas.............................................................................................. 67 24.6 Convenciones en ActiveRecord........................................................................................... 67 24.6.1 Convenciones Generales ............................................................................................. 68 24.6.2 Id ............................................................................................................................... 68 24.6.3 campo_id ................................................................................................................... 68 24.6.4 campo_at ................................................................................................................... 68 24.6.5 campo_in ................................................................................................................... 68 24.7 Convenciones para RDBMs ................................................................................................. 68 24.7.1 Convenciones Especiales para PostgreSQL .................................................................. 68 24.7.2 Convenciones Especiales para Oracle .......................................................................... 68 25 Active Record API....................................................................................................................... 69 25.1 Consulta ........................................................................................................................... 69 25.1.1 distinct ...................................................................................................................... 69 25.1.2 find_all_by_sql (string $sql) ........................................................................................ 69 25.1.3 find_by_sql (string $sql) ............................................................................................. 70 25.1.4 find_first .................................................................................................................... 70 25.1.5 find ........................................................................................................................... 71 25.1.6 select_one(string $select_query) ................................................................................. 72 25.1.7 select_one(string $select_query) (static) ...................................................................... 72 25.1.8 exists ......................................................................................................................... 72 25.1.9 find_all_by.................................................................................................................. 73 25.1.10 find_by_*campo*....................................................................................................... 73 25.1.11 find_all_by_*campo*.................................................................................................. 73 25.2 Conteos y Sumatorias ........................................................................................................ 73 25.2.1 count.......................................................................................................................... 73
25.2.2 sum............................................................................................................................ 25.2.3 count_by_sql............................................................................................................... 25.3 Promedios, Mximos y Minmos ......................................................................................... 25.3.1 average....................................................................................................................... 25.3.2 maximum .................................................................................................................. 25.3.3 minimum ................................................................................................................... 25.4 Creacin/Actualizacin/Borrado de Registros..................................................................... 25.4.1 create ........................................................................................................................ 25.4.2 update ....................................................................................................................... 25.4.3 update_all .................................................................................................................. 25.4.4 save ........................................................................................................................... 25.4.5 create_from_request .................................................................................................. 25.4.6 save_from_request ..................................................................................................... 25.4.7 delete ........................................................................................................................ 25.4.8 delete_all ................................................................................................................... 25.5 Validacin ......................................................................................................................... 25.5.1 validates_presence_of ................................................................................................ 25.5.2 validates_length_of .................................................................................................... 25.5.3 validates_numericality_of ........................................................................................... 25.5.4 validates_email_in ...................................................................................................... 25.5.5 validates_uniqueness_of ............................................................................................. 25.5.6 validates_date_in ........................................................................................................ 25.5.7 validates_format_of .................................................................................................... 25.6 Transacciones ................................................................................................................... 25.6.1 commit() .................................................................................................................... 25.6.2 begin() ....................................................................................................................... 25.6.3 rollback() ................................................................................................................... 25.7 Otros Metodos .................................................................................................................. 25.7.1 sql(string $sql) ........................................................................................................... 26 Validacin en ActiveRecord........................................................................................................ 27 Callbacks en ActiveRecord......................................................................................................... 27.1.1 before_validation........................................................................................................ 27.1.2 before_validation_on_create........................................................................................ 27.1.3 before_validation_on_update ...................................................................................... 27.1.4 after_validation_on_create .......................................................................................... 27.1.5 after_validation_on_update ......................................................................................... 27.1.6 after_validation .......................................................................................................... 27.1.7 before_save ............................................................................................................... 27.1.8 before_update............................................................................................................. 27.1.9 before_create.............................................................................................................. 27.1.10 after_update ............................................................................................................ 27.1.11 after_create............................................................................................................... 27.1.12 after_save ................................................................................................................ 27.1.13 before_delete............................................................................................................ 27.1.14 after_delete .............................................................................................................. 28 Transaccionalidad......................................................................................................................
73 73 73 73 74 74 74 74 74 74 75 75 75 75 75 75 75 76 76 76 77 77 77 77 77 78 78 78 78 79 80 80 80 80 81 81 81 81 81 81 81 81 81 82 82 83
29 Persistencia............................................................................................................................... 84 30 Traza y Debug en ActiveRecord.................................................................................................. 85 30.1 Traza en Pantalla ............................................................................................................... 85 30.2 Mostrar Errores en Objetos ActiveRecord ........................................................................... 86 31 Asociaciones.............................................................................................................................. 87 31.1 Como usar Asociaciones? ................................................................................................. 87 32 Generacin De Formularios........................................................................................................ 91 32.1 Tipos de Formularios ......................................................................................................... 91 32.2 Ventajas Generadores de Formularios ................................................................................ 92 32.3 Desventajas Generadores de Formularios ........................................................................... 92 33 StandardForm............................................................................................................................ 93 33.1 Introduccin ...................................................................................................................... 93 33.2 Crear un controlador para el Formulario Album................................................................... 93 33.3 Convenciones de los Nombres de las Columnas ................................................................. 94 33.3.1 id ............................................................................................................................... 94 33.3.2 tabla_id ...................................................................................................................... 94 33.3.3 campo_at ................................................................................................................... 95 33.3.4 campo_in ................................................................................................................... 95 33.3.5 email.......................................................................................................................... 95 33.4 Comportamiento de un Formulario Standard ...................................................................... 95 33.5 Propiedades de un Formulario Standard ............................................................................. 95 33.5.1 $scaffold (True o False) .............................................................................................. 95 33.5.2 $source ..................................................................................................................... 95 33.6 Mtodos de la Clase StandardForm .................................................................................... 96 33.6.1 set_form_caption($title) ............................................................................................. 96 33.6.2 use_helper($campo) ................................................................................................... 96 33.6.3 set_type_time($campo) .............................................................................................. 97 33.6.4 set_type_textarea($campo) ......................................................................................... 97 33.6.5 set_type_image($campo) ............................................................................................ 97 33.6.6 set_type_numeric($campo) ......................................................................................... 97 33.6.7 set_type_date($campo) ............................................................................................... 97 33.6.8 set_type_email($campo) ............................................................................................. 98 33.6.9 set_type_password($campo) ....................................................................................... 98 33.6.10 set_text_upper($campo) ........................................................................................... 98 33.6.11 set_combo_static($camo, array $valores) .................................................................. 98 33.6.12 set_combo_dynamic($campo, $tabla, $campoDetalle, column_relation: $campo) .... 98 33.6.13 ignore($campo) ........................................................................................................ 99 33.6.14 set_size($campo, $size) ........................................................................................... 99 33.6.15 set_maxlength($campo, $length) ........................................................................... 100 33.6.16 not_browse($campo, [$campo2, ...]) ....................................................................... 100 33.6.17 not_report($campo) ............................................................................................... 100 33.6.18 set_title_image($im) ............................................................................................... 100 33.6.19 fields_per_row($number) ........................................................................................ 100 33.6.20 unable_insert ......................................................................................................... 100 33.6.21 unable_delete ........................................................................................................ 100 33.6.22 unable_update ....................................................................................................... 100
33.6.23 unable_query ......................................................................................................... 33.6.24 unable_browse ....................................................................................................... 33.6.25 unable_report ........................................................................................................ 33.6.26 route_to($controller,$action,$id) ............................................................................ 33.6.27 set_hidden($campo) ............................................................................................... 33.6.28 set_query_only($campo) ......................................................................................... 33.6.29 set_caption($campo, $caption) ............................................................................... 33.6.30 set_action_caption($action, $caption) ..................................................................... 33.6.31 set_event($action, $caption) ................................................................................... 33.6.32 set_attribute($field, $attribute,$value) .................................................................... 33.6.33 show_not_nulls()..................................................................................................... 33.7 Eventos del lado del Cliente (Callbacks) ............................................................................ 33.7.1 before_enable_insert................................................................................................. 33.7.2 after_enable_insert ................................................................................................... 33.7.3 before_enable_update .............................................................................................. 33.7.4 after_enable_update ................................................................................................. 33.7.5 before_enable_query ................................................................................................ 33.7.6 after_enable_query ................................................................................................... 33.7.7 before_validation ..................................................................................................... 33.7.8 after_validation ........................................................................................................ 33.7.9 before_insert ........................................................................................................... 33.7.10 before_update ........................................................................................................ 33.7.11 before_query .......................................................................................................... 33.7.12 before_report ......................................................................................................... 33.7.13 before_cancel_input(action) .................................................................................... 33.8 Eventos del lado del Servidor (Callbacks) .......................................................................... 33.8.1 before_insert ........................................................................................................... 33.8.2 after_insert .............................................................................................................. 33.8.3 before_update .......................................................................................................... 33.8.4 after_update ............................................................................................................ 33.8.5 validation ................................................................................................................. 33.8.6 before_delete ........................................................................................................... 33.8.7 after_delete .............................................................................................................. 33.8.8 before_fetch ............................................................................................................. after_fetch ........................................................................................................................... 33.9 Trabajando con Imgenes ................................................................................................ 33.10 Validaciones (A nivel de Campo) .................................................................................... 33.11 Combos Estticos .......................................................................................................... 33.12 Cambiando el aspecto de Formularios StandardForm...................................................... 34 Grid-Form............................................................................................................................... 35 Master-Detail........................................................................................................................... 36 Controladores.......................................................................................................................... 36.1 Ejemplo ........................................................................................................................... 36.2 Creacin de un Controlador ............................................................................................. 37 ApplicationController............................................................................................................... 37.1 Mtodos de la Clase ApplicationController .......................................................................
100 101 101 101 101 101 101 101 102 102 102 103 103 103 103 103 103 103 103 103 103 104 104 104 104 105 106 106 106 106 106 106 106 107 107 107 107 108 108 111 112 114 114 115 116 116
37.1.1 render($view) ........................................................................................................... 116 37.1.2 redirect($url, $seconds=0.5) .................................................................................... 116 37.1.3 post($value) ............................................................................................................. 117 37.1.4 get($value) ............................................................................................................... 117 37.1.5 request($value) ........................................................................................................ 117 37.1.6 render_partial($name) .............................................................................................. 117 37.1.7 route_to([params: valor]) .......................................................................................... 117 37.1.8 redirect($url_controlador)......................................................................................... 118 37.1.9 cache_layout($minutes) ............................................................................................ 118 37.1.10 not_found($controller, $action) .............................................................................. 118 37.1.11 set_response($type) ............................................................................................... 118 37.1.12 is_alnum($valor)...................................................................................................... 119 37.1.13 is_numeric($valor)................................................................................................... 119 38 Obtener valores desde una de Kumbia..................................................................................... 120 39 Persistencia en Controladores.................................................................................................. 123 40 Filtros en Controladores........................................................................................................... 125 40.1.1 before_filter($controller, $action, $id)....................................................................... 125 40.1.2 after_filter($controller, $action, $id).......................................................................... 125 40.1.3 not_found($controller, $action, $id).......................................................................... 126 41 ApplicationControllerBase........................................................................................................ 127 42 Enrutamiento y Redirecciones.................................................................................................. 128 42.1 Por qu re-direccionamiento? ......................................................................................... 128 42.2 Esttico............................................................................................................................ 128 42.3 Dinmico ......................................................................................................................... 129 43 Vistas...................................................................................................................................... 130 43.1 Porque usar Vistas? ......................................................................................................... 130 43.2 Uso de Vistas .................................................................................................................. 131 43.3 Uso de Layouts ................................................................................................................ 132 43.4 Uso de Templates ............................................................................................................ 133 43.5 Uso de Partials ................................................................................................................ 133 43.6 Uso de content()............................................................................................................... 133 44 Vista Helpers........................................................................................................................... 134 44.1.1 link_to($accion, $texto, [$parametros])..................................................................... 134 44.1.2 link_to($accion, $texto, [$parametros])..................................................................... 134 44.1.3 link_to_remote($accion, $texto, $objeto_a_actualizar, [$parametros])........................ 134 44.1.4 button_to_remote_action($accion, $texto, $objeto_a_actualizar, [$parametros])........ 135 44.1.5 javascript_include_tag($archivo_js)............................................................................ 135 44.1.6 javascript_library_tag($archivo_js)............................................................................. 135 44.1.7 stylesheet_link_tag($archivo_css).............................................................................. 135 44.1.8 img_tag($src)............................................................................................................ 135 44.1.9 form_remote_tag($action, $objeto_que_actualiza)..................................................... 136 44.1.10 form_tag($action).................................................................................................... 136 44.1.11 end_form_tag()........................................................................................................ 136 44.1.12 comillas($texto)...................................................................................................... 136 44.1.13 submit_tag($caption).............................................................................................. 137 44.1.14 submit_image_tag($caption, $src)........................................................................... 137
44.1.15 button_tag($caption)............................................................................................... 44.1.16 text_field_tag($nombre).......................................................................................... 44.1.17 checkbox_field_tag($nombre).................................................................................. 44.1.18 numeric_field_tag($nombre).................................................................................... 44.1.19 textupper_field_tag($nombre)................................................................................. 44.1.20 date_field_tag($nombre)......................................................................................... 44.1.21 file_field_tag($nombre)........................................................................................... 44.1.22 radio_field_tag($nombre, $lista).............................................................................. 44.1.23 textarea_tag($nombre)............................................................................................ 44.1.24 password_field_tag($nombre).................................................................................. 44.1.25 hidden_field_tag($name)......................................................................................... 44.1.26 select_tag($name, $lista)......................................................................................... 44.1.27 option_tag($valor, $texto)....................................................................................... 44.1.28 upload_image_tag($nombre)................................................................................... 44.1.29 set_droppable($nombre, $accion)............................................................................ 44.1.30 redirect_to($url, $segundos)................................................................................... 44.1.31 render_partial($vista_partial, $valor='').................................................................... 44.1.32 br_break($numero) ................................................................................................ 44.1.33 tr_break($numero) ................................................................................................. 44.1.34 tr_color($color1, $color2, [$colorn...])..................................................................... 44.1.35 updater_select($nombre) ........................................................................................ 44.1.36 text_field_with_autocomplete($nombre).................................................................. 44.1.37 truncate($texto, $numero=0).................................................................................. 44.1.38 highlight($texto, $texto_a_resaltar)......................................................................... 44.1.39 money($valor)......................................................................................................... 45 Uso de Flash ........................................................................................................................... 45.1 Flash::error....................................................................................................................... 45.2 Flash::success.................................................................................................................. 45.3 Flash::notice..................................................................................................................... 45.4 Flash::warning.................................................................................................................. 46 Integrar (MVC) en Kumbia........................................................................................................ 46.1 Ejemplo Sencillo .............................................................................................................. 47 Uso de Paquetes (Namespaces)................................................................................................ 48 Usando AJAX............................................................................................................................ 48.1 Introduccin .................................................................................................................... 48.2 XMLHttpRequest .............................................................................................................. 48.3 Como usar AJAX en Kumbia? .......................................................................................... 48.4 link_to_remote ................................................................................................................ 48.5 form_remote_tag ............................................................................................................. 49 JavaScript y Kumbia................................................................................................................. 49.1 El Objeto AJAX.................................................................................................................. 49.2 AJAX.viewRequest ............................................................................................................ 49.3 AJAX.xmlRequest.............................................................................................................. 49.4 AJAX.execute.................................................................................................................... 49.5 AJAX.query ...................................................................................................................... 49.6 Ajax.Request y Ajax.Updater.............................................................................................
137 137 137 137 137 138 138 138 138 138 138 139 139 139 139 139 139 140 140 140 140 141 141 142 142 143 143 143 143 143 144 144 146 147 147 148 148 148 150 152 152 152 153 154 155 155
49.7 Ajax.PeriodicalUpdater..................................................................................................... 50 Prototype en Kumbia................................................................................................................ 50.1 General ........................................................................................................................... 50.1.1 $.............................................................................................................................. 50.1.2 $F ............................................................................................................................ 50.1.3 $V ........................................................................................................................... 50.1.4 $C............................................................................................................................ 50.2 Number ........................................................................................................................... 50.2.1 times ....................................................................................................................... 50.2.2 upto ........................................................................................................................ 50.2.3 downto .................................................................................................................... 50.2.4 next ......................................................................................................................... 50.2.5 step ......................................................................................................................... 50.3 Array ............................................................................................................................... 50.3.1 clear ........................................................................................................................ 50.3.2 clone ....................................................................................................................... 50.3.3 compact ................................................................................................................... 50.3.4 each ........................................................................................................................ 50.3.5 first ......................................................................................................................... 50.3.6 indexOf ................................................................................................................... 50.3.7 inspect ..................................................................................................................... 50.3.8 last .......................................................................................................................... 50.3.9 reduce ..................................................................................................................... 50.3.10 reverse ................................................................................................................... 50.3.11 max........................................................................................................................ 50.3.12 inject...................................................................................................................... 51 Efectos Visuales y Script.Aculo.Us............................................................................................ 51.1 Efectos Bsicos................................................................................................................. 51.1.1 Effect.Opacity............................................................................................................ 51.1.2 Effect.Scale............................................................................................................... 51.1.3 Effect.Morph............................................................................................................. 51.1.4 Effect.Move............................................................................................................... 51.1.5 Effect.Highlight......................................................................................................... 51.1.6 Effect.Parallel ........................................................................................................... 51.2 Efectos Combinados......................................................................................................... 51.2.1 Effect.Appear............................................................................................................ 51.2.2 Effect.Fade................................................................................................................ 51.2.3 Effect.Puff................................................................................................................. 51.2.4 Effect.DropOut.......................................................................................................... 51.2.5 Effect.Shake.............................................................................................................. 51.2.6 Effect.SwitchOff......................................................................................................... 51.2.7 Effect.BlindDown....................................................................................................... 51.2.8 Effect.BlindUp........................................................................................................... 51.2.9 Effect.SlideDown....................................................................................................... 51.2.10 Effect.SlideUp.......................................................................................................... 51.2.11 Effect.Pulsate..........................................................................................................
156 157 157 157 158 158 158 159 159 159 159 160 160 160 160 160 161 161 161 161 162 162 162 162 163 163 164 164 166 167 167 168 168 169 170 170 171 171 171 171 171 172 172 172 172 172
10
51.2.12 Effect.Squish........................................................................................................... 173 51.2.13 Effect.Fold............................................................................................................... 173 51.2.14 Effect.Grow............................................................................................................. 173 51.2.15 Effect.Shrink........................................................................................................... 173 51.3 Objetos Arrastables.......................................................................................................... 173 51.3.1 Ejemplos................................................................................................................... 174 51.4 Objetos que Reciben Objetos Arrastrables........................................................................ 174 51.5 Ms Informacin............................................................................................................... 176 52 Ventanas PrototypeWindows.................................................................................................... 177 52.1 Uso de las Ventanas Prototype.......................................................................................... 177 52.2 Referencia de Clases y Objetos de Prototype Windows....................................................... 179 52.2.1 Clase Window............................................................................................................ 179 52.3 Ejemplos de Prototype Windows........................................................................................ 182 52.3.1 Abriendo una Ventana Sencilla.................................................................................. 182 52.3.2 Abrir una ventana usando una URL............................................................................ 182 52.3.3 Abre una ventana con un contenido existente............................................................ 183 52.3.4 Abriendo una cuadro de dialogo usando AJAX........................................................... 184 52.3.5 Abrir un cuadro de Dialogo de Alerta......................................................................... 184 53 Funciones de Reportes............................................................................................................. 185 53.1 Manual de Referencia de FPDF ......................................................................................... 185 53.2 Qu es FPDF? ................................................................................................................. 185 54 Correo Electrnico................................................................................................................... 186 54.1 Qu es PHPMailer? .......................................................................................................... 186 54.2 Por qu usar phpmailer? ................................................................................................. 186 54.3 Ejemplo ........................................................................................................................... 187 55 Integracin con Smarty............................................................................................................ 190 55.1 Qu es Smarty? .............................................................................................................. 190 55.2 Como se integra Smarty a Kumbia ................................................................................... 191 56 Loggers................................................................................................................................... 192 56.1 Mtodos de la Clase Logger ............................................................................................. 192 56.1.1 constructor .............................................................................................................. 192 56.1.2 log($message, $type) ............................................................................................... 192 56.1.3 begin ....................................................................................................................... 192 56.1.4 commit .................................................................................................................... 193 56.1.5 rollback ................................................................................................................... 193 56.1.6 close ........................................................................................................................ 193 57 Session.................................................................................................................................... 194 57.1 Mtodos de la clase Session ............................................................................................. 194 57.1.1 Session::set_data($name, $valor) .............................................................................. 194 57.1.2 Session::get_data($name, $valor) ............................................................................. 194 57.1.3 Session::unset_data($name) ..................................................................................... 194 57.1.4 Session::isset_data($name) ....................................................................................... 194 57.1.5 Session::set($name, $valor) ...................................................................................... 194 57.1.6 Session::get($name, $valor) ...................................................................................... 195 58 Coders..................................................................................................................................... 196 58.1 Activar los Coders ........................................................................................................... 196
11
58.2 Probar los coders ............................................................................................................ 196 58.2.1 Un ejemplo prctico ................................................................................................. 196 59 ACL......................................................................................................................................... 200 60 Pasos de Baile en Kumbia......................................................................................................... 201 60.1 Creando tus propios archivos de configuracin .ini........................................................... 201 60.2 Leer la configuracin Actual.............................................................................................. 202 60.3 Leer Archivos Excel con Kumbia........................................................................................ 203 60.4 Utilizando la consola Interactiva iPHP................................................................................ 205 60.4.1 create_standardform($nombre) ................................................................................ 205 60.4.2 create_model($nombre) ........................................................................................... 205 60.4.3 create_controller($nombre) ...................................................................................... 205 60.5 Validar un Usuario............................................................................................................ 206 60.6 Crear un Reporte usando FPDF.......................................................................................... 209 60.7 Combos Actualizables con AJAX........................................................................................ 211 60.8 Cambiando el Controlador por Defecto............................................................................. 216 60.9 Devolviendo una salida XML.............................................................................................. 217 60.10 Subir un Archivo sin StandardForm................................................................................. 218 60.11 Usar Componentes Edicin In-Place................................................................................ 220 60.12 Creando un Live Search.................................................................................................. 222 60.13 Integrar Kumbia con MooTools....................................................................................... 224 60.14 Ordenar registros usando Listas Ordenables................................................................... 225 60.15 Grficas estadsticas en Kumbia...................................................................................... 225 60.16 Crear un sindicado RSS para nuestro Sitio....................................................................... 225 60.17 Un sitio Web 2.0 con Etiquetas........................................................................................ 225 60.18 Crear una Validacin de Permisos de Usuario.................................................................. 225 60.19 Una Insercin y Validacin con AJAX............................................................................... 225 60.20 Llenando una Etiqueta SELECT ....................................................................................... 225 60.21 Usando Parmetros con Nombre en tus Aplicaciones....................................................... 225 60.22 Creando tus propios Vistas Helpers................................................................................ 225 61 Tutorial/Curso de Kumbia........................................................................................................ 226 Introduccin al Tutorial............................................................................................................. 226 Prologo ................................................................................................................................ 226 Pre-Requisitos ..................................................................................................................... 226 Comentarios ........................................................................................................................ 226 62 Captulo 1: Introduccin a Kumbia........................................................................................... 227 62.1 Por qu Un Framework? .................................................................................................. 227 62.2 Por qu utilizar Frameworks? .......................................................................................... 227 62.3 Por qu PHP5? ................................................................................................................ 227 62.4 Por qu Patrones? ........................................................................................................... 228 63 Captulo 2: Por qu Kumbia?................................................................................................... 229 64 Captulo 3: La tienda de Msica................................................................................................ 230 65 Captulo 4: Hablando y Codificando......................................................................................... 231 66 Captulo 5: Usando casos de Uso.............................................................................................. 232 67 Captulo 6: El Flujo del Sistema................................................................................................ 233 68 Captulo 7: El Modelo de Datos................................................................................................ 235 69 Captulo 8: Empezando con Kumbia......................................................................................... 236
12
69.1 Creando un Nuevo Proyecto ............................................................................................. 69.2 Creando la Base de Datos ................................................................................................ 69.3 Configurando la Conexin ............................................................................................... 69.4 Enlaces para esta Seccin ................................................................................................ 69.5 Creando la Tabla Productos ............................................................................................. 69.6 Creando un Modelo ......................................................................................................... 69.7 Creando un Formulario de Mantenimiento ....................................................................... 70 Glosario de Conceptos............................................................................................................. 70.1 AJAX ................................................................................................................................ 70.2 Modelo Vista Controlador (MVC) ...................................................................................... 70.3 Framework ...................................................................................................................... 70.4 ActiveRecord ................................................................................................................... 70.5 Scaffold (Andamiaje) ........................................................................................................ 70.6 Programacin Orientada a Objetos ( OOP )....................................................................... 70.7 Capa de Abstraccin de Datos ......................................................................................... 70.8 PHP ................................................................................................................................. 71 The GNU General Public License (GPL)...................................................................................... 72 Log de cambios en este libro....................................................................................................
236 236 237 239 239 240 241 243 243 243 244 245 245 245 245 245 246 250
13
1 Libro Beta
Este libro se encuentra en etapa de desarrollo. Como experimento estoy liberndolo con el fin de que sirva temporalmente para entender mejor las caractersticas del framework mientras su documentacin final es terminada. Este libro tambin se encuentra en revisin de diseo grfico, ortografa gramtica, estructura de contenido y otros aspectos as que stos pueden cambiar en cualquier momento. Hay muchas ideas para implementar en este libro, as como caractersticas, funciones, clases y otras cosas que falta mostrar del framework. Usted puede colaborar enviando contenido para mejorar esta documentacin, su ayuda ser invaluablemente valorada. Gracias por ser parte de esto, Andrs Felipe Gutierrez
14
2 Agradecimientos
Esta pgina es para agradecer a quienes con su tiempo y apoyo en gran o en poca medida han ayudado a que este framework sea cada da mejor. A todos ellos Gracias Totales: Julian Cortez Sergio Beltrn Eduar Carvajal Gian Corzo Arnold Espitaleta
15
3 Introduccin
Kumbia naci en un esfuerzo por no esforzarme para hacer las cosas. Puede sonar raro pero as fue. Un da empec a hacer un proyecto de un sistema de informacin donde haban muchos formularios y dije: - Esta cosa siempre es lo mismo, as que si yo hiciera algo para no repetir tanto y slo escribir lo que cambiaba en cada formulario entonces sera ms rpido. Despus de haber terminado las funciones para generar los formularios me d cuenta que haban quedado muy bien y entonces lo empec ha implementar en otras cosas. As es que Kumbia naci de una aplicacin real y lo puse a disposicin de la Comunidad. Mi trabajo era muy independiente del objetivo de sistema de informacin que se iba a desarrollar con los generadores de formularios, as que me propuse usarlo en otro proyecto. El resultado fue muy bueno, haba logrado desarrollar algo ms del 70% de un sistema de informacin en tan slo unos das. Entonces me puse a organizar las funciones, comentariar cdigo y mejorar la instalacin para que pudieran ser usadas en otros proyectos. En esa poca propuse llamar el proyecto AuroraForms, agregu alguna funcionalidad extra y decid darle propaganda en algunos foros de Internet. Quise darle un tono interesante al proyecto promulgu las facilidades que ofreca y puse un demo para que otros pudieran comentar sobre l. Esperaba que mucha gente se interesara, pero lo nico que logr fue muchas crticas constructivas. El proyecto no tena documentacin as que era como decirles miren lo que s hacer, pero no les digo cmo usarlo. No era mi intencin pero fue un error publicar sin documentar. Igualmente es necesario hacer muchas cosas para crear un proyecto de software libre y no pens que tuviera que tener en cuenta tantas cosas para que as fuese. Otro paso importante fue acoger la licencia GNU/GPL en vez de otra, como la BSD o la MIT, que aunque son menos restrictivas no favorecen el movimiento del software libre y eso es algo que quise transmitir con el proyecto. Pienso que el software libre permite crear el ambiente de colaboracin ideal que quera lograr con el proyecto, liberar las ideas permite que otros intervengan y busquen el camino ideal esperando aportar y ayudar con algo que le pueda servir a toda la comunidad. Buscar la mejor forma de hacer las cosas a veces puede resultar difcil, pues si encontramos alguna, que probablemente parezca la mejor, no siempre es aceptada por los dems y terminan rechazando las ideas que queremos vender, as demos todos los argumentos del
16
caso. Tiempo despus fui contratado para desarrollar un software algo grande y que patrocinaba el esfuerzo de trabajar en Kumbia. El resultado fue muy bueno, siempre me empeo en dar lo mejor cuando trabajo en un proyecto, as que el framework empez a crecer y la funcionalidad agregada forma gran parte de lo que hoy es como tal. Trabajar en una aplicacin real con caractersticas verstiles increment la estabilidad y las soluciones creadas para necesidades reales aument su funcionalidad. Algn tiempo despus fue agregado el proyecto a sourceforge.net y esto tambin ha sido un gran logro para posicionarlo como un proyecto serio y con futuro. Las herramientas proporcionadas en este forge dieron pie para empezar a mejorar muchos aspectos que estuvieron centralizados por mucho tiempo. El proyecto ahora posee muchas caractersticas que han ayudado a su crecimiento como por ejemplo los muchos servidores que replican Kumbia en todo el mundo, el sistema de gestin de bugs, el svn y el ms reciente dominio kumbia.org. Muchas personas han sido tambin fundamentales para levantar este proyecto sin duda, la colaboracin tanto en apoyo econmico, moral, de desarrollo, motivacin a usuarios, testeo de funciones, sugerencias y pruebas han contribuido a lo que es el proyecto hoy como tal. Aun en el auge de las frameworks para php y otros lenguajes, Kumbia fue pensado desde un punto de vista muy diferente. Al pasar de los das el objetivo de este proyecto se volva cada vez ms claro. Kumbia deba ser potente como para desarrollar proyectos a nivel empresarial; pero al mismo tiempo sencillo, tanto que hasta alguien que empezara a desarrollar en PHP pudiera adoptarlo como herramienta de trabajo saltndose muchos das de leer y releer tutoriales de principiantes. Es muy motivante cuando dicen que nuestro trabajo es fcil de usar, prctico o til ya que se ha logrado satisfaccin colectiva. La motivacin engranada con el deseo de hacer las cosas bien es algo que busco constantemente. Pienso que los lmites de la computacin empezaron a verse muy lejanos cuando el Internet entr en furor, para m creo que marc lo que siempre ha sido mi visin de lo que quiero. Programar para Internet es mi constante y la preocupacin por aprender y mejorar es el pilar de todo lo que hago para l. Programar fcil es importante. Cuando escribo cdigo, primero sueo y luego trabajo por ese sueo. Escribo cdigo pensando si esto fuera tan slo esto, entonces ya hubiera terminado sin hacer casi nada. Luego dedico varias horas para que ese poquito haga todo lo que tiene que hacer sin daar la fantasa. Luego me d cuenta que as funciona todo y que
17
muchas cosas nos tocan fciles por el trabajo soador de otros. Depende de la cultura, se pueden rechazar una propuesta cuando parece muy alocada o inalcanzable para el medio en la que se plantea. Encontrar las personas que tengan suficiente experiencia o necesidad para apoyar ideas o contribuir con el mejoramiento de stas puede ser una larga tarea, pero cuando las encuentras, te motivas a continuar y a mejorar, porque piensas que puede ser til para alguien ms. Con esta introduccin espero se haya interesado por este libro y por este proyecto que tambin fue pensado y desarrollado para alguien como usted.
18
19
Define una Filosofa de Trabajo. Proporciona libreras y funciones que deberan hacer la vida del programador ms feliz. Ahorrar trabajo y tiempo. Producir aplicaciones ms fciles de mantener. Evitar cdigo duplicado. Crear Aplicaciones Multi-Capa.
Preocuparse por interfaces, lgica y procesos ms intuitivos y prcticos para usuarios. Usar frameworks para evitar estar pensando en los detalles y facilitar el trabajo. Buscar en qu manera podra ser ms fcil, sin que aumente el trabajo considerablemente. Atacar necesidades reales y no desarrollar en supuestos de utilidad. Ser fantico de la productividad.
Implementa los mejores patrones de programacin orientados a la Web. Fomenta la utilizacin de caractersticas Web 2.0 en nuestro software. Hace la mayor parte del trabajo y se ocupa de los detalles. Mantener una aplicacin es ms fcil. Es software libre, por lo tanto obtiene todas las ventajas que ste proporciona. Su Documentacin esta principalmente en espaol.
20
6 Sobre Kumbia
Kumbia es un web framework libre escrito en PHP5. Basado en las mejores prcticas de desarrollo web, usado en software comercial y educativo, Kumbia fomenta la velocidad y eficiencia en la creacin y mantenimiento de aplicaciones web, reemplazando tareas de codificacin repetitivas por poder, control y placer. Si ha visto a Ruby-Rails/Python-Django encontrar a Kumbia una alternativa para proyectos en PHP con caractersticas como:
Sistema de Plantillas sencillo. Administracin de Cach. Scaffolding Avanzado. Modelo de Objetos y Separacin MVC. Soporte para AJAX. Generacin de Formularios. Componentes Grficos. Seguridad.
y muchas cosas ms. Kumbia puede ser la solucin que est buscando. El nmero de prerrequisitos para instalar y configurar es muy pequeo, apenas Unix o Windows con un servidor web y PHP5 instalado. Kumbia es compatible con motores de base de datos como MySQL, PostgreSQL y Oracle. Usar Kumbia es fcil para personas que han usado PHP y han trabajado patrones de diseo para aplicaciones de Internet cuya curva de aprendizaje est reducida a un da. El diseo limpio y la fcil lectura del cdigo se facilitan con Kumbia. Desarrolladores pueden aplicar principios de desarrollo como DRY, KISS o XP, enfocndose en la lgica de aplicacin y dejando atrs otros detalles que quitan tiempo. Kumbia intenta proporcionar facilidades para construir aplicaciones robustas para entornos comerciales. Esto significa que el framework es muy flexible y configurable. Al escoger Kumbia esta apoyando un proyecto libre publicado bajo licencia GNU/GPL.
21
7 Kumbia en su Punto
7.1 Introduccin
Kumbia es un framework PHP5 basado en el modelo MVC. Permite la separacin de las reglas de negocio, lgica de aplicacin y vistas de presentacin de una aplicacin web. Adems posee otras herramientas y clases que ayuden a acortar el tiempo de desarrollo de una aplicacin web.
7.2 Qu es un Framework?
En el desarrollo de software, un framework es una estructura de soporte definida en la cual otro proyecto de software puede ser organizado y desarrollado. Tpicamente, un framework puede incluir soporte de programas, libreras y un lenguaje de scripting entre otros software para ayudar a desarrollar y unir los diferentes componentes de un proyecto. Un framework agrega funcionalidad extendida a un lenguaje de programacin; sta, automatiza muchos de los patrones de programacin para orientarlos a un determinado propsito. Un framework proporciona una estructura al cdigo y hace que los desarrolladores escriban cdigo mejor, ms entendible y mantenible. Adems hace la programacin ms fcil, convirtiendo complejas funciones en sencillas instrucciones. Est usualmente escrito en el lenguaje que extiende. Kumbia est escrito en PHP5. Un framework permite separar en capas la aplicacin. En general, divide la aplicacin en tres capas: La lgica de presentacin que administra las interacciones entre el usuario y el software. La Lgica de Datos que permite el acceso a un agente de almacenamiento persistente u otros. La lgica de dominio o de negocio, que manipula los modelos de datos de acuerdo a los comandos recibidos desde la presentacin.
Los Web framework pretenden facilitar el desarrollo de Aplicaciones web ( sitios web, intranets, etc). PHP es conocido por su simplicidad y es ampliamente usado en este campo. Slo PHP puede utilizar casi cualquier motor de base de datos, administrar sesiones, acceder a archivos del servidor, etc, pero cuando las aplicaciones crecen y su complejidad aumenta un framework solventa muchos problemas y facilita muchas tareas.
22
javascript, uso de ajax y otras cosillas ms. Entonces, cul es la diferencia?. La diferencia est en cunto tiempo dedicas a leer su documentacin, cuntas veces debes recurrir a ella, cuntas veces debes recordar sintaxis compleja, y lo ms importante: Despus de cunto tiempo obtienes resultados? Te invitamos a comparar a Kumbia con otros frameworks y darte cuenta, cmo usando otras herramientas, escribes x, y, z cdigo, haces 1, 2, 3, etc pasos para hacer una simple tarea y cmo en Kumbia esto est reducido a su mnima unidad con lo que te haces ms productivo, aprendes ms rpido y das mejores soluciones anticipndote a la competencia.
23
9 Qu es Kumbia?
Kumbia es un esfuerzo por producir un framework que ayude a reducir el tiempo de desarrollo de una aplicacin web sin producir efectos sobre los programadores. Est basado en los siguientes conceptos:
Compatible con muchas plataformas. Fcil de instalar y configurar. Fcil de aprender. Listo para aplicaciones comerciales. Convencin sobre Configuracin. Simple en la mayor parte de casos pero flexible para adaptarse a casos ms complejos. Soportar muchas caractersticas de Aplicaciones Web Actuales. Soportar las practicas y patrones de programacin mas productivos y eficientes. Producir aplicaciones fciles de mantener. Basado en Software Libre.
El principal principio es producir aplicaciones que sean prcticas para el usuario final y no slo para el programador. La mayor parte de tareas que le quiten tiempo al desarrollador deberan ser automatizadas por Kumbia para que l pueda enfocarse en la lgica de negocio de su aplicacin. No deberamos reinventar la rueda cada vez que se afronte un nuevo proyecto de software. Para satisfacer estos objetivos Kumbia est escrito en PHP5. Adems ha sido probado en aplicaciones reales que trabajan en diversas reas con variedad de demanda y funcionalidad. Es compatible con las bases de datos disponibles actuales mas usadas: MySQL. PostgreSQL. Oracle.
El modelo de objetos de Kumbia es utilizado en tres diferentes capas: Abstraccin de la base de datos. Mapeo Objeto-Relacional. Modelo MVC (Modelo, Vista, Controlador).
24
Plantillas (TemplateView). Validacin de Formularios. Administracin de Cach. Scaffolding. Interaccin AJAX. Generacin de Formularios. Efectos Visuales. Seguridad.
FPDF: Reportes en formato PDF Prototype: Javascript crossbrowser Scriptaculous: Efectos visuales PHPMailer: Correo Electrnico Smarty: Motor de Plantillas potente y fcil de usar
25
Con Kumbia puede crear aplicaciones grandes o medianas, con lgica de negocios compleja y alta disponibilidad en donde PHP solo, no sera suficiente. Si planea mantener o extender sus aplicaciones en el futuro y necesita cdigo liviano, entendible y efectivo. Si desea dedicar tiempo al diseo y usabilidad de su aplicacin y olvidarse de los detalles. Si desea usar las ltimas caractersticas en interaccin con el usuario (como AJAX) en forma intuitiva sin tener que escribir cientos de lneas de JavaScript. Si quiere desarrollar rpido y con buena calidad.
26
12 Instalando Kumbia
12.1 Prerrequisitos
Es necesario instalar el la mquina con Windows 2000/XP/2003 Linux/UNIX un servidor Web Apache en cualquier versin. Puedes utilizar IIS con Isapi_Rewrite instalado. Instalar PHP5+ (recomendado 5.2) y algn motor de base de datos soportado si se necesitase.
12.2 Instalando
Kumbia se distribuye en un paquete comprimido listo para usar. Se puede descargar la ltima versin de http://kumbia.sourceforge.net El nombre del paquete tiene un nombre como kumbia-version-notes.formato, por ejemplo: kumbia-0.4.4.tar.gz Se copia el paquete al directorio raz del servidor web. Windows: c:\Apache2\htdocs\ o c:\wamp\www Linux: /srv/www/htdocs, /var/www/html o /var/www Se descomprime y crea un directorio kumbia-0.4.4 que puede ser renombrado por el nombre de nuestro proyecto.
Informacin: Si desea instalar la ultima beta de Kumbia debe ingresar al grupo en google y descargarlo de los archivos del grupo. En http://groups.google.com/group/kumbia
28
<Directory "/to/document/root"> Options Indexes FollowSymLinks AllowOverride All Order allow,deny Allow from all </Directory>
En el DocumentRoot (Directorio Raz de Apache) debe llevar la opcin AllowOverride All para
Sirven para indicar que el archivo de configuracin se llama .htaccess y que suba el mdulo mod_rewrite, esta ltima lnea generalmente aparece con un signo # de comentario.
DirectoryIndex index.php index.html ...
Indican a Apache que index.php es un archivo de ndice que tiene prioridad sobre index.html, es muy importante que index.php est antes de index.html.
short_open_tag = On Permiten el uso de etiquetas del tipo <? y <?= para los bloques PHP.
29
magic_quotes_gpc = On Nos protegen en cierta medida de ataques de inyeccin SQL que puedan tratar de ejecutar sobre nuestras aplicaciones en Kumbia. error_reporting = E_ALL & ~E_NOTICE Kumbia no est escrito respetando el estndar E_STRICT, por lo que en algunas configuraciones podran aparecer mensajes inesperados o molestos de parte de PHP. session.save_path = /path/to/dir/ Debe apuntar a un directorio con permisos de escritura track_errors = On Permite que Kumbia muestre informacin ms precisa sobre algunos warnings y mensajes de error que son controlados internamente.
30
+ | + | +
Para cambiar este parmetro, a uno adecuado al framework, debe ejecutar el siguiente comando:
mysql> set [global | session] sql_mode = ;
o cambiar la configuracin del archivo my.ini en su sistema operativo. Para ver otros parmetros ver el siguiente enlace [1]
Advertencia: En Oracle la funcionalidad limit podra no funcionar como se espera. Utilice la condicin rownum < numero_filas para hacer esto.
31
5. Reiniciar el servicio de Apache desde el Panel de Control de XAMPP 6. Copiar el paquete de Kumbia a: c:\Archivos de Programa\xampp\apache\htdocs\ 7. Continuar Normalmente
Buscas la lnea para el directorio /var/www donde dice: AllowOverride None y cambiar por AllowOverride All Reinicias Apache con:
# /etc/init.d/apache2 restart
Continuar normalmente
13 Creacin de Proyectos
13.1 Introduccin
En Kumbia un proyecto es un conjunto de servicios que comparten un nombre de dominio y un conjunto de modelos de datos. En un proyecto las operaciones estn lgicamente agrupadas en controladores, stos pueden trabajar independientemente o de forma distribuida con los otros del mismo proyecto. Probablemente una aplicacin contenga al menos 2 controladores que administren el front y el back office de un proyecto.
32
Un controlador representa una o ms pginas con un mismo propsito. Ejemplo: Mantenimiento de Clientes. Los controladores poseen un conjunto de acciones. Ellos representan las diversas operaciones que se pueden realizar dentro de un controlador. Por ejemplo: Crear Clientes, Actualizarlos, Revisar su Cartera, etc. Si parece que muchos controladores aumenten la complejidad de una aplicacin, entonces se podran mantener agrupados en uno solo, esto lo mantiene simple. Cuando la aplicacin crezca entonces se pueden agrupar en otros controladores lgicos.
33
Directorio controllers
Descripcin Este directorio contiene los archivos con las clases controladoras de un proyecto como tal. Aqu encontramos el archivo application.php que es la clase padre de todos los controladores, cualquier mtodo definido aqu est disponible para los dems frameworks. Es la primera parte del MV(C). Cuando inicias un proyecto este directorio contiene slo el archivo application.php En este directorio se encuentran los archivos del framework. En este directorio estn los archivos de configuracin del framework y la clase config que sirve para leer los archivos .ini de configuracin. Aqu se encuentran los parmetros de conexin a la base de datos y el nombre del proyecto. Aqu se encuentran los parmetros de configuracin de algunas cosas del framework, las libreras que van a cargar automticamente y otras cosas. Aqu se encuentran las polticas de enrutamiento esttico del proyecto. Aqu se guardan los logs de texto creados por el framework por la clase Logger. Cuando inicias un proyecto este directorio se encuentra vaco. Aqu colocamos los modelos ActiveRecord y la lgica del modelo, es la segunda parte del (M)VC. Cuando inicias un proyecto este directorio se encuentra vaco. Son los archivos de usuario imgenes, css, javascript, zips, docs, archivos temporales, etc. Aqu colocamos todos los archivos .css Aqu colocamos todos los archivos externos a la aplicacin, documentos de texto, docs, zips etc. Cuando inicias un proyecto este directorio se encuentra vaco. Aqu quedan todas las imgenes que suben al servidor mediante el componente de imgenes. Aqu van todas las imgenes del Framework y las de usuario. Archivos JavaScript de Usuario y del Framework. Archivos temporales de la aplicacin y del framework. Cuando inicias un proyecto este directorio se encuentra vaco. 34
forms forms/config
forms/config/config.ini forms/config/core.ini
forms/config/routes.ini logs
models
Descripcin Es la tercera parte del M(V)C. Aqu va toda la presentacin de la aplicacin. Vistas, Layouts, Templates y Partials. Aqu van los layouts y templates de la presentacin de la aplicacin.
35
Descripcin integradas al Framework Libreras FPDF para la generacin de reportes PDF Clases Kumbia donde encontramos ACL (Authentication Control Lists), Loggers, Flickr, y Helpers Clases para el envo de correos electrnicos mediante PHPMailer Kumbia incluye Smarty y esta integrado con el modelo MVC en donde cumple un papel importante en la presentacin de las vistas.
13.5 Resumen
Si pensamos en convencin sobre configuracin, entonces podemos tambin pensar que mientras todo est en su lugar, mejorar el orden de la aplicacin y ser ms fcil encontrar problemas, habilitar/inhabilitar mdulos y en sntesis mantener la aplicacin.
36
14 Explicando la Configuracin
14.1 Introduccin
Kumbia posee una configuracin por defecto que debe funcionar bien en la mayor parte de casos aunque sta puede personalizarse de acuerdo a necesidades especficas de cada proyecto. Se ha pensado en configurar al mnimo para poder empezar ha trabajar y dejar que Kumbia escoja la configuracin ms ptima. Kumbia utiliza archivos formato .ini para hacer la configuracin.
14.2 forms/config/config.ini
Posee la configuracin de base de datos y otros parmetros para empezar a trabajar la aplicacin:
; Kumbia Web Framework Configuration ; Parmetros Generales del Proyecto [project] mode = development name = "KUMBIA PROJECT" interactive = Off ; Parametros de base de datos ; Utiliza el nombre del controlador nativo (mysql, postgresql, oracle) [production] database.host = localhost database.username = root database.password = database.name = test database.type = mysql [development] database.host = localhost database.username = root database.password = database.name = test database.type = mysql
Variable mode
Descripcin Indica el modo de trabajo de Kumbia. Dependiendo de su valor, utilizar la conexin indicada. Gracias a esto es ms fcil pasar de una configuracin a otra . Indica el nombre del proyecto en que estamos trabajando.
name
37
Indica si los coders estarn disponibles en el proyecto. Representa el nombre de la mquina o IP de la red local o Internet donde esta el servidor de base de datos. Ej localhost 127.0.0.1 Representa un nombre de usuario vlido con el que se conectar al sistema de base de datos. Representa un password de usuario vlido con el que se conectar al sistema de base de datos. Representa el nombre de una base de datos vlida con la que se trabajar todas las operaciones de base datos de la aplicacin. Driver Kumbia utilizado para la capa de abstraccin de datos. RDBM a utilizar: mysql, postgresql, sqlite, pdo, ODBC. Nombre del Data Source Name (si es necesario) Numero del Puerto para conectar (si es necesario)
14.3 forms/config/core.ini
En este archivo hay configuracin comportamiento de Kumbia. variada que modifica muchos aspectos del
; Cargar los modulos de Kumbia en lib [modules] extensions = kumbia.tags, kumbia.logger, kumbia.utils, kumbia.acl, smarty.main [kumbia] dbdate = YYYY-MM-DD
dbdate Formato de Fecha utilizado por el sistema de base de Datos extensions Indica qu mdulos almacenados en el directorio lib, deben ser cargados automticamente al iniciar kumbia, tambin puede ser utilizado para cargar otros plugins o software en php de terceros que quiera ser integrado al software. Si existe un archivo lib/usuario/archivo.php entonces agregamos usuario.archivo
Ejemplo: Vamos a colocar la librera zipfile que puede ser encontrada en http://www.weberdev.com/get_example-4066.html, esta librera permite escribir archivos zip desde php. Ahora vamos a integrarla con kumbia: Al descargar la librera encontramos lo siguiente:
zip.lib.php zipper.php
Siguiente paso, creamos un directorio en lib con un nombre para identificar la librera, en nuestro caso usamos ziplib, as:
lib/ziplib/zip.lib.php lib/ziplib/zipper.php
Ahora vamos a renombrar el archivo zip.lib.php a main.php para indicar que es el archivo principal, y quedara as:
lib/ziplib/main.php lib/ziplib/zipper.php
Listo, ahora cuando inicie Kumbia esta librera estar disponible en cualquier parte de nuestra aplicacin.
14.4 forms/config/routes.ini
En este archivo definimos las polticas de enrutamiento esttico para los controladores de la aplicacin. Es decir, cuando queramos que al acceder determinado controlador/accin se dirija automticamente a otro controlador o a otra accin.
; ; ; ; ; ; ; ; ; ; ; ; ; ; Usa este archivo para definir el enrutamiento esttico entre controladores y sus acciones Un controlador se puede enrutar a otro controlador utilizando '*' como comodn as: controlador1/accion1/valor_id1 = controlador2/accion2/valor_id2 Ej: Enrutar cualquier peticin a posts/adicionar a posts/insertar/* posts/adicionar/* = posts/insertar/* Enrutar cualquier peticin a cualquier controlador en la accin adicionar a posts/adicionar/* */adicionar/* = posts/insertar/*
39
40
41
Podemos identificar ms fcilmente en qu capa se est produciendo un problema con slo saber su naturaleza. Podemos crear varias presentaciones sin necesidad de escribir varias veces la misma lgica de aplicacin. Cada parte funciona independiente y cualquier cambio centraliza el efecto sobre las dems, as que podemos estar seguros que una modificacin en un componente realizar bien las tareas en cualquier parte de la aplicacin.
42
16.2 Conceptos
La base de Kumbia es el MVC, un tradicional patrn de diseo que funciona en tres capas: Modelos: Representan la informacin sobre la cual la aplicacin opera, su lgica de negocios. Vistas: Visualizan el modelo usando pginas Web e interactuando con los usuarios de stas. Controladores: Responden a acciones de usuario e invocan cambios en las vistas o en los modelos segn sea necesario.
En Kumbia los controladores estn separados en partes, llamadas front controller y un en un conjunto de acciones. Cada accin sabe cmo reaccionar ante un determinado tipo de peticin. Las vistas estn separadas en layouts, templates y partials. El modelo ofrece una capa de abstraccin de la base de datos utilizada adems dan funcionalidad agregada a datos de sesin y validacin de integridad relacional. Este modelo ayuda a separar el trabajo en lgica de negocios (modelos) y la presentacin (Vistas). Por ejemplo, si usted tiene una aplicacin que corra tanto en equipos de escritorio y en dispositivos de bolsillo entonces podra crear dos vistas diferentes compartiendo las mismas acciones en el controlador y la lgica del modelo. El controlador ayuda a ocultar los detalles de protocolo utilizados en la peticin (HTTP, modo consola, etc.) para el modelo y la vista. Finalmente, el modelo abstrae la lgica de datos, que hace a los modelos independientes de las vistas. La implementacin de este modelo es muy liviana mediante pequeas convenciones se puede lograr mucho poder y funcionalidad.
16.3 Ejemplo
Para hacer las cosas ms claras, veamos un ejemplo de cmo una arquitectura MVC trabaja para un agregar al carrito. Primero, el usuario interacta con la interfaz seleccionando un producto y presionando un botn, esto probablemente valida un formulario y enva una peticin al servidor. 1. El Front Controller Recibe la notificacin de una accin de usuario, y luego de ejecutar algunas tareas (enrutamiento, seguridad, etc.), entiende que debe ejecutar la accin de agregar en el controlador. 2. La accin de agregar accede al modelo y actualiza el objeto del carrito en la sesin de usuario. 3. Si la modificacin es almacenada correctamente, la accin prepara el contenido que ser devuelto en la respuesta confirmacin de la adicin y una lista completa de los productos que estn actualmente en el carrito. La vista ensambla la respuesta de la accin en el cuerpo de la aplicacin para producir la pgina del carrito de compras.
43
4. Finalmente es transferida al servidor Web que la enva al usuario, quien puede leerla e interactuar con ella de nuevo. Ms informacin sobre MVC en Wikipedia
44
Renombramos el directorio a demo que es el nombre de nuestra aplicacin. En este directorio encontramos la estructura de directorios que nos permitir empezar a trabajar.
45
Es una clase vaca que hereda de la clase ApplicationController con lo que adquiere toda la Libro de Kumbia: Porque Programar debera ser ms fcil 46
funcionalidad de un controlador. Ntese tambin el sufijo Controller al final del nombre, esto la identifica como una clase controladora.
Cualquier informacin adicional pasada en una URL puede ser utilizada para propsitos de nuestra aplicacin.
Probablemente si visualizamos la salida en el explorador encontramos una pgina en blanco ya que no estamos visualizando ninguna vista para enviar informacin al usuario. Entonces para completar nuestra aplicacin podramos crear una vista que visualizar el saludo verdad? Entonces creemos la vista views/saludo/hola.phtml donde colocaremos esta informacin para visualizar.
1. <h1>Hola Mundo</h1>
47
Ahora si visualizamos en el explorador se entiende que Kumbia automticamente carga la vista con el mismo nombre la accin en el directorio con el nombre del controlador seleccionado. Poniendo a consideracin podramos decir que las vistas permiten la salida al usuario usando PHP embebido en HTML. Por esto las vistas poseen extensin phtml a diferencia de los controladores que poseen PHP puro y por esto su extensin .php.
Funciona bien y ahora tenemos la hora y fecha actual pero nuestro controlador se pone aburrido as que le vamos a dar algo de trabajo.
1. <?php 2. class SaludoController extends ApplicationController { 3.
48
4. 5. 6. 7. 8. ?>
Como vemos las variables de la instancia se encuentran globalmente disponibles en la vista para poder usarlas. Ahora vemos algo as:
para
hacer
la
despedida
llamado
49
Su vista:
1. <h1>Adios Amigos</h1> 2. <a href=/demo/saludo/hola>Volver a Saludar</a>
Hemos creado otro controlador que realiza una despedida pero adems tiene un vnculo al controlador saludo si queremos volver a saludar. Esto funciona bien, pero si decidimos cambiar el nombre a la aplicacin de demo a otra cosa entonces tendramos que reescribir los vnculos para que apuntaran a la nueva ubicacin, esto lo arreglamos con link_to.
1. <h1>Adios Amigos</h1> 2. <?= link_to(saludo/hola, Volver a Saludar) ?>
50
51
19.1 Modelos
La segunda capa de abstraccin de datos utiliza un mapeo objeto/relacional para representar las entidades del modelo de datos en nuestras aplicaciones. Estos modelos son parte integral de la arquitectura MVC (Model View Controller) y estn basados en el patrn ActiveRecord. Caractersticas de los modelos: Implementan las clases de la capa de negocios: Productos, Clientes, Facturas, Empleados, etc. Mantienen los datos y su lgica juntos: Un producto tiene una cantidad y se vende slo si est activo. Representar relaciones en el modelo: Una Cliente tiene muchas Facturas.
52
en
20.3.2 $db->lastResultQuery
Ultima sentencia SQL ejecutada en la base de datos en la instancia
20.3.3 $db->dbUser
Usuario de la base de datos utilizado para crear la conexin
53
20.3.4 $db->dbHost
Host de la base de datos utilizado para crear la conexin
20.3.5 $db->dbPort
Puerto de la base de datos utilizado para crear la conexin
20.3.6 $db->dbPass
Password del Usuario de la base de datos utilizado para crear la conexin
20.3.7 $db->lastError
ltimo error generado por el motor de la base de datos producido en alguna operacin SQL.
20.3.8 $db->dbName
Nombre de la base de datos actual
Sintaxis:
$db->connect([string $host], [string $user], [string $password], [string $database_name])
20.4.2 Query
Descripcin: Permite enviar sentencias SQL al motor de base de datos. El parmetro debug permite ver un mensaje del SQL que es enviado al motor de base de datos.
Sintaxis:
$db->query(string $sql, [bool $debug=false])
Ejemplo:
1. <?php 2. 3. 4. 5. ?> $db = db::raw_connect(); $db->query(update clientes set estado = A); $db->close();
20.4.3 Close
Descripcin: Cierra la conexin encapsulada en el objeto Libro de Kumbia: Porque Programar debera ser ms fcil 54
Sintaxis:
$db->close()
Sintaxis:
$db->fetch_array([cursor $cursor], [int $tipo_resultado=DB_BOTH])
Ejemplo:
1. <?php 2. 3. 4. 5. 6. 7. 8. ?> $db = db::raw_connect(); $db->query(select codigo, nombre from productos); while($producto = $db->fetch_array()){ print$producto[nombre]; }//fin while $db->close();
Los tipos de resultado pueden ser: db::DB_ASSOC: Array con ndices asociativos de los nombres de los campos. db::DB_NUM: Array con ndices numricos que indican la posicin del campo en el select. db::DB_BOTH: Array con ndices tanto numricos como asociativos.
Sintaxis:
$db->num_rows([cursor $cursor]);
Ejemplo:
1. <?php 2. $db = db::raw_connect; 3. $db->query(select codigo, nombre from productos); 4. print Hay .$db->num_rows(). productos ; 5. $db->close(); 6. ?>
55
Sintaxis:
$db->data_seek(int $number, [cursor $cursor]);
Sintaxis:
$db->affected_rows();
20.4.9 Error
Descripcin: Devuelve la cadena descriptiva del ltimo error generado por base de datos producido por la ltima instruccin SQL.
Sintaxis:
$db->error();
20.4.10 No Error
Descripcin: Devuelve el nmero interno del ltimo error generado por base de datos producido por la ltima instruccin SQL. Sintaxis:
$db->no_error();
20.4.11 Find
Descripcin: Ejecuta un Select en el motor con los parmetros enviados y devuelve un Array con los resultados.
Sintaxis:
$db->find(string $table, [string $where=1=1], [string $fields=*], [string $orderBy=1]);
Ejemplo:
1. <?php 2. $db = db::raw_connect(); 3. foreach($db->find(productos) as $producto){ 4. print $producto[nombre]; 5. } //fin del foreach 6. $db->close(); 7. ?>
56
20.4.12 In Query
Descripcin: Devuelve el resultado de una instruccin SQL en un array listo para ser recorrido.
Sintaxis:
$db->in_query(string $sql, [bool $debug=false], [int $tipo_resultado = db::DB_BOTH]);
Ejemplo:
1. <?php 2. $db = db::raw_connect(); 3. foreach($db->in_query(select * from productos) as $producto){ 4. print $producto[nombre]; 5. }//fin del foreach 6. $db->close(); 7. ?>
Sintaxis:
$db->in_query_assoc(string $sql, [bool $debug=false]);
Sintaxis:
$db->in_query_num(string $sql, [bool $debug=false]);
Sintaxis:
$db->fetch_one(string $sql, [bool $debug=false]);
Ejemplo:
1. <?php 2. $db = db::raw_connect(); 3. $producto = $db->fetch_one(select * from producto where codigo = 1); 4. print $producto[nombre]; 5. $db->close(); 6. ?>
57
Sintaxis:
$db->table_exists(string $table);
58
Kumbia proporciona una serie de clases (ActiveRecord y SessionRecord) que permiten realizar este mapeo y adems ejecutar operaciones nativas sobre las relaciones de la base de datos de forma ms humana y entendible.
59
El mapeo Objeto-Relacional soluciona esto y proporciona un alto potencial para hacer las aplicaciones ms fciles de mantener.
60
No espacios delante del nombre del parmetro y ste no debe contener espacios. Los dos puntos : deben ir a continuacin del nombre del parmetro, sin espacios entre ste y el nombre. Un espacio obligatorio despus de los : El valor puede ser cualquier valor
61
24 ActiveRecord
Es la principal clase para la administracin y funcionamiento de modelos. ActiveRecord es una implementacin de este patrn de programacin; y est muy influenciada por la funcionalidad de su anloga en Ruby disponible en Rails. ActiveRecord proporciona la capa objeto-relacional que sigue rigurosamente el estndar ORM: Tablas en Clases, Campos en Atributos y Registros en Objetos. Facilita el entendimiento del cdigo asociado a base de datos y encapsula la lgica especifica hacindola ms fcil de usar para el programador.
1. <?php 2. $Clientes->nit = 808111827-2; 3. $Clientes->razon_social = EMPRESA DE TELECOMUNICACIONES ETB 4. $Clientes->save(); 5. ?>
Se trabajan las entidades del Modelo ms naturalmente como objetos. Las acciones como Insertar, Consultar, Actualizar, Borrar, etc. de una entidad del Modelo estn encapsuladas as que se reduce el cdigo y se hace ms fcil de mantener. Cdigo ms fcil de entender y mantener. Reduccin del uso del SQL en un 80%, con lo que se logra un alto porcentaje de independencia del motor de base de datos. Menos detalles ms practicidad y utilidad ActiveRecord protege en un gran porcentaje de ataques de SQL inyection que puedan llegar a sufrir tus aplicaciones, escapando caracteres que puedan facilitar estos ataques.
convierte en atributos de la clase asociada. A esto es lo que nos referamos con mapeo objeto relacional. Miremos la tabla Album:
1. CREATE TABLE album ( 2. id INTEGER NOT NULL AUTO_INCREMENT, 3. nombre VARCHAR(100) NOT NULL, 4. fecha DATE NOT NULL, 5. valor DECIMAL(12,2) NOT NULL, 6. artista_id INTEGER NOT NULL, 7. estado CHAR(1), 8. PRIMARY KEY(id) 9. )
Una instancia de esta clase ser un objeto con los atributos de la tabla album:
1. 2. 3. 4. $Album = new Album(); $Album->id = 2; $Album->nombre = Going Under; $Album->save();
63
24.5 CRUD: Create (Crear), Read (Leer), Update (Actualizar), Delete (Borrar)
ActiveRecord implementa automticamente las cuatro operaciones bsicas sobre una tabla: Crear, Leer, Actualizar y Borrar.
que crear objetos, entonces podramos estar en lo cierto. Asignar a un objeto valores y ejecutar el mtodo create o save es todo lo que tenemos que hacer.
1. 2. 3. 4. $Album = new Album(); $Album->nombre = Take Off Your Pants and Jacket; $Album->valor = 40000; $Album->save();
Adicionalmente a esto puede utilizar el mtodo create as como los mtodos como create_from_request para crear nuevos registros.
1. $Album = new Album(); 2. $Album->nombre = Take Off Your Pants and Jacket; 3. $Album->valor = 40000; 4. $Album->create(); 5. 6. $Album = new Album(); 7. $Album->create( 8. nombre: Take Off Your Pants and Jacket, 9. valor: 40000 10.); 11. 12.$Album = new Album(); 13.$Album->create(array( 14. nombre => Take Off Your Pants and Jacket, 15. valor => 40000 16.));
llave primaria. En Kumbia los modelos soportan el mtodo find, as como otros mtodos complementarios para consultas. Este mtodo permite consultar registros a partir de sus llaves primarias as como con parmetros. Ntese que este mtodo devuelve el valor boolean false en caso de no encontrar registros que coincidan con la bsqueda.
1. # Buscar el Producto con id = 38 2. $producto = $Productos->find(38); 3. print $producto->nombre; # Imprime el nombre del producto id=38
Igualmente necesitamos hacer consultas a partir de otros atributos del modelo no solamente a partir de su llave primaria. ActiveRecord proporciona una serie de parmetros para crear consultas especializadas que nos permitan acceder a los registros que necesitamos. Para ilustrar esto veamos:
1. # Buscar los Productos en estado = C y cuyo valor sea menor a 15000 2. foreach($Productos->find(estado=C and valor<15000) as $producto){ 3. print $producto->nombre; 4. } 5. 6. #Buscar el primer producto en estado = C ordenado por fecha 7. foreach($Productos->find_first(conditions: estado=C, 8. order: fecha desc) as $producto){ 9. print $producto->nombre; 10.} 11. 12.#Buscar el primer producto en estado = $estado ordenado por fecha 13.$producto = $Productos->find_first(conditions: estado=$estado, 14. order: fecha desc); 15.print $producto->nombre;
Cabe destacar que el uso de find_first devuelve el primer registro que coincida con la bsqueda y find todos los registros.
65
El parmetro conditions: permite especificar un conjunto de condiciones que van a actuar como el where de nuestra consulta. Igualmente ActiveRecord no garantiza que los registros sean devueltos en el orden requerido as que podemos utilizar order: para realizar el ordenamiento. El parmetro limit: nos permite especificar el nmero mximo de registros a ser devueltos.
1. 2. 3. 4. 5. 6. #Buscar los productos en estado = $estado ordenado por fecha y valor foreach($Productos->find_first(conditions: estado=$estado, order: fecha Desc, valor, limit: 30) as $prod){ print $prod->nombre; }
Advertencia: En Oracle la funcionalidad limit podra no funcionar como se espera. Utilice la condicin rownum < numero_filas para hacer esto.
consultas, as como el uso de otras funciones de agrupacin. El mtodo de conteo de registros se llama count y puede recibir como parmetros condiciones de ste.
1. 2. 3. 4. 5. #Cuantos productos hay? print Productos->count(); #Cuantos productos hay con estado = 'A'? print Productos->count(estado='A');
Las funciones de agrupacin suma, mnimo, promedio y mximo, son utilizadas de esta forma:
1. #Cuantos suma el valor de todos los productos? 2. print Productos->sum(valor); 3. 4. #Cuantos suma el valor de los productos activos? 5. print Productos->sum(valor, conditions: estado='A'); 6. 7. #Promedio del valor de los productos activos? 8. print Productos->average(valor, conditions: estado='A'); 9. 10.#El valor mnimo de los productos activos? 11. print Productos->minumum(valor, conditions: estado='A'); 12. 13.#El valor mximo de los productos activos? 14. print Productos->maximum(valor, conditions: estado='A');
66
67
24.6.3 campo_id
Los campos terminados en _id indican relaciones forneas a otras tablas, de esta forma se puede definir fcilmente las relaciones entre las entidades del modelo: Un campo llamado clientes_id en una tabla indica que existe otra tabla llamada clientes y esta contiene un campo id que es fornea a este.
24.6.4 campo_at
Los campos terminados en _at indican que son fechas y posee la funcionalidad extra que obtienen el valor de fecha actual en una insercin created_at es un campo fecha
24.6.5 campo_in
Los campos terminados en _in indican que son fechas y posee la funcionalidad extra que obtienen el valor de fecha actual en una actualizacin modified_in es un campo fecha
68
25.1 Consulta
Mtodos para hacer consulta de Registros:
25.1.1 distinct
distinct([string $atributo_entidad], [conditions: ], [order: ], [limit: ], [column: ])
Este mtodo ejecuta una consulta de distincin nica en la entidad, funciona igual que un select unique campo vindolo desde la perspectiva del SQL. El objetivo es devolver un array con los valores nicos del campo especificado como parmetro.
1. $unicos = $this->Usuarios->distinct(estado) 2. # array(A, I, N)
Los parmetros conditions, order y limit funcionan idnticamente que en la funcin find y permiten modificar la forma o los mismos valores de retorno devueltos por sta.
Este ejemplo consultamos todos los usuarios con una sentencia where especial e imprimimos sus nombres. La idea es que los usuarios consultados no pueden estar en la entidad ingreso.
69
Este ejemplo consultamos todos los usuarios con una sentencia where especial e imprimimos sus nombres. La idea es que el usuario consultado no puede estar en la entidad ingreso.
25.1.4 find_first
find_first([integer $id], [conditions: ], [order: ], [limit: ], [columns: ])
El mtodo find_first devuelve el primer registro de una entidad o la primera ocurrencia de acuerdo a unos criterios de bsqueda u ordenamiento. Los parmetros son todos opcionales y su orden no es relevante, cuando se invoca sin parmetros devuelve el primer registro insertado en la entidad. Este mtodo es muy flexible y puede ser usado de muchas formas: Ejemplo:
1. $this->Usuarios->find_first(conditions: estado=A ,order: fecha desc);
En este ejemplo buscamos el primer registro cuyo estado sea igual a A y ordenado descendentemente, el resultado de ste, se carga a la variable $Usuarios e igualmente devuelve una instancia del mismo objeto ActiveRecord en caso de xito o false en caso contrario. Con el mtodo find_first podemos buscar un registro en particular a partir de su id de esta forma:
1. $this->Usuarios->find_first(123);
As obtenemos el registro 123 e igualmente devuelve una instancia del mismo objeto ActiveRecord en caso de xito o false en caso contrario. Kumbia genera una advertencia cuando los criterios de bsqueda para find_first devuelven ms de un registro, para esto podemos forzar que se devuelva solamente uno, mediante el parmetro limit, de esta forma:
70
Cuando queremos consultar slo algunos de los atributos de la entidad podemos utilizar el parmetro columns as:
1. $this->Usuarios->find_first(columns: nombre, estado);
Cuando especificamos el primer parmetro de tipo string, ActiveRecord asumir que son las condiciones de bsqueda para find_first, as:
1. $Usuarios->find_first(estado=A);
De esta forma podemos tambin deducir que estas 2 sentencias arrojaran el mismo resultado:
1. $this->Usuarios->find_first(id=123); 2. $this->Usuarios->find_first(123);
25.1.5 find
find([integer $id], [conditions: ], [order: ], [limit: ], [columns: ])
El mtodo find es el principal mtodo de bsqueda de ActiveRecord, devuelve todas los registros de una entidad o el conjunto de ocurrencias de acuerdo a unos criterios de bsqueda. Los parmetros son todos opcionales y su orden no es relevante, incluso pueden ser combinados u omitidos si es necesario. Cuando se invoca sin parmetros devuelve todos los registros en la entidad. Ejemplo:
1. foreach($Usuarios->find(conditions: estado=A , 2. order: fecha desc) as $usuario){ 3. print $usuario->nombre; 4. }//fin del foreach
En este ejemplo buscamos todos los registros cuyo estado sea igual a A y devuelva stos ordenados descendentemente, el resultado de este es un array de objetos de la misma clase con los valores de los registros cargados en ellos, en caso de no hayan registros devuelve un array vaco. Con el mtodo find podemos buscar un registro en particular a partir de su id de esta forma:
1. $this->Usuarios->find(123);
As obtenemos el registro 123 e igualmente devuelve una instancia del mismo objeto ActiveRecord en caso de xito o false en caso contrario. Como es un solo registro no devuelve un array, sino que los valores de ste se cargan en la misma variable si existe el registro. Libro de Kumbia: Porque Programar debera ser ms fcil 71
Para limitar el nmero de registros devueltos, podemos usar el parmetro limit, as:
1. $this->Usuarios->find(conditions: estado=A ,limit: 5);
Cuando queremos consultar slo algunos de los atributos de la entidad podemos utilizar el parmetro columns as:
1. $Usuarios->find(columns: nombre, estado);
Cuando especificamos el primer parmetro de tipo string, ActiveRecord asumir que son las condiciones de bsqueda para find, as:
1. $this->Usuarios->find (estado=A);
Se puede utilizar la propiedad count para saber cuntos registros fueron devueltos en la bsqueda.
En el ejemplo queremos saber la hora actual del servidor devuelta desde MySQL as que podemos usar este mtodo para esto.
En el ejemplo queremos saber la hora actual del servidor devuelta desde MySQL as que podemos usar este mtodo para esto.
25.1.8 exists
Este mtodo nos permite verificar si el registro existe o no en la base de datos mediante su id o una condicin.
1. 2. 3. 4. 5. $Usuarios->id = 3; if($Usuarios->exists()){ print "Ya existe el id = 3"; }//fin del if $Usuarios->exists(nombre='Juan Perez')
72
25.1.9 find_all_by
Este mtodo nos permite realizar una bsqueda por algn campo
1. $resultados = $Productos->find_all_by(categoria, Insumos);
25.1.10 find_by_*campo*
Este mtodo nos permite realizar una bsqueda por algn campo usando el nombre del mtodo como nombre de ste. Devuelve un solo registro.
2. $resultado = $Productos->find_by_categoria(Insumos);
25.1.11 find_all_by_*campo*
Este mtodo nos permite realizar una bsqueda por algn campo usando el nombre del mtodo como nombre de ste. Devuelve todos los registros que coincidan con la bsqueda.
3. $resultados = $Productos->find_all_by_categoria(Insumos);
25.2.2 sum
Realiza una sumatoria sobre los valores numricos de el atributo de alguna entidad, emula la funcin de agrupamiento sum en el lenguaje SQL.
1. $suma = $Productos->sum(precio); 2. $suma = $Productos->sum(precio, conditions: estado = 'A');
25.2.3 count_by_sql
Realiza una sumatoria utilizando lenguaje SQL.
$numero = $Productos->count_by_sql(select count(precio) from productos, facturas where factura.codigo = 1124 and factura.codigo_producto = productos.codigo_producto)
73
25.3.2 maximum
Busca el valor mximo para un atributo de alguna entidad, emula la funcin de agrupamiento max en el lenguaje SQL.
1. $maximo = $Productos->maximum(precio); 2. $maximo = $Productos->maximum(precio, conditions: estado = 'A');
25.3.3 minimum
Busca el valor mnimo para un atributo de alguna entidad, emula la funcin de agrupamiento min en el lenguaje SQL.
1. $minimo = $Productos->minimum(precio); 2. $minimo = $Productos->minimum(precio, conditions: estado = 'A');
25.4.2 update
Actualiza un registro a partir de los valores de los atributos del objeto ActiveRecord.
1. 2. 3. 4. $album = Album->find(12); $album->nombre = Take Off Your Pants and Jacket; $album->valor = 40000; $album->update();
25.4.3 update_all
Actualiza todos los registros de una entidad. El primer parmetro corresponde a los campos Libro de Kumbia: Porque Programar debera ser ms fcil 74
separados por comas que se van a actualizar en todos los registros; y el segundo parmetro es la condicin, aunque no es obligatoria. Tambin se puede especificar un limit para delimitar el nmero de registros que debe actualizarse.
5. $Clientes->update_all("estado='A', fecha='2005-02-02'", "id>100"); 6. $Clientes->update_all("estado='A', fecha='2005-02-02'", "id>100", "limit: 10");
25.4.4 save
Crea un registro a partir de los valores del objeto ActiveRecord o actualiza el registro si ya existe.
7. $Album = new Album(); 8. $Album->nombre = Take Off Your Pants and Jacket; 9. $Album->valor = 40000; 10.$Album->save();
25.4.5 create_from_request
Crea un registro a partir de los valores que vienen de $_REQUEST que tengan el mismo nombre de los atributos del objeto ActiveRecord.
1. $Album = new Album(); 2. $Album->create_from_request();
25.4.6 save_from_request
Crea/Actualiza un registro a partir de los valores que vienen de $_REQUEST que tengan el mismo nombre de los atributos del objeto ActiveRecord.
1. $Album = new Album(); 2. $Album->save_from_request();
25.4.7 delete
Elimina registros de la tabla o el registro actual a partir de su id.
1. $Productos->delete(123)
25.4.8 delete_all
Elimina todos los datos de una relacin mediante el objeto ActiveRecord.
1. $Productos->delete_all()
25.5 Validacin
25.5.1 validates_presence_of
Cuando este mtodo es llamado desde el constructor de una clase ActiveRecord, obliga a que se valide la presencia de los campos definidos en la lista. Los campos marcados como not_null en la tabla son automticamente validados.
75
1. 2. 3. 4. 5. 6. 7.
<?php class Clientes extends ActiveRecord { public function __construct(){ $this->validates_presence_of("cedula"); } } ?>
25.5.2 validates_length_of
Cuando este mtodo es llamado desde el constructor de una clase ActiveRecord, obliga a que se valide la longitud de los campos definidos en la lista. El parmetro minimum indica que se debe validar que el valor a insertar o actualizar no sea menor de ese tamao. El parmetro maximum indica que el valor a insertar/actualizar no puede ser mayor al indicado. El parmetro too_short indica el mensaje personalizado que ActiveRecord mostrar en caso de que falle la validacin cuando es menor y too_long cuando es muy largo.
1. class Clientes extends ActiveRecord { 2. 3. public function __construct(){ 4. $this->validates_length_of("nombre", "minumum: 15", "too_short: El nombre debe tener al menos 15 caracteres"); 5. $this->validates_length_of("nombre", "maximum: 40", "too_long: El nombre debe tener maximo 40 caracteres"); 6. $this->validates_length_of("nombre", "in: 15:40", 7. "too_short: El nombre debe tener al menos 15 caracteres", 8. "too_long: El nombre debe tener maximo 40 caracteres" 9. ); 10. } 11. 12. }
25.5.3 validates_numericality_of
Valida que ciertos atributos tengan un valor numrico antes de insertar actualizar.
1. <?php 2. 3. class Productos extends ActiveRecord { 4. 5. public function __construct(){ 6. $this->validates_numericality_of("precio"); 7. } 8. 9. } 10.?>
25.5.4 validates_email_in
Valida que ciertos atributos tengan un formato de e-mail correcto antes de insertar o actualizar.
1. <?php 2. class Clientes extends ActiveRecord { 3. 4. public function __construct(){ 5. $this->validates_email_in("correo"); 6. }
76
7. 8. } 9. ?>
25.5.5 validates_uniqueness_of
Valida que ciertos atributos tengan un valor nico antes de insertar o actualizar.
1. 2. 3. 4. 5. 6. 7. 8. 9. <?php class Clientes extends ActiveRecord { public function __construct(){ $this->validates_uniqueness_of("cedula"); } } ?>
25.5.6 validates_date_in
Valida que ciertos atributos tengan un formato de fecha acorde al indicado en config/config.ini antes de insertar o actualizar.
1. 2. 3. 4. 5. 6. 7. 8. <?php class Registro extends ActiveRecord { public function __construct(){ $this->validates_date_in("fecha_registro"); } } ?>
25.5.7 validates_format_of
Valida que el campo tenga determinado formato segn una expresin regular antes de insertar o actualizar.
1. 2. 3. 4. 5. 6. 7. 8. 9. <?php class Clientes extends ActiveRecord { public function __construct(){ $this->validates_format_of("email", "^(+)@((?:[?a?z0?9]+\.)+[a?z]{2,})$"); } } ?>
25.6 Transacciones
Mtodos utilizados para hacer transacciones.
25.6.1 commit()
Este mtodo nos permite confirmar una transaccin iniciada por el mtodo begin en el motor de base de datos, si ste lo permite. Devuelve true en caso de xito y false en caso contrario. Libro de Kumbia: Porque Programar debera ser ms fcil 77
1. $Usuarios->commit()
25.6.2 begin()
Este mtodo nos permite crear una transaccin en el motor de base de datos, si este lo permite. Devuelve true en caso de xito y false en caso contrario.
1. $Usuarios->begin()
25.6.3 rollback()
Este mtodo nos permite anular una transaccin iniciada por el mtodo begin en el motor de base de datos, s ste lo permite. Devuelve true en caso de xito y false en caso contrario.
1. $Usuarios->rollback()
78
26 Validacin en ActiveRecord
ActiveRecord realiza un proceso de validacin antes de cada creacin/actualizacin de registros. Este proceso incluye validar los campos que estn marcados como no nulos (not null) en la definicin de la tabla en la base de datos y los que sean definidos por los mtodos de validacin. Vea detalles de estos mtodos en ActiveRecord API.
79
27 Callbacks en ActiveRecord
El ActiveRecord controla el ciclo de vida de los objetos creados y ledos, supervisando cuando se modifican, se almacenan o se borran. Usando callbacks (o eventos), el ActiveRecord nos permite intervenir en esta supervisin. Podemos escribir el cdigo que pueda ser invocado en cualquier evento significativo en la vida de un objeto. Con los callbacks podemos realizar validacin compleja, revisar los valores que vienen desde y hacia la base de datos, e incluso evitar que ciertas operaciones finalicen. Un ejemplo de estos callbacks puede ser una validacin en productos que evita que productos activos sean borrados.
1. class User extends ActiveRecord { 2. 3. public before_delete = no_borrar_activos; 4. 5. public function no_borrar_activos(){ 6. if($this->estado==A){ 7. Flash::error(No se puede borrar Productos Activos); 8. return cancel; 9. } 10. } 11. 12. public function after_delete(){ 13. Flash::success("Se borro el usuario $this->nombre"); 14. } 15. 16. }
A continuacin otros callbacks que podemos encontrar en ActiveRecord. El orden en el que son presentados es en el que se llaman si estn definidos:
27.1.1 before_validation
Es llamado justo antes de realizar el proceso de validacin por parte de Kumbia. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.2 before_validation_on_create
Es llamado justo antes de realizar el proceso de validacin por parte de Kumbia, slo cuando se realiza un proceso de insercin en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.3 before_validation_on_update
Es llamado justo antes de realizar el proceso de validacin por parte de Kumbia, slo cuando se realiza un proceso de actualizacin en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'. Libro de Kumbia: Porque Programar debera ser ms fcil 80
27.1.4 after_validation_on_create Es llamado justo despus de realizar el proceso de validacin por parte de Kumbia, slo cuando se realiza un proceso de insercin en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.5 after_validation_on_update
Es llamado justo despus de realizar el proceso de validacin por parte de Kumbia, slo cuando se realiza un proceso de actualizacin en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.6 after_validation
Es llamado justo despus de realizar el proceso de validacin por parte de Kumbia. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.7 before_save
Es llamado justo antes de realizar el proceso de guardar cuando se llama el mtodo save en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.8 before_update
Es llamado justo antes de realizar el proceso de actualizacin cuando se llama el mtodo save o update en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.9 before_create
Es llamado justo antes de realizar el proceso de insercin cuando se llama el mtodo save o create en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.10 after_update
Es llamado justo despus de realizar el proceso de actualizacin cuando se llama el mtodo save o update en un modelo.
27.1.11 after_create
Es llamado justo despus de realizar el proceso de actualizacin cuando se llama el mtodo save o create en un modelo.
27.1.12 after_save
Es llamado justo despus de realizar el proceso de actualizacin/insercin cuando se llama
81
27.1.13 before_delete
Es llamado justo antes de realizar el proceso de borrado cuando se llama el mtodo delete en un modelo. Se puede cancelar la accin que se est realizando si este mtodo devuelve la palabra 'error'.
27.1.14 after_delete
Es llamado justo despus de realizar el proceso de borrado cuando se llama el mtodo delete en un modelo.
82
28 Transaccionalidad
Una transaccin en una base de datos es una serie de cambios que deben ser aplicados al mismo tiempo de tal manera que se ejecuten bien cada uno de ellos y sin faltar ninguno. Si el motor de base de datos utilizado por Active Record soporta transacciones, puedes empezar, finalizar y cancelarlas mediante los mtodos begin, commit, rollback que se detallan en ActiveRecord API.
83
29 Persistencia
En ocasiones es necesario mantener persistente los valores de algn objeto ActiveRecord. Como sabemos el modelo de aplicaciones Web y en especial el de PHP, crea/destruye los objetos cada vez que se ejecuta un script a menos que usemos variables de sesin. En vista a esta necesidad, Kumbia permite mantener los valores de los Objetos ActiveRecord por las siguientes razones: 1. Se realiza muchas veces la misma consulta y sera bueno mantener estos valores mientras se ejecuta la aplicacin con tan slo realizar la consulta una sola vez. 2. Los valores del Objeto van a ser utilizados en otros mbitos de la aplicacin y sera bueno que mantuvieran su valor tras terminar la ejecucin de un determinado Script. Para esto definimos la propiedad de ActiveRecord $persistent en el modelo que queremos que sea persistente.
1. <?php 2. class Clientes extends ActiveRecord { 3. 4. public $persistent; = true; 5. 6. } //fin de la clase 7. ?>
Nota: Esta propiedad slo afecta a los objetos ActiveRecord que se acceden mediante $this> en los controladores.
84
ActiveRecord {
De esta forma ActiveRecord mediante la clase Logger crea un archivo en logs/ con un nombre como logYYYY-MM-DD.txt con las transacciones SQL generadas internamente. Tambin podemos hacerlo de esta forma para activarlo para un objeto en particular:
1. 2. 3. 4. $this->Clientes->logger = true; ... ... $this->Clientes->logger = false;
Incluso podemos cambiar el nombre del archivo generado asignndolo a la variable $logger asi:
1. <?php 2. class Clientes extends ActiveRecord { 3. public $logger = "archivo.txt"; 4. }//fin de la clase 5. ?>
85
86
31 Asociaciones
Advertencia: Esta funcionalidad slo esta disponible a partir de kumbia-0.4.4 beta3 y las asociaciones muchos a muchos no estn soportadas.
Muchas aplicaciones trabajan con mltiples tablas en una base de datos y normalmente hay relaciones entre esas tablas. Por ejemplo, una ciudad puede ser el hogar de muchos clientes pero un cliente solo tiene una ciudad. En un esquema de base de datos, estas relaciones son enlazadas mediante el uso de llaves primarias y forneas. Como ActiveRecord trabaja con la convencin: La llave fornea tiene el nombre de la tabla y termina en id, as: ciudad_id, esto es una relacin a la tabla ciudad a su llave primaria id. As que, sabiendo esto, quisiramos que en vez de decir:
1. $ciudad_id = $cliente->ciudad_id; 2. $ciudad = $Ciudad->find($ciudad_id); 3. print $ciudad->nombre;
mejor fuera:
1. print $cliente->getCiudad()->nombre;
Gran parte de la magia que tiene ActiveRecord es esto, ya que convierte las llaves forneas en sentencias de alto nivel, fciles de comprender y de trabajar. ActiveRecord (inspirado en Rails), permite manejar estas asociaciones mediante los mtodos has_one, has_many y belongs_to, que bsicamente especifican relaciones para los casos: Un registro en una tabla A esta asociado con cero o mas registros en la tabla B Un registro en una tabla A esta asociado con un numero arbitrario de registros en la fila B
87
nombre | character varying(40) | telefono | character varying(40) | direccion | character varying(50) | ciudad_id | integer | modified_in | date | fecha_at | date | estado | character(1) | Indexes: "clientes_pkey" PRIMARY KEY, btree (id)
Una llave fornea implcita en clientes que es ciudad_id esta definida por convencin de ActiveRecord pero tambin puede agregarse un control de llave fornea a nivel de RBDM. Ahora, creamos los modelos en nuestro proyecto en Kumbia:
1. <?php 2. 3. 4. 5. 6. 7. 8. 9. 10. ?> 1. <?php 2. 3. 4. 5. 6. 7. 8. 9. ?> class Ciudad extends ActiveRecord { public function __construct(){ $this->has_many('clientes'); } }
88
10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24.?>
# Muestro el nombre de la ciudad que corresponde a ese cliente $this->render_text($this->Clientes->getCiudad()->nombre); # Busco la ciudad con id=2 $this->Ciudad->find(2); # Ahora muestro todos los clientes que tenga esa ciudad foreach($this->Ciudad->getClientes() as $cliente){ $this->render_text($cliente->nombre); }//fin foreach }//fin funcion index }//fin de la clase
89
90
32 Generacin De Formularios
Los generadores de formularios son herramientas tiles para agilizar el proceso de captura/presentacin de la informacin del modelo de datos enfatizndose en la velocidad y aumento de la productividad. Algo importante a tener en cuenta es que no hay generacin de cdigo, Kumbia interpreta eventualmente las caractersticas de los modelos y genera los formularios a partir de estos. Una importante ventaja de esto es que cualquier cambio en el modelo se ve inmediatamente reflejado en nuestras aplicaciones. Las principales caractersticas de los generadores son:
Generacin de Formularios prcticos, configurables y tiles en la mayor parte de casos. Generacin Inmediata de Formularios CRUD (Create, Read, Update,Delete) sobre entidades de la base de datos. Validacin Automtica de Tipos de Datos (Numricos, Texto, Fechas,E-Mails y Tiempo). Validacin de Integridad Relacional (Llaves nicas, Llaves Forneas y Valores de Dominio) Generacin de Reportes PDF y HTML basados en la informacin del modelo. Integracin con AJAX y Servicios Web
En esta seccin se explica cmo generar rpidamente un formulario CRUD (Create, Read, Update, Delete) basados en entidades de la base de datos, mejorando la eficiencia y elevando la productividad.
91
Hacen la mayor parte del trabajo Generacin de la Interfaz Validaciones de Datos e Integridad Flujo de Entrada de Datos Presentacin de Informacin Se pueden adaptar fcilmente a necesidades especificas Se producen resultados ms rpido, sin efectos sobre la calidad ni en trabajo para el programador
No hacen todo el Trabajo. No se puede depender completamente de ellos. La lgica est encapsulada y hace difcil modificar ciertos comportamientos de los formularios.
92
33 StandardForm
StandardForm es una clase que proporciona Kumbia para la generacin rpida de formularios que tengan como objetivo el mantenimiento de la informacin de tablas y captura de datos.
33.1 Introduccin
Slo hay que preocuparse por el diseo de la base de datos, especificar sus atributos y seguir unas simples convenciones en los nombres de las columnas ms unas lneas extras de cdigo, para obtener un formulario muy til en menos de lo que esperabas. Disearemos algunas tablas ejemplo:
1. CREATE TABLE `album` ( 2. `id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT, 3. `nombre` VARCHAR(45) NOT NULL, 4. `genero_id` MEDIUMINT(8) UNSIGNED NOT NULL, 5. `artista_id` INT(10) UNSIGNED NOT NULL, 6. `valor` DECIMAL(10,0) NOT NULL, 7. `fecha_creado` DATE NOT NULL, 8. `cantidad` DECIMAL(10,0) UNSIGNED NOT NULL, 9. `estado` VARCHAR(1) NOT NULL, 10. `portada` VARCHAR(45), 11. PRIMARY KEY (`id`), 12. KEY `artista_id` (`artista_id`) 13.); 14. 15.CREATE TABLE `genero` ( 16. `id` INT(11) NOT NULL AUTO_INCREMENT, 17. `nombre` VARCHAR(50) NOT NULL, 18. PRIMARY KEY (`id`) 19.); 20. 21.CREATE TABLE `artista` ( 22. `id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT, 23. `nombre` VARCHAR(50) NOT NULL, 24. PRIMARY KEY (`id`) 25.);
93
Con estas lneas de cdigo tenemos un formulario CRUD listo para su utilizacin. El formulario resultante realiza validacin automtica de los tipos de datos (Numricos, Texto, Fechas, E-mail, Tiempo), segn el tipo definido en la estructura de en la base de datos se comportar en el formulario. 2. Es necesario crear los modelos que van a ser utilizados para hacer las operaciones. La clase StandardForm est integrada con ActiveRecord esto significa que depende de ella para hacer todas las operaciones de base de datos. Para hacer el mdulo que utilizar AlbumController creamos un archivo en models llamado album.php:
1. <?php 2. class Album extends ActiveRecord { 3. } 4. ?>
33.3.1 id
Una columna con este nombre indica que es de naturaleza auto-numrica, es decir que llevar un consecutivo por cada registro insertado. Es muy importante que sea usado tambin como llave primaria de la entidad ya que Kumbia asume en muchas situaciones que as lo es. (Si lo llamamos diferente de Id, nos crear un numrico normal y no le asignara el nmero correspondiente).
33.3.2 tabla_id
Especificar una columna con esta convencin le indicar a Kumbia que este campo es una relacin fornea a otra entidad del modelo de datos. Por ejemplo genero_id indica un campo forneo a la tabla genero en su campo id. Es importante aunque no obligatorio que los campos en ambas partes sean del mismo tipo de dato esto ayuda a mejorar la velocidad en la que se realizan las consultas y evita comportamientos indeseados.
94
33.3.3 campo_at
Los campos con nombre terminados en _at son de naturaleza fecha-tiempo que son actualizados automticamente al realizar una modificacin del registro.
33.3.4 campo_in
Los atributos terminados en _in toman la fecha-tiempo actual en el momento de ser insertados.
33.3.5 email
Los campos con nombre email son capturados de forma especial para este tipo de dato. Extra a esto, las columnas que en la base de datos definidas como NOT NULL, sern validadas automticamente para evitar que no se viole esta restriccin. Los campos de tipo fecha automticamente tienen una ayuda de calendario y validacin de das, meses, aos y bisiestos.
Los campos son validados automticamente de acuerdo a su tipo. Los campos y botones del formulario son habilitados/inhabilitados dependiendo de cada accin evitando a los usuarios hacer operaciones indebidas. El Formulario genera automticamente un reporte con la posibilidad de sacarlo en formato PDF, EXCEL, WORD, HTML y la posibilidad de ordenarlo segn cualquier campo activo. El Formulario posee una vista para navegar por los registros ms fcilmente. Permite el uso de helpers para ayudar a los usuarios a la captura de datos.
95
Ejemplo : Si el nombre de el controlador es AlbumController, entonces el nombre de la tabla la cual buscar los datos ser album. Ejemplo
1. <?php 2. class AlbumController extends StandardForm{ 3. public $scaffold = true; 4. public $source = "nombre_tabla"; 5. 6. } 7. ?>
33.6.1 set_form_caption($title)
Cambia el ttulo del formulario por uno personalizado.
33.6.2 use_helper($campo)
Permite que un $campo forneo tenga la facilidad de un formulario de ayuda extra para insertar algn dato que no se encuentre al momento de insertar. Ejemplo de los Helpers: Debes tener 2 tablas: 1) Una tabla maestra con alguna relacin usando la convencion tabla_id, por ejemplo clientes: Cdigo:
1. 2. 3. 4. 5. 6. create table clientes ( id integer not null primary key, nombre varchar(50) not null, ciudad_id integer not null, primary key(id) );
96
Cdigo:
1. 2. 3. 4. 5. create table ciudad ( id integer not null primary key, nombre varchar(50) not null, primary key(id) );
El campo ciudad_id hace la relacin, Kumbia busca un campo llamado: nombre, descripcion o detalle en la tabla ciudad Ahora en el controlador: Cdigo:
1. <?php 2. 3. class ClientesController extends StandardForm{ 4. 5. public $scaffold = true; 6. public function __construct(){ 7. $this->use_helper("ciudad"); 8. } 9. 10.?>
33.6.3 set_type_time($campo)
Indica que un campo es de tipo time (tiempo) as podemos hacer una captura utilizando un componente especial para stas.
33.6.4 set_type_textarea($campo)
Indica que un campo es de tipo textarea, especial para textos largos como comentarios y descripciones.
33.6.5 set_type_image($campo)
Hace que un $campo permita almacenar direcciones a imgenes, subirlas al servidor y gestionarlas.
33.6.6 set_type_numeric($campo)
Forza que un $campo adquiera el tipo numrico, en este caso Kumbia valida que la entrada de un campo por teclado permita solamente teclas numricas.
33.6.7 set_type_date($campo)
Forza que un $campo sea de tipo fecha, mostrando una ayuda de calendario y un selector de fechas por das, meses y aos.
97
33.6.8 set_type_email($campo)
Forza que un $campo sea de tipo email, mostrando un componente especial para capturar correos electrnicos.
33.6.9 set_type_password($campo)
Especifica que un $campo sea de tipo password, ocultando la entrada con asteriscos y obligando la reconfirmacin del dato. Los tipo password no aparecen en visualizar por motivos de seguridad .
Uso de Encriptacin en Formularios StandardForm Podemos usar el componente Password de StandarForm para encriptar, pero ocurre un problema. Por ejemplo si usamos un algoritmo como el sha1 md5, que es de una sola va, no podremos desencriptar nuevamente el valor la prxima vez que el usuario lo vaya a editar por esto se recomienda usar algoritmos como el AES con el cual si podemos aplicar desencriptacin y que esta disponible en MySQL. Los campos tipo password deben ser encriptados en el before_insert y descriptados en el after_fetch para que todo funcione bien.
1. 2. 3. 4. 5. 6. 7.
function before_insert(){ $this->Usuarios->password = "% aes_encrypt($this->post('fl_password'),'semilla')"; } function after_fetch(){ $this->Usuarios->password = "% aes_decrypt($this->Usuarios->password,'semilla')"; }
33.6.10 set_text_upper($campo)
Hace que los valores de un campo permanezcan siempre en maysculas.
el mismo nombre del de la tabla relacin entonces se debe usar column_relation para indicar el nombre de este. Con esta funcin podremos crear dinmicamente (sin seguir la convencin campo_id del StandardForm) lo mismo que use_helper($campo). Ejemplo: Debes tener 2 tablas: 1) Una tabla maestra con alguna relacin por ejemplo clientes: Cdigo:
1. 2. 3. 4. 5. 6. create table clientes ( id integer not null primary key, nombre varchar(50) not null, idciudad integer not null, primary key(id) );
Cdigo:
1. 2. 3. 4. 5. create table ciudad ( id integer not null primary key, nombre_ciudad varchar(50) not null, primary key(id) );
33.6.13 ignore($campo)
Hace que un campo no sea visualizado en el formulario, ni tenido en cuenta en las operaciones del CRUD.
99
33.6.17 not_report($campo)
Hace un campo no aparezca en el reporte. Desaparece el botn de Modificar.
33.6.18 set_title_image($im)
Nombre de imagen que aparecer antes del titulo del formulario en forma decorativa. Debe estar en el directorio public/img/
33.6.19 fields_per_row($number)
Organiza los campos del formulario colocando $number campos en cada fila. Por defecto es 1
33.6.20 unable_insert
Impide que se inserte en el formulario. Desaparece el botn de Adicionar.
33.6.21 unable_delete
Impide que se borren datos usando el formulario. Desaparece el botn de Borrar.
1. <?php 2. 3. 4. 5. 6. 7. 8. ?> class ClienteController extends StandardForm { public $scaffold = true; public function __construct(){ $this->unable_delete(); } }
33.6.22 unable_update
Impide que se actualicen datos usando el formulario. Desaparece el botn de Modificar.
33.6.23 unable_query
Impide que se consulte usando el formulario. Desaparece el botn de Consultar.
100
33.6.24 unable_browse
Impide visualizar la vista de Visualizacin. Desaparece el botn de Visualizar.
1. <?php 2. 3. 4. 5. 6. 7. 8. 9. 10.?> class ClienteController extends StandardForm { public $scaffold = true; public function __construct(){ $this->set_title_image('cliente.jpg'); $this->unable_browse(); $this->unable_update(); } }
33.6.25 unable_report
Impide la generacin del reporte. Desaparece el botn de Reporte.
33.6.26 route_to($controller,$action,$id)
Hace el enrutamiento desde un controlador a otro, o desde una accin a otra.
1. <?php 2. 1"); 3. ?> return $this->route_to("controller: clientes", "action: consultar", "id:
33.6.27 set_hidden($campo)
Coloca un campo oculto en la forma.
33.6.28 set_query_only($campo)
Hace que un campo sea de solo lectura.
101
33.6.33 show_not_nulls()
Hace que aparezca un asterisco al lado de los campos del formulario que sean obligatorios.
102
33.7.1 before_enable_insert
Al oprimir el botn insert y antes de que se habiliten los inputs para entrada de datos.
33.7.2 after_enable_insert
Al oprimir el botn insert y despus de que se habiliten los inputs para entrada de datos.
33.7.3 before_enable_update
Al oprimir el botn update y antes de que se habiliten los inputs para entrada de datos.
33.7.4 after_enable_update
Al oprimir el botn update y despus de que se habiliten los inputs para entrada de datos
33.7.5 before_enable_query
Al oprimir el botn consultar y antes de que se habiliten los inputs para entrada de datos
33.7.6 after_enable_query
Al oprimir el botn consultar y despus de que se habiliten los inputs para entrada de datos
33.7.7 before_validation
Antes de realizar el proceso de validacin en adicionar y modificar despus de oprimir aceptar
33.7.8 after_validation
Despus de realizar el proceso de validacin en adicionar y modificar despus de oprimir aceptar
33.7.9 before_insert
Al oprimir aceptar antes de insertar
103
33.7.10 before_update
Al oprimir aceptar antes de actualizar
33.7.11 before_query
Al oprimir aceptar antes de consultar
33.7.12 before_report
Al oprimir aceptar antes de sacar reporte
33.7.13 before_cancel_input(action)
Al oprimir aceptar antes de sacar reporte Algunos ejemplos:
function before_validation(){ //Muestra el valor de todos los campos antes //de que Kumbia haga el proceso de validacion Fields.each(function(field){ alert($C(field).value) }) } function before_insert(){ //Calcula el valor del IVA antes de insertar $C("valor_iva").value = $V("valor") * 0.12 } function before_enable_update(){ //Impide la modificacin ya que el estado //del producto es Inactivo if($V("estado")=="I"){ alert("No se puede modificar producto inactivo") return false } } function after_cancel_input(action){ // Se ejecuta al cancelar la captura // el parametro action indica la accion cancelada // Adicionar, Modificar, Consultar, Reporte if(action=="Adicionar"){ alert("Cancelo El proceso de Insercin") return } } function nombre_focus(){ alert("Te has parado sobre el campo nombre") } function nombre_blur(){ alert("Has salido del campo nombre con valor: "+$C("nombre").value) }
104
//Nota: La funcion $C permite acceder al campo/objeto del formulario StandardForm //La Funcion $V permite acceder al valor del campo/objeto sin importar de que tipo sea
Existen 2 tipos de eventos los before_ (antes de) y los after_ (despus de). Los mtodos before_ se ejecutan antes de una determinada operacin y cuando devuelven false cancelan la operacin que se est trabajando. Por ejemplo un return false desde before_update cancelara la actualizacin.
Los eventos after funcionan mejor para ejecutar procesos complementarios a la operacin actual.
Los eventos de StandardForm son complementarios a los eventos de ActiveRecord. A continuacin una lista de eventos:
33.8.1 before_insert
Se ejecuta antes de la operacin insert. Si devuelve false cancela la insercin.
33.8.2 after_insert
Se ejecuta despus de la operacin insert.
33.8.3 before_update
Se ejecuta antes de la operacin update. Si devuelve false cancela la actualizacin.
1. function before_update(){ 2. if ($this->Tareas->finalizada == "F"){ 3. Flash::warning("La fecha actualizada"); 4. //Actualiza a la fecha de hoy, cuando se finaliza... 5. 6. 7. 8. }
33.8.4 after_update
Se ejecuta despus de la operacin update.
33.8.5 validation
Se ejecuta antes de insertar y modificar. Ideal para validaciones de usuario.
33.8.6 before_delete
Se ejecuta antes de la operacin delete. Si devuelve false cancela el borrado.
1. function before_delete(){ 2. if($this->Album->estado=='A'){ 3. Flash::error('No se puede borrar porque est activo el Album'); 4. //Hace falta que el metodo devuelva false asi le informara a ActiveRecord que 5. //el evento esta cancelando la accion. 6. return false; 7. } 8. }
33.8.7 after_delete
Se ejecuta despus de la operacin delete. Libro de Kumbia: Porque Programar debera ser ms fcil 106
33.8.8 before_fetch
Se ejecuta antes de realizar la operacin de mostrar un registro en la consulta.
after_fetch
Se ejecuta despus de realizar la operacin de mostrar un registro en la consulta, pero antes de mostrar el formulario. Para acceder a los valores que se van a insertar/actualizar/borrar se puede hacer de esta forma:
1. <?php 2. 3. class AlbumController extends StandardForm { 4. 5. function before_delete(){ 6. if($this->Album->estado=='A'){ 7. Flash::error('No se puede borrar porque est activo el Album'); 8. } 9. } 10. 11. ?>
Al momento de ejecutar, ste aparece como un componente html de tipo file que le permite al usuario seleccionar la imagen de su coleccin para que sea subida al servidor.
Ejemplo: Al salir del campo nombre, nos pone el mismo valor en el campo razonsocial, como se ve el cdigo javascript insertado en el onblur.
1. <?php 2. class ClientesController extends StandardForm{ 3. 4. public $scaffold = true; 5. public $template = "menu"; 6. 7. function __construct(){ 8. $this- >set_event(razonsocial, blur, '$C(razonsocial").value = $C(nombre").value'); 9. } 10. function ClientesController(){ 11. $this->set_action_caption("insert","Agregar"); 12. $this->set_action_caption("report","Listado"); 13. $this->set_form_caption("Gestin de Clientes"); 14. $this->set_title_image("logo.jpg"); 15. $this->use_helper('codpostal'); 16. } 17.} 18.?>
1. input, select { 2. font-family: Verdana; 3. font-size: 14px; 4. } 5. 6. .controlButton { 7. color: red; 8. background: white; 9. border: 1px solid green; 10. }
Cambiar estilo de las cajas de texto y componentes: Se puede definir un estilo general para las etiquetas input, select, textarea, etc o definir la clase css con un selector para el id del objeto que es ms especfica para estos componentes, as:
11. input, select { 12. font-family: Verdana; 13. font-size: 14px; 14. } 15. 16. #flid_nombre, #flid_ciudad_id { 17. color: red; 18. background: white; 19. border: 1px solid green; 20. }
Cambiar los colores de la vista visualizar: Cambiamos los colores intercalados usando las siguientes clases donde primary se refiere a uno de esos colores y a secundary al otro. La clase terminada en active es la utilizada cuando el usuario coloca el mouse encima de alguna fila.
1. .browse_primary { 2. background: #AEB9FF; 3. } 4. 5. .browse_primary_active { 6. background: #AEB9FF; 7. } 8. 9. .browse_secondary { 10. background: #FFFFFF; 11. } 12. 13. .browse_secondary_active { 14. background: #F2F2F2; 15. }
Cambiar los valores para un formulario en especial: Para esto antepondremos el nombre del controlador como clase antes de la clase o del selector en cuestin as: Libro de Kumbia: Porque Programar debera ser ms fcil 109
21. .productos input, select { 22. font-family: Verdana; 23. font-size: 14px; 24. } 25. 26. .productos #flid_nombre, #flid_ciudad_id { 27. color: red; 28. background: white; 29. border: 1px solid green; 30. }
110
34 Grid-Form
Esta clase permite la creacin de Grillas.
1. <?php 2. 3. class Paises extends GridForm { 4. 5. public $scaffold = true; 6. 7. } 8. 9. ?>
Advertencia: Este tipo de formularios estn disponibles en la versin 0.3.2 del framework. Se espera sea habilitada y documentada de nuevo en versin 0.5
111
35 Master-Detail
Este tutorial es vlido slo para la versin 0.3.2: Tablas en MySQL:
1. CREATE TABLE `ejemplo` ( 2. `id` INT(11) NOT NULL AUTO_INCREMENT, 3. `nombre` CHAR(30) DEFAULT NULL, 4. PRIMARY KEY (`id`) 5. ); 6. 7. 8. CREATE TABLE `ejemplo2` ( 9. `id` INT(11) NOT NULL AUTO_INCREMENT, 10. `ejemplo_id` INT(11) NOT NULL, 11. `detalle` CHAR(40) DEFAULT NULL, 12. `detalle2` CHAR(40) DEFAULT NULL, 13. PRIMARY KEY (`id`,`ejemplo_id`) 14.);
Advertencia: Este tipo de formularios estn disponibles en la versin 0.3.2 del framework. Se espera sea habilitada y documentada de nuevo en versin 0.5
112
113
36 Controladores
Responden a acciones de usuario e invocan cambios en las vistas o en los modelos segn sea necesario. En Kumbia los controladores estn separados en partes, llamadas front controller y en un conjunto de acciones. Cada accin sabe como reaccionar ante un determinado tipo de peticin. Las vistas estn separadas en layouts, templates y partials. El modelo ofrece una capa de abstraccin de la base de datos utilizada ,adems da funcionalidad agregada a datos de sesin y validacin de integridad relacional. Este modelo ayuda a separar el trabajo en lgica de negocios (modelos) y la presentacin (Vistas). Por ejemplo, si usted tiene una aplicacin que corra tanto en equipos de escritorio y en dispositivos de bolsillo entonces podra crear dos vistas diferentes compartiendo las mismas acciones en el controlador y la lgica del modelo. El controlador ayuda a ocultar los detalles de protocolo utilizados en la peticin (HTTP, modo consola, etc.) para el modelo y la vista. Finalmente, el modelo abstrae la lgica de datos, que hace a los modelos independientes de las vistas. La implementacin de este modelo es muy liviana mediante pequeas convenciones se puede lograr mucho poder y funcionalidad. Debemos tener siempre en mente que un controlador y una accin siempre van a ser ejecutados en cualquier peticin a la aplicacin.
36.1 Ejemplo
Para hacer las cosas ms claras, veamos un ejemplo de cmo una arquitectura MVC trabaja para agregar un producto al carrito. Primero, el usuario interacta con la interfaz seleccionando un producto y presionando un botn, esto probablemente valida un formulario y enva una peticin al servidor. 1. El controlador recibe la notificacin de una accin de usuario, y luego de ejecutar algunas tareas (enrutamiento, seguridad, etc.), entiende que debe ejecutar la accin de agregar en el controlador. 2. La accin de agregar accede al modelo y actualiza el objeto del carrito en la sesin de usuario. 3. Si la modificacin es almacenada correctamente, la accin prepara el contenido que ser devuelto en la respuesta confirmacin de la adicin y una lista completa de los productos que estn actualmente en el carrito. La vista ensambla la respuesta de la accin en el cuerpo de la aplicacin para producir la pgina del carrito de compras. 4. Finalmente es transferida al servidor Web que la enva al usuario, quien puede leerla e Libro de Kumbia: Porque Programar debera ser ms fcil 114
El archivo debe tener el nombre del controlador y la terminacin _controller.php El archivo debe estar ubicado slo en el directorio controllers El archivo debe tener al menos una clase y una de ellas debe ser el controlador que debe tener un nombre como: ProductosController, las primeras letras en maysculas y la terminacin Controller La clase debe heredar de ApplicationController o de alguna de sus sub-clases: StandardForm, GridForm o MasterDetailForm o alguna definida por el usuario.
1. <?php 2. 3. 4. 5. 6. 7. ?>
115
37 ApplicationController
Es la clase principal utilizada para crear controladores, que son la primera parte del modelo MVC. Contiene mtodos importantes para facilitar la interaccin entre stos, los modelos y la presentacin. Caractersticas:
Los valores de los atributos de las sub-clases son persistentes, es decir que no se pierden cuando termina la ejecucin de un script. Automatiza la interaccin entre la lgica y la presentacin Es sencilla de usar
37.1.1 render($view)
Visualiza una vista que pertenece al mismo controlador. Ejemplo:
1. <?php 2. 3. class ProductosController extends ApplicationController { 4. 5. function index(){ 6. $this->render('consultar'); 7. } 8. 9. } //fin de la clase 10. 11.?>
116
37.1.3 post($value)
Obtiene acceso orientado a objetos a los valores de $_POST, $value es el ndice para pasar al array asociativo.
37.1.4 get($value)
Obtiene acceso orientado a objetos a los valores de $_GET, $value es el ndice para pasar al array asociativo.
37.1.5 request($value)
Obtiene acceso orientado a objetos a los valores de $_REQUEST, $value es el ndice para pasar al array asociativo.
37.1.6 render_partial($name)
Visualiza una vista parcial (partial) que pertenece al mismo controlador. Ejemplo:
1. <?php 2. 3. class ProductosController extends ApplicationController { 4. 5. function index(){ 6. $this->render_partial('mostrar_menu'); 7. }//fin del metodo 8. 9. }//fin de la clase 10. 11.?>
Ejemplo:
1. return $this->route_to("controller: clientes", "action: consultar", "id: 1");
117
El tipo de enrutamiento que realiza es interno, es decir que lo usuarios no notan cuando estn siendo redireccionados en la aplicacin.
37.1.8 redirect($url_controlador)
Realiza un redireccionamiento a otro controlador/accion mediante HTTP. Es til cuando queremos hacer una real redireccin que incluso cambie la URL que aparece en el explorador. Ejemplo:
1. $this->redirect(/productos/query);
37.1.9 cache_layout($minutes)
Cach de la vista views/layout/ correspondiente al controlador durante $minutes
37.1.11 set_response($type)
Especifica el tipo de respuesta que va a generar el controlador. Cuando es el valor de $type es view solamente enva la salida de la vista ms no del layout, el template o cualquier cabecera html. Es ideal en salidas AJAX o PDF. Otro valor para $type es XML.
1. 2. 3. 4. 5. 6. 7. 8. 9. <?php class PruebaController extends ApplicationController { function accion_ajax(){ $this->set_response(view); /* ... */ } } ?>
118
37.1.12 is_alnum($valor)
Evala si un campo es alfanumrico o no. Es til para validar la entrada de datos al recibirlos por parte de usuarios.
10.<?php 11. class PruebaController extends ApplicationController { 12. 13. function adicionar(){ 14. $nombre = $this->request(nombre); 15. if($this->is_alnum($nombre)==false){ 16. Flash::error(Entrada invalidad para precio); 17. return; 18. } 19. /* ..*/ 20. } 21. } 22.?>
37.1.13 is_numeric($valor)
Evala si un campo es numrico o no. Es til para validar la entrada de datos al recibirlos por parte de usuarios.
23.<?php 24. class PruebaController extends ApplicationController { 25. 26. function adicionar(){ 27. $precio = $this->request(precio); 28. if($this->is_numeric($precio)==false){ 29. Flash::error(Entrada invalida para precio); 30. return; 31. } 32. /* ..*/ 33. } 34. } 35.?>
119
Dentro del mtodo buscar podemos obtener el valor de id osea 12 en nuestro ejemplo colocando un parmetro al controlador $id podemos recoger este valor y utilizarlo internamente. Otras formas de hacer esto es utilizar los mtodos post, get o request as:
1. public function buscar(){ 2. $id = $this->request(id); 3. // o tambin 4. $id = $this->id; 5. }
120
8. }
Ahora veamos el siguiente ejemplo: http://www.kumbia.org/aplicacion/registro/buscar_fecha/2006/12/01 El sitio es: kumbia.org La aplicacin es: aplicacion El controlador es: registro La accin es: buscar_fecha La mejor forma de recoger estos valores es de la siguiente forma:
11. <?php 12. 13. class RegistroController extends ApplicactionController { 14. 15. public function buscar_fecha($ao, $mes, $dia){ 16. /* */ 17. } 18. } 19. 20. ?>
Como vemos los valores adicionales en la URL son automticamente agregados como parmetros en la accin del controlador. Que pasa con id en este ejemplo? $id es el valor del primer parmetro siempre as que si nos referimos a ste, encontramos que tiene el valor 2006. Cmo puedo obtener los parmetros extra si no s cuntos son? Aqu usamos la propiedad del controlador $parameters que contiene estos valores as que el ejemplo podramos reescribirlo as:
21. <?php 22. 23. class RegistroController extends ApplicactionController { 24. 25. public function buscar_fecha(){ 26. $ao = $this->parameters[0]; 27. $mes = $this->parameters[1]; 28. $dia = $this->parameters[2];
121
/* ... */ } }
Por ltimo podemos ver todos los parmetros que vienen en una url de Kumbia usando la propiedad del controlador $this->all_parameters. Una salida de esta variable en el ejemplo anterior con print_r muestra:
1. Array 2. ( 3. [0] 4. [1] 5. [2] 6. [3] 7. [4] 8. )
122
39 Persistencia en Controladores
ApplicationController posee una funcionalidad muy til que es la persistencia de los valores de los atributos del framework, veamos un ejemplo:
1. <?php 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. 30. 31. 32. 33. 34. 35. 36. 37. 38. 39. 40. 41. 42. 43. 44. 45. 46. 47. 48. 49. 50. 51. 52. 53. 54.
class ComprarController extends ApplicationController { /** * Tiene los valores de los items guardados en el * carrito, las propiedades de los controladores * son persistentes es decir que no se pierden a lo * largo de la ejecucin de la aplicacin * * @var array */ public $carro = array(); function index(){ } /** * Agrega un item al carrito * * @param integer $id */ function add_to_cart($id){ $this->set_response('view'); if(!isset($this->carro[$id])){ $this->carro[$id] = 1; } else { $this->carro[$id]++; } $this->render_partial('carrito'); } /** * Elimina todos los items del carrito * */ function borrar_items(){ //Indica que la vista sera solo parcial $this->set_response('view'); $this->carro = array(); $this->render_partial('carrito'); } /** * Elimina un item del carrito
123
55. 56. 57. 58. 59. 60. 61. 62. 63. 64. 65. 66. 67. 68. 69. 70. ?>
* * @param integer $id */ function borrar_item($id){ //Indica que la vista sera solo parcial $this->set_response('view'); unset($this->carro[$id]); $this->render_partial('carrito'); } }//fin de la clase
Como vemos el atributo $carro es un array que contiene los items que se van agregando al carro de compras, los valores de esta variable se mantienen en cada llamada sin utilizar llamadas extras, ni complicaciones.
124
40 Filtros en Controladores
Los controladores en Kumbia poseen unos mtodos tiles que permiten realizar ciertas acciones antes y despus de atender las peticiones en los controladores, estos mtodos son los siguientes:
En el ejemplo se solicita applicacion/empresas/insertar, el mtodo before_filter es llamado automticamente antes del mtodo insertar, en ste, validamos si la accin es insertar y si el usuario est autenticado segn nuestra variable de sesin usuario_autenticado.
125
126
41 ApplicationControllerBase
Es una clase definida en el archivo controllers/application.php, de esta forma:
1. <?php 2. 3. class ApplicationControllerBase 4. 5. 6. }//fin de la clase 7. 8. ?> {
La clase tiene como objetivo permitir que se compartan ciertos mtodos y atributos que deben estar disponibles para todos los controladores de la aplicacin.
1. <?php 2. 3. class ApplicationControllerBase { 4. 5. protected function seguridad(){ 6. /* ... */ 7. } 8. 9. }//fin de la clase 10. 11.?>
127
42 Enrutamiento y Redirecciones
Kumbia proporciona un poderoso sistema de redireccionamiento que permite cambiar el flujo de la ejecucin de una aplicacin entre los controladores MVC. Kumbia permite el re-direccionamiento de 2 formas: esttico y dinmico.
Necesitamos cambiar el flujo de la ejecucin entre controladores, bsicamente Ejemplo: El usuario trata de acceder a una accin que no existe y queremos enviarla a una vlida. Ejemplo: El usuario de la aplicacin no tiene privilegios para continuar ejecutando determinada accin y debemos enviarlo a otra
42.2 Esttico
El direccionamiento esttico ocurre en el archivo forms/config/routes.ini en donde le decimos al framework cundo debe redireccionar de acuerdo a los controladores y/o acciones solicitadas. El archivo forms/config/routes.ini se ve as:
; ; ; ; ; ; ; ; ; ; ; ; ; ; Usa este archivo para definir el enrutamiento esttico entre controladores y sus acciones Un controlador se puede enrutar a otro controlador utilizando '*' como comodn as: controlador1/accion1/valor_id1 = controlador2/accion2/valor_id2 Ej: Enrutar cualquier peticin a posts/adicionar a posts/insertar/* posts/adicionar/* = posts/insertar/* Enrutar cualquier peticin a cualquier controlador en la accin adicionar a posts/adicionar/* */adicionar/* = posts/insertar/*
Cualquier poltica definida en este archivo tiene menos relevancia sobre un direccionamiento dinmico.
128
42.3 Dinmico
Ocurre cuando en ejecucin necesitamos cambiar el flujo normal y pasar a otro controlador o a otra accin. El principal mtodo para hacer esto es usar el mtodo route_to: route_to([params: valor]) Recibe los parmetros con nombre:
controller: A que controlador se va a redireccionar action: A que accin se va a redireccionar id: Id de la redireccin
1. return $this->route_to("controller: clientes", "action: consultar", "id: 1"); No todos los parmetros son obligatorios slo el que sea necesario.
129
43 Vistas
Kumbia posee un sistema de presentacin basado en vistas (views) que viene siendo el tercer componente del sistema MVC (Model View Controller). El framework aplica un patrn de diseo llamado TemplateView que permite utilizar un sistema de plantillas y vistas que son reutilizables para no repetir cdigo y darle ms poder a nuestra presentacin. Las vistas deberan contener una cantidad mnima de cdigo en PHP para que fuese suficientemente entendible por un diseador Web y adems, para dejar a las vistas slo las tareas de visualizar los resultados generados por los controladores y presentar las capturas de datos para usuarios. Tambin proporciona unas ayudas (Vistas Helpers) que generan cierto cdigo muy comn en aplicaciones Web aumentando la productividad.
Visualizar informacin de los modelos, mensajes de los controladores e interfaz de usuario Deben gestionar cualquier salida de la Aplicacin Permiten reutilizar cdigo utilizado para presentacin en forma de plantillas. Permiten cachear las vistas para acelerar el rendimiento. Permiten el uso de Smarty como motor de Plantillas
130
En la figura podemos observar la estructura de un sitio o aplicacin Web. Cada bloque representa en nuestro caso una vista que debe ser abstrada para que no sea repetida en cada visualizacin. Como lateral, pie de pgina y cabecera se repiten siempre, entonces podramos ubicarlos a nivel de layout en donde serian comn a cualquier accin del controlador al cual pertenezca el layout. Otra alternativa es crear un partial para estos 3 bloques y reutilizarlos en otros layouts. Los partials representan pequeas unidades de vistas y son utilizados pare representar pequeos fragmentos de cdigo. La vista principal views/index.phtml representa la vista superior donde cualquier cambio a esta vista afecta las capas inferiores. La estructura del sistema de vistas es el siguiente:
131
No es necesario definir una vista para cada accin en un controlador, esto debe hacerse slo para aqullas que requieran presentar informacin al usuario. Las vistas que sean presentadas mediante AJAX deben realizar un llamado a $this>set_response('view') en su respectivo mtodo del controlador. As lograremos una salida optimizada para AJAX.
El llamado a content() hace que el contenido de la vista para accin se muestre en esa parte del layout. Un llamado a clientes/adicionar nos visualizara:
132
De esta forma estaramos mostrando el archivo _menu.phtml del directorio del controlador actual.
133
44 Vista Helpers
Kumbia posee una serie de mtodos que facilitan y agilizan la escritura de cdigo HTML al escribir una vista. El objetivo de los helpers es el de encapsular grandes cantidades de cdigo HTML o JavaScript minimizandolo en una sola funcin. A continuacin la referencia de estos:
Tambin puede recibir los parmetros before, success y oncomplete que tienen cdigo javascript que ser ejecutado antes, despus y al completar la transaccin AJAX respectivamente.
1. <?= link_to_remote("cata/y", "texto", "update: midiv", "success: new Effect.Appear('midiv')") ?> 2. <div id='midiv' style='display:none'></div>
Adicionalmente se puede usar el parmetro confirm para indicar que se debe realizar una confirmacin antes de hacer la peticin AJAX:
4. <?= link_to_remote(Borrar Producto, update: midiv, action: productos/borrar/11, confirm: Esta seguro desea borrar el producto?) ?>
134
link_to_remote puede recibir n parmetros adicionales que corresponden a atributos html correspondientes a la etiqueta 'a'.
44.1.5 javascript_include_tag($archivo_js)
Incluye un archivo javascript que esta ubicado en public/javascript. No es necesario indicar la extensin js.
1. <?= javascript_include_tag(funciones) ?> 2. // <script type='text/javascript' src='/aplicacion/public/funciones.js'></script>
44.1.6 javascript_library_tag($archivo_js)
Incluye un archivo javascript que pertenece a kumbia en public/javascript/kumbia. No es necesario indicar la extensin js.
3. <?= javascript_ilibrary_tag(validations) ?> 4. // <script type='text/javascript' src='/aplicacion/public/kumbia/validations.js'> </script>
44.1.7 stylesheet_link_tag($archivo_css)
Incluye un archivo css que est ubicado en public/css. No es necesario indicar la extensin css.
5. 6. 7. 8. <?= stylesheet_link_tag(estilos) ?> //<link rel='stylesheet' type='text/css' href='/contab/public/css/estilos .css'/> <?= stylesheet_link_tag(carpeta/estilos) ?> //<link rel='stylesheet' type='text/css' href='/contab/public/carpeta/estilos .css'/>
44.1.8 img_tag($src)
Genera una etiqueta img, el primer parmetro corresponde al nombre del archivo de imagen que se encuentra en public/img. Puede recibir 'n' parmetros adicionales de la etiqueta html 'img' para cambiar los atributos de sta.
<?= img_tag(carro.gif, width: 100, border: 0) ?> <?= img_tag(subdir_en_img/foto.jpg, width: 100, border: 0) ?>
Tambin puede indicarse el parmetro drag: true para indicar que la imagen se puede arrastrar.
135
Puede recibir 'n' parmetros adicionales de la etiqueta html 'form' para cambiar los atributos de esta. Se debe cerrar el formulario usando la funcion end_form_tag. Tambin se pueden agregar eventos javascript tales como success, before y oncomplete:
6. <?= form_remote_tag(saludo/hola, update: midiv, before: alert('Se ha enviado el Formulario')) ?> 7. Tu Nombre?: <?= text_field_tag(nombre) ?> 8. <?= submit_tag("Envio") ?> 9. <?= end_form_tag() ?> 10.<div id=midiv>Este texto ser actualizado</div>
44.1.10 form_tag($action)
Permite escribir rpidamente el inicio de un formulario html. Puede recibir 'n' parmetros adicionales de la etiqueta html 'form' para cambiar los atributos de ste. Se debe cerrar el formulario usando la funcin end_form_tag.
11.<?= 12. Tu 13.<?= 14.<?= form_remote_tag(saludo/hola) ?> Nombre?: <?= text_field_tag(nombre) ?> submit_tag("Envio") ?> end_form_tag() ?>
44.1.11 end_form_tag()
Permite hacer el cierre html de un formulario creado con form_remote_tag o form_tag.
44.1.12 comillas($texto)
Genera un texto entre comillas. Es til para evitar conflictos de comillas al enviar parmetros a los helpers. Libro de Kumbia: Porque Programar debera ser ms fcil 136
44.1.13 submit_tag($caption)
Permite crear un botn de submit donde $caption es el texto del botn. Puede recibir 'n' parmetros adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
15.<?= submit_tag("Enviar Formulario") ?>
44.1.15 button_tag($caption)
Permite crear un botn, donde $caption es el texto del botn. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
17.<?= button_tag("Adicionar") ?>
44.1.16 text_field_tag($nombre)
Permite crear una caja de texto con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
18.<?= text_field_tag("nombre", size: 40, maxlength: 45) ?>
44.1.17 checkbox_field_tag($nombre)
Permite crear una check box con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
19.<?= checkbox_field_tag("acepta_contrato", value: S, checked: true) ?>
44.1.18 numeric_field_tag($nombre)
Permite crear una caja de texto con validacin numrica automtica. El componente es creado con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
20.<?= numeric_field_tag("precio", size: 10) ?>
44.1.19 textupper_field_tag($nombre)
Permite crear una caja de texto con entrada de texto en maysculas nicamente. El componente es creado con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de Libro de Kumbia: Porque Programar debera ser ms fcil 137
sta.
21.<?= textupper_field_tag("nombre", size: 40, maxlength: 45) ?>
44.1.20 date_field_tag($nombre)
Crea un componente para capturar fechas que tiene ao, mes y da.
22.<?= date_field_tag("fecha") ?>
44.1.21 file_field_tag($nombre)
Permite crear una caja de texto para subir archivos con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de esta.
23.<?= file_field_tag("archivo") ?>
44.1.23 textarea_tag($nombre)
Permite generar un componente de textarea. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'textarea' para cambiar los atributos de esta.
24.<?= textarea_tag("descripcion", cols: 40, rows: 10) ?>
44.1.24 password_field_tag($nombre)
Permite crear una caja de texto para capturar contraseas con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
25.<?= password_field_tag("archivo") ?>
44.1.25 hidden_field_tag($name)
Permite crear un input oculto con atributo name $nombre e id idntico. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de sta.
26.<?= hidden_field_tag("archivo") ?>
138
44.1.28 upload_image_tag($nombre)
Permite crear un componente que lista las imgenes del directorio public/img/upload y permite subir una imagen a este directorio.
38.<?= upload_image_tag("archivo") ?>
_ pero $vista_partial no debe llevar el underscore inicial. El valor $valor es pasado al partial y puede ser usado en el en una variable con el nombre del partial de forma global.
1. <?= render_partial(menu) ?>
44.1.32 br_break($numero)
La funcin cuenta $numero veces que es llamada y luego imprime un <br>. Es til para separar en varias lineas contenidos que estn siendo impresos dentro de un ciclo y necesiten ser separados para ordenarlos. En el ejemplo se imprimen 3 ciudades y el resto van a la otra linea y as sucesivamente.
39.<? foreach($Ciudades->find() as $ciudad): ?> 40. <?= $ciudad->nombre ?> 41. <?= br_break(3) ?> 42.<? enforeach: ?>
44.1.33 tr_break($numero)
La funcin cuenta $numero veces que es llamada y luego imprime un </tr><tr>. Es til para separar en varias filas contenidos que estn siendo impresos dentro de un ciclo y necesiten ser separados para ordenarlos en una tabla. En el ejemplo se imprimen 4 ciudades y el resto van a la otra fila y as sucesivamente.
43.<table> 44.<? foreach($Ciudades->find() as $ciudad): ?> 45. <td><?= $ciudad->nombre ?></td> 46. <?= tr_break(4) ?> 47.<? enforeach: ?> 48.</table>
44.1.35 updater_select($nombre)
Permite generar una lista SELECT que al cambiar su valor seleccionado (onchange) realiza una peticin ajax que actualiza un contenedor html enviando como parmetro id el valor seleccionado en la lista.
1. <?= updater_select(ciudad, action: detalles/ciudad, ciudaddiv) ?> 2. <?= option_tag(0, Seleccione una..., selected: true ?> 3. <? foreach($Ciudades->find() as $ciudad): ?>
140
4. <?= option_tag($ciudad->id, $ciudad->nombre) ?> 5. <? enforeach: ?> 6. </select> 7. <div id='ciudaddiv'>Detalles de esta Ciudad</div>
44.1.36 text_field_with_autocomplete($nombre)
Permite crear una caja de texto que permite autocompletar su valor mediante una lista generada dinmicamente usando AJAX. Puede recibir 'n' parmetros con nombre adicionales de la etiqueta html 'input' para cambiar los atributos de esta. Ejemplo: views/clientes/index.phtml:
1. <script type='text/javascript'> 2. function mostrar_codigo_ciudad(caja_texto, opcion_lista){ 3. alert(El codigo de la ciudad seleccionada es +opcion_lista.id) 4. } 5. </script> 6. 7. <?= text_field_with_autocomplete(ciudad, after_update: mostrar_codigo_ciudad, action: clientes/buscar_por_nombre) ?>
controllers/clientes_controller.php:
1. <?php 2. class ClientesController extends ApplicationController { 3. // Usamos set_response('view') porque el controlador va 4. // a generar una salida tipo AJAX 5. function buscar_por_nombre(){ 6. $nombre = $this->request('nombre'); 7. $this->set_response('view'); 8. $this->clientes = $this->Clientes->find(nombre like '%$nombre%'); 9. } 10. } 11. ?>
views/clientes/buscar_por_nombre.phtml:
1. 2. 3. 4. 5. <ul> <? foreach($clientes as $cliente): ?> <li id='<?= $cliente->id ?>'>$cliente->nombre <? endforeach; ?> </ul>
Los estilos de las listas generadas pueden ser cambiados mediante la clase autocomplete que esta definida en public/css/style.css.
44.1.39 money($valor)
Imprime un valor con formato numrico con $ y decimales.
1. <?= money(10000); // $ 10,000.00 ?>
142
45 Uso de Flash
Flash es una clase muy til en Kumbia que permite hacer la salida de mensajes de error, advertencia, informativos y xito de forma estndar.
45.1 Flash::error
Permite enviar un mensaje de error al usuario. Por defecto es un mensaje de letras color rojo y fondo color rosa pero estos pueden ser alterados en la clase css en public /css/style.css llamada error_message.
1. Flash::error(Ha ocurrido un error);
45.2 Flash::success
Permite enviar un mensaje de xito al usuario. Por defecto es un mensaje de letras color verdes y fondo color verde pastel pero estos pueden ser alterados en la clase css en public /css/style.css llamada success_message.
2. Flash::success(Se realiz el proceso correctamente);
45.3 Flash::notice
Permite enviar un mensaje de informacin al usuario. Por defecto es un mensaje de letras color azules y fondo color azul pastel; pero estos pueden ser alterados en la clase css en public /css/style.css llamada notice_message.
3. Flash::notice(No hay resultados en la bsqueda);
45.4 Flash::warning
Permite enviar un mensaje de advertencia al usuario. Por defecto es un mensaje de letras color azules y fondo color azul pastel pero estos pueden ser alterados en la clase css en public /css/style.css llamada warning_message.
4. Flash::warning(Advertencia: No ha iniciado sesin en el sistema);
143
print "$producto->nombre";
Haremos una peticin a inventario/consultar por ejemplo http://localhost/demo/inventario/consultar, el proceso es el siguiente: 1. Kumbia busca el controlador inventario en el directorio controllers con el nombre Libro de Kumbia: Porque Programar debera ser ms fcil 144
2.
3. 4.
5. 6. 7.
inventario y su terminacin _controller.php como est convenido. En este archivo se debe implementar una clase InventarioController que herede de ApplicationController o de sus sub-clases StandardForm, GridForm, MasterDetailForm o alguna definida por el usuario. Kumbia ahora busca un mtodo en esta clase que corresponda a la accin consultar y la ejecuta En este mtodo realizamos una bsqueda de los productos actuales mediante el modelo ActiveRecord Productos, todos los modelos de la aplicacin pueden ser accedidos desde la aplicacin mediante $this->, como en el ejemplo. El resultado de la bsqueda es almacenado en $this->productos Al finalizar la ejecucin del mtodo consultar, el framework localiza la vista views/inventario/consultar.phtml y si existe la visualiza. Las propiedades del controlador en este caso $this->productos se convierten en variables del mismo nombre en la vista, las cuales uso para mostrar los productos en pantalla.
145
Los paquetes son grupos relacionados de clases e interfaces y proporcionan un mecanismo conveniente para manejar un gran juego de clases e interfaces y evitar los conflictos de nombres. Los paquetes permiten hacer una organizacin de clases mediante directorios. En el siguiente ejemplo tenemos una serie de archivos con clases y que contienen cierta funcionalidad en la cual no vamos a profundizar y llamaremos clases de usuario. Este directorio est ubicado en la raz del framework y contiene subdirectorios con clases que deben integrarse a nuestra aplicacin.
Kumbia proporciona un mtodo para incluir los archivos en forma de paquetes de esta forma:
1. kumbia::import('app.lib.*');
As incluiramos todos los archivos php que estn en app/lib. La funcin tambin puede hacer una importacin recursiva. Por ejemplo:
1. kumbia::import('app.com.*');
146
48 Usando AJAX
48.1 Introduccin
AJAX (abreviatura de Asynchronous JavaScript and XML) es una tcnica que extiende el modelo tradicional Web y permite realizar peticiones en Segundo plano a un sitio Web sin recargar el documento actual. Nos permite hacer todo tipo de cosas como las que puedes ver en GMail, Google Maps o Google Suggest. Podramos llegar a decir que AJAX acerca un poco las aplicaciones Web a aplicaciones de escritorio. Normalmente el modelo tradicional funciona de la siguiente manera:
El usuario origina una peticin, puede ser enviando informacin desde un formulario o solicitando algn documento, El servidor Web atiende la peticin busca el documento relacionado y devuelve completamente una pagina nueva al usuario
Como se puede ver el servidor Web y el explorador de Internet se encuentran en un proceso continuo de parar/andar; esto exige al usuario estar siempre esperando a que el servidor atienda su peticin y luego volver a trabajar y as sucesivamente. Bueno pues, AJAX permite solucionar esto y adems ofrecernos funcionalidad extra que podemos aprovechar de muchas formas. Podemos hacer peticiones en segundo plano (el usuario no se da cuenta que hay una peticin en proceso, tcnicamente no?), de esta forma podemos solicitar informacin al servidor y reemplazar partes actuales del documento sin que haya esas molestas esperas en todo momento. El servidor Web puede devolver cdigo HTML, JavaScript, XML y podemos utilizarlo para todo tipo de cosas, desde cambiar la apariencia, contenido y comportamiento del documento actual en un abrir y cerrar de ojos.
147
Con AJAX tambin obtenemos algo de rendimiento extra ya que estamos solicitando al servidor slo la parte que necesitamos y no todo el documento cada vez.
48.2 XMLHttpRequest
AJAX utiliza una caracterstica implementada en el Internet Explorer y que rpidamente lleg a otros exploradores basados en Gecko como el Firefox y otros (como el Opera y el Safari). Esta caracterstica es un objeto JavaScript llamado XMLHttpRequest que permite realizar peticiones a un servidor Web desde el explorador y manipular la respuesta del servidor despus de stas. Ntese que este objeto tambin soporta otros tipos de respuestas aparte de XML. Las peticiones de AJAX son principalmente asincrnicas es decir que no bloquean los eventos en el explorador hasta que esta termine (lo contrario de las sincrnicas). Esto es una gran ventaja ya que podemos realizar mltiples peticiones sin que una interfiera con la otra y manipulndolas de acuerdo a eventos y estados de conexin. Aunque se escucha un poco complejo en realidad es ms fcil de lo que parece adicional a esto aumenta la flexibilidad de nuestras aplicaciones. Anteriormente para realizar este tipo de cosas se usaba muchos objetos IFRAME pero la calidad, limpieza y poder de AJAX frente a IFRAME es indiscutible.
48.4 link_to_remote
Permite hacer un llamado sencillo mediante AJAX que solicita un fragmento HTML y lo
La funcin link_to_remote generalmente toma 3 parmetros: 1. El Texto del enlace Libro de Kumbia: Porque Programar debera ser ms fcil 148
2. El id del objeto HTML que se va a actualizar en este caso midiv. 3. La accin de la cual se obtendrn la informacin para actualizar. Cuando el usuario hace clic sobre el vinculo la accin hola en el controlador saludo ser invocada en segundo plano y cualquier informacin obtenida ser reemplazada en el div. El controlador controllers/saludo tiene una accin llamada hola:
1. <?php 2. class SaludoController extends ApplicationController { 3. function hola(){ 4. #Indica que el resultado sera solo una parte de la vista actual 5. $this->set_response('view'); 6. }//fin del metodo 7. }//fin de la clase 8. ?>
La implementacin vaca del mtodo indica que no hay lgica para esta accin sin embargo Kumbia carga automticamente la vista con el nombre hola.phtml en
Al probarlo el texto Esto es Kumbia con AJAX y el timestamp actual aparecern como por arte de magia en el div indicado. Antes:
Y despus:
149
48.5 form_remote_tag
Esta funcin es muy til ya que convierte un formulario tradicional en un formulario AJAX. Su funcionamiento permite enviar los valores de los componentes del formulario y enviarlos usando el XMLHttpRequest. Los datos son recibidos normalmente en las acciones de los controladores como si hubiesen sido enviados de la forma tradicional. En el siguiente ejemplo crearemos un formulario AJAX que nos preguntar nuestro nombre y despus remotamente una accin en un controlador nos enviar un emotivo saludo. Nuestra vista de ejemplo debe lucir as:
55.<?= form_remote_tag(ejemplo/hola, update: midiv) ?> 56. Tu Nombre?: <?= text_field_tag(nombre) ?> 57.<?= submit_tag("Envio") ?> 58.<?= end_form_tag() ?> 59.<div id=midiv>Este texto ser actualizado</div>
Que se ve as:
150
Ahora vamos a modificar la vista del ejemplo pasado para que reciba nuestro nombre y nos salude. As que views/ejemplo/hola.phtml se ve ahora de esta manera:
1. <h2>Hola <?= $_REQUEST[nombre] ?>!</h2>
151
49 JavaScript y Kumbia
Este lenguaje no era muy querido por los programadores antes de que naciera AJAX pues era a veces utilizado para crear molestos efectos o para abrir ventanas intrusivas y cosas por el estilo. Con AJAX el uso de Javascript se increment sustancialmente. Kumbia posee una serie funciones para trabajar con AJAX que son independientes de las definidas en prototype y que igualmente poseen una alta funcionalidad para hacer todo tipo de cosas.
49.2 AJAX.viewRequest
Es la principal funcin detrs de las funciones link_to_remote y form_remote_tag pues es la encargada de hacer una peticin a un controlador y visualizarla en un contenedor. Veamos su sintaxis:
1. <script type=text/javascript> 2. new AJAX.viewRequest( 3. { 4. action: saludo/hola, 5. container: midiv 6. } 7. ) 8. </script>
La funcin recibe un hash con estos dos parmetros mnimos que son la accin de la cual va a traer la informacin para mostrar y container donde la va a mostrar. Esta funcin al igual que otras que vamos a ver ms adelante posee unos callbacks que son acciones que se ejecutan a medida que se produce el proceso AJAX. Una aplicacin prctica de los callbacks es la de mostrar indicadores de progreso cuando una accin toma un poco ms de tiempo de lo que la paciencia de un usuario puede aguantar.
1. <script type=text/javascript> 2. new AJAX.viewRequest( 3. { 4. action: saludo/hola, 5. container: midiv, 6. callbacks: { 7. before: $(spinner).show(), 8. success: $(spinner).hide(), 9. complete: new Effect.BlindDown(midiv) 10. } 11. }
152
12. ) 13.</script> 14. 15.<div id=midiv style=display:none></div> 16. 17.<?= img_tag(spinner.gif, id: spinner, style: display:none); ?>
Analicemos un poco que hace esto. Hemos agregado al hash otro hash llamado callbacks que tiene los nombres de unos eventos que se van ejecutando por todo el proceso de la accin AJAX. La primera que vemos se llama before, esta es ejecutada antes de empezar la operacin AJAX puede ser tanto un string con javascript con un handle a una funcin ajax (entendamos handle como el nombre la funcin sin comillas). En el string vemos el $(spinner).show(), en este cdigo podemos ver que se esta visualizando el objeto spinner. Si no tiene experiencia con la librera prototype le recomiendo eche un vistazo a http://prototypejs.org, la forma en que esta escrito nos permite hacer una referencia a la imagen spinner (que es un indicador de progreso) y mostrarla ya que se encuentra invisible para el usuario. Escribirla de esa forma en vez de escribir:
document.getElementById(spinner).style.display=;
es la magia que tiene la librera prototype. El segundo evento es success que se ejecuta al terminar la ejecucin de la operacin AJAX el ultimo es complete que se ejecuta al completar la carga del resultado devuelto por la accin Kumbia. Tambin podemos ver que el evento complete tiene algo nuevo: Effect.BlindDown esto nos indica que al completar la carga se va a realizar un efecto visual de persiana para mostrar el contenido de una forma ms llamativa para el usuario. En un captulo posterior vamos a detallar ms los efectos visuales.
49.3 AJAX.xmlRequest
Con AJAX tambin podemos manipular respuestas XML del servidor. En ocasiones es til cuando necesitamos tratar informacin formateada por ejemplo una validacin o retornar el nombre de un cliente consultando por su cdula. Veamos como funciona:
1. <script type=text/javascript> 2. new AJAX.xmlRequest( 3. { 4. action: consultas/cliente, 5. asynchronous: false, 6. parameters: id=+$(documento).value, 7. callbacks: { 8. complete: function(xml){ 9. row = xml. getElementsByTagName(row) 10. alert(row[0].getAttribute(nombre))
153
No nos asustemos con este cdigo. Veamos paso por paso que hace. El parmetro action cumple la misma tarea que en el ejemplo pasado, indicar de que accin y controlador se tomar la salida xml para despus manipularla y obtener los datos deseados. El siguiente es paremeters cumple la funcin de enviar datos adicionales a la accin en la operacin AJAX. Los callbacks son los mismos de AJAX.viewRequest con la diferencia que un parmetro especial es enviado al callback complete. Este permite mediante las funciones DOM manipular el rbol XML y obtener los datos requeridos. En nuestro caso estamos consultado los tags que se llamen row y mostrando con un alert el valor de su atributo nombre. Un parmetro interesante es asynchronous: (el mismo de A(asynchronous) J(avascript) A(nd) X(ml)) que por defecto tiene un valor de true. Cuando una conexin con XMLHttpRequest no es asincrnica sino todo lo contrario es decir sincrnica toma un comportamiento similar a la tradicional; o sea, que mientras no se complete la ejecucin de la operacin AJAX el usuario no podr hacer nada, ya que los eventos son congelados por parte del explorador. Muy til cuando estamos haciendo operaciones criticas o que dependen de otras posteriores. Del lado del servidor tenemos que preocuparnos por devolver al cliente un documento XML vlido con la informacin a mostrar en este. Kumbia provee la clase simpleXMLResponse que permite de forma rpida crear una salida XML para la funcin AJAX.xmlRequest. Aqu vemos como creamos un tag que internamente se llama row con un atributo cedula con el valor de la cdula correspondiente. Por ltimo, el mtodo outResponse devuelve la salida al cliente. Si no queremos usar simpleXMLResponse podemos nosotros mismos hacer una salida xml vlida, para manipularla posteriormente en el explorador cliente.
1. <?php 2. 3. 4. 5. 6. 7. 8. 9. 10. ?> class ConsultasController extends ApplicationController { function cliente(){ $this->set_response('xml'); $response = new simpleXMLResponse(); $response->addNode(array("cedula" => 11224080)); $response->outResponse(); } }
49.4 AJAX.execute
La idea de esta funcin es precisamente la de ejecutar una accin en un controlador pero sin esperar ningn tipo de respuesta. Es mejor cuando no importa lo que devuelva la accin ya utiliza menos recursos que AJAX.viewRequest o AJAX.xmlRequest. Posee los mismos callbacks que las funciones antes mencionadas.
154
1. <script type=text/javascript> 2. new AJAX.execute( 3. { 4. action: admin/logout, 5. onComplete: function(){ 6. alert(Se ejecut la accin AJAX); 7. } 8. } 9. ) 10.</script>
49.5 AJAX.query
Esta es una de las funciones ms tiles que tiene Kumbia en cuanto a AJAX. Su funcionamiento es muy sencillo, veamos un ejemplo:
1. <script type=text/javascript> 2. alert(AJAX.query(saludo/hola)) 3. </script> 1. <?php 2. class SaludoController extends ApplicationController { 3. function hola(){ 4. return Hola Amigos!; 5. } 6. } 7. ?>
155
Los tres cdigos hacen la misma tarea hacer una peticin y actualizar el objeto midiv. Dependiendo de la flexibilidad que necesitemos usaremos alguna de ellas.
49.7 Ajax.PeriodicalUpdater
Cuando necesitamos que un objeto sea actualizado frecuentemente de forma automtica podemos usar este mtodo que cumple con esa funcin.
new Ajax.PeriodicalUpdater('products', '/some_url', { method: 'get', insertion: Insertion.Top, frequency: 1, decay: 2 });
Frecuencia es el nmero de segundos que pasa entre cada peticin, decay es el nmero de segundos de espera que tiene antes de hacer una nueva peticin cuando la anterior no ha tenido xito o se ha demorado.
156
50 Prototype en Kumbia
Estas son algunas funciones que ayudan al programador usando JavaScript y la librera Prototype en la versin extendida de Kumbia: Hay muchas ventajas para usar las funciones Prototype: Prototype encapsula muchos detalles incompatibles de los exploradores Web y los hace compatibles con esto no debemos preocuparnos por probar que funcione bien tanto en Firefox y en Internet Explorer y hasta en Safari. Nuestro cdigo JavaScript se hace ms legible y potente Prototype elimina muchos de los memory leaks (conflictos de memoria) muy comunes cuando usamos Ajax Eventos (event handlers) en Internet Explorer.
Algunos puntos a tener en cuenta: Como sabemos, la lgica adicional encapsulada en prototype consume ligeramente un poco ms de ancho de banda. Para esto existen versiones comprimidas de prototype cuando esto sea un problema. Existen mas desventajas?
50.1 General
Prototype proporciona una serie de mtodos convenientes al programador. La mayora de estos mtodos son alias de otros mtodos, con excepcin de el mtodo $, que permite acceder a objetos del DOM con funcionalidad adicional. Estos mtodos tienen funcionalidades muy especficas que facilitan y agilizan el trabajo en todo tipo de necesidades. El ms comn de estos mtodos es sin duda $( ), que es usado a lo largo de todo el framework y de Prototype para obtener un objeto de un elemento del DOM a partir de su ID. Bsicamente cumple la tarea de simplificar el document.getElementById.
50.1.1 $
$(id | element) -> HTMLElement $((id | element)...) -> [HTMLElement...]
Si se proporciona un string como parmetro devuelve el objeto que coincida con el id dado, de lo contrario devuelve el objeto enviado. Tambin puede tomar un nmero arbitrario de elementos, cada uno de ellos es extendido con mtodos especiales que facilitan su tratamiento.
157
1. function foo(element) { 2. element = $(element); 3. /* demas funcin... */ 4. } 5. 6. //<input type='text' id='nombre'> 7. alert($("nombre").value) 8. 9. //<div id='nombre'>...Hola</div> 10.alert($("nombre").innerHTML) // -> ...Hola 11. 12.// Sin $ 13.Element.hide('itemId'); 14.//Mejor y se garantiza que el objeto tenga todos los mtodos Prototype 15.$('itemId').hide(); 16. 17.//Ocultar los elementos item1, item2, item3 18.['item1', 'item2', 'item3'].each(Element.hide); 19. 20.//Lo mismo pero con $ 21.$('item1', 'item2', 'item3').invoke('hide');
50.1.2 $F
1. $F(element) -> value
Devuelve el valor de un objeto de formulario sin importar su tipo (input text, input hidden, textarea, select, input checkbox, input file, etc)
2. //<input type='text' id='nombre' value='Andres'> 3. alert($F("nombre")) // --> Andres 4. 5. //<select id='ciudad'> 6. // <option>Bogot 7. // <option>Cali 8. // <option selected>Medellin 9. //</select> 10. alert($F("ciudad")) // --> Medellin
50.1.3 $V
$V(element) -> value
Devuelve el valor de un objeto de un formulario StandardForm sin importar su tipo (input text, input hidden, textarea, select, input checkbox, input file, etc)
11. function before_insert(){ 12. alert($(flid_nombre).value) 13. // es lo mismo que: 14. alert($V(nombre)) 15. }
50.1.4 $C
$C(element) -> htmlObject
158
50.2 Number
Funciones que se aplican a objetos numricos
50.2.1 times
times(iterator) -> Number
Encapsula un ciclo normal [0..n] estilo Ruby. La funcin que se enva como parmetro es llamada cada ciclo con el nmero correspondiente como parmetro empezando siempre desde 0.
1. 2. 3. 4. 5. var s = ''; (5).times(function(n) { s += n; }); s // -> '01234'
50.2.2 upto
upto(numero_maximo, iterator) -> Number
Realiza un ciclo desde el valor del objeto hasta el limite marcado, La funcin que se enva como parmetro es llamada cada ciclo con el nmero correspondiente como parmetro empezando siempre desde el valor del objeto.
1. 2. 3. 4. 5. var s = ''; (2).upto(5, function(n) { s += n; }); s // -> '2345'
50.2.3 downto
downto(numero_maximo, iterator) -> Number
Realiza un ciclo desde el valor del objeto hasta el limite marcado en forma descendente, La funcin que se enva como parmetro es llamada cada ciclo con el nmero correspondiente como parmetro empezando siempre desde el valor del objeto.
1. var s = ''; 2. (5).downto(2, function(n) {
159
50.2.4 next
next() -> Number
50.2.5 step
step(limit, step) -> Number
Realiza un ciclo desde el valor del objeto hasta el valor limite cada valor de step. Si step es negativo entonces lo hace descendentemente.
1. 2. 3. 4. 5. 6. 7. var s; s = ''; n = 12; n.step(6, -3, function(x){ s+=x }) alert(s) // --> 1296
50.3 Array
Funciones que se aplican a Arrays
50.3.1 clear
clear() -> Array
50.3.2 clone
clone() -> newArray
160
50.3.3 compact
compact() -> newArray
Devuelve una nueva versin del array, sin ningn valor null/undefined.
1. ['frank', , 'sue', , 'sally', null].compact() 2. // -> ['frank', 'sue', 'sally']
50.3.4 each
each(iterator) -> Array
Itera sobre los elementos del array en forma ascendente de acuerdo a su ndice numrico.
1. ['one', 'two', 'three'].each(function(s) { 2. alert(s); 3. }); 4. [ 'hello', 'world'].each(function(s, index) { 5. alert(index + ': ' + s); 6. }); 7. // muestra -> '0: hello' then '1: world' 8. 9. var result = []; 10.$R(1,10).each(function(n) { 11. if (0 == n % 2){ 12. //Ir a la siguiente iteracin 13. return; 14. } 15. if (n > 6){ 16. //Termina el ciclo 17. throw $break; 18. } 19. result.push(n); 20.}); 21.// result -> [1, 3, 5]
50.3.5 first
first() -> value
50.3.6 indexOf
indexOf(value) -> position
161
Devuelve la posicin de la primera ocurrencia de un argumento en el array. Si el argumento no existe en el array devuelve -1. Nota: Usa el operador de equivalencia ==, no el operador de igualdad ===. El ejemplo a continuacin muestra esto.
1. 2. 3. 4. 5. 6. [3, 5, 6, 1, 20].indexOf(1) // -> 3 [3, 5, 6, 1, 20].indexOf(90) // -> -1 [0, false, 15].indexOf(false) // -> 0 en vez de 1, porqu 0 == false!
50.3.7 inspect
inspect() -> String
50.3.8 last
last() -> value
50.3.9 reduce
reduce() -> Array | singleValue
Reduce un array: arrays de un solo elemento se convierten en un solo elemento, mientras que arrays de mltiples elementos se devuelven intactos.
1. [3].reduce(); // -> 3 2. [3, 5].reduce(); // -> [3, 5]
50.3.10 reverse
reverse([inline = true]) -> Array
Devuelve una versin en orden reverso del array. Por defecto, directamente reversa el original. Si inline es falso, usa un clon del original.
1. 2. 3. 4. 5. var nums = [3, 5, 6, 1, 20]; nums.reverse(false) // -> [20, 1, 6, 5, 3] nums // -> [3, 5, 6, 1, 20] nums.reverse() // -> [20, 1, 6, 5, 3] nums // -> [20, 1, 6, 5, 3]
162
50.3.11 max
max([iterator = Prototype.K]) -> maxValue
Devuelve el mximo elemento de un array o un hash. Devuelve undefined si la lista est vaca.
1. $R(1,10).max() // -> 10 2. 3. ['hello', 'world', 'gizmo'].max() // -> 'world' 4. function Person(name, age) { 5. this.name = name; 6. this.age = age; 7. } 8. 9. var john = new Person('John', 20); 10. var mark = new Person('Mark', 35); 11. var daisy = new Person('Daisy', 22); 12. 13. [john, mark, daisy].max(function(person) { 14. return person.age; 15. }) 16. 17. // -> 35
50.3.12 inject
inject(accumulator, iterator) -> accumulatedValue
Construye incrementalmente un resultado a partir de los valores retornados por un iterador. Puede ser til para realizar sumatorias o promedios.
18. $R(1,10).inject(0, function(acc, n) { return acc + n; }) // -> 55 (suma de 1 a 10) 19. $R(2,5).inject(1, function(acc, n) { return acc * n; }) // -> 120 (factorial 5) 20. 21. ['hello', 'world', 'this', 'is', 'nice'].inject([], function(array, value, index) { 22. if (0 == index % 2) 23. array.push(value); 24. return array; 25. }) 26. // -> ['hello', 'this', 'nice'] 27. 28. var array1 = []; 29. var array2 = [1, 2, 3].inject(array1, function(array, value) { 30. array.push(value * value); 31. return array; 32. }); 33. array2 // -> [1, 4, 9] 34. array1 // -> [1, 4, 9] 35. array2.push(16); 36. array1 // -> [1, 4, 9, 16]
163
Un elemento puede ser un string que contiene el id de un objeto html o el objeto mismo en si. Los parmetros requeridos dependen del efecto que est siendo llamado y la mayora de veces no son necesarios. El parmetro opciones es usado para especificar personalizacin adicional al efecto. Hay opciones generales y especificas. A continuacin las listamos: Opcin duration fps Descripcin Valor decimal que indica la duracin del efecto. Por defecto 1.0 Indica cuntas capas por segundo. Por defecto 25. No puede ser mayor a 100. 164
Opcin transition
Descripcin Especifica una funcin que modifica el punto actual de la animacin, que debe estar entre 0 y 1. Las siguientes transiciones son proporcionadas: Effect.Transitions.sinoidal (default), Effect.Transitions.linear, Effect.Transitions.reverse, Effect.Transitions.wobble and Effect.Transitions.flicker. Especifica el punto de inicio de la transicin. Es un valor decimal entre 0 y 1. Por defecto 0.0. Especifica el punto de finalizacin del efecto. Es un valor decimal entre 0 y 1. Por defecto 1.0. Especifica si un efecto debe renderizar nuevas capas (frames) automticamente (que es lo que hace por defecto). Si el valor es true, se puede renderizar las capas manualmente llamando el mtodo render en la instancia del objeto devuelto por el contructor del efecto. Este es usado por el efecto Effect.Parallel(). Especifica las opciones de cola de efectos. Cuando es usado como un string puede tener los valores 'front' o 'end' para colocar en cola los efectos en lista de global de efectos o en un objeto que puede tener position:front/end, scope:scope, limit:1}. Para ms informacin ver Effect.Queues. Especifica el nmero de segundos que debe esperar antes de que el efecto actual inicie. Por defecto 0.0. Especifica la direccin de la transicin. Los valores pueden ser 'top-left', 'top-right', 'bottom-left', 'botton-right' 'center' (Por defecto). Slo aplica a los efectos Grow y Shrink.
from to sync
queue
delay direction
Adicionalmente, los parmetros opcionales pueden tener eventos (callbacks), as se puede especificar que cierta funcin o procedimiento javascript sea ejecutado mientras el efecto est corriendo. Los callbacks son llamados con el objeto del efecto que es enviado. A continuacin un ejemplo de esto:
1. function callback(obj){ 2. for(var i in obj.effects){ 3. alert(obj.effects[i]['element'].id); 4. } 5. }
Callback beforeStart
165
Descripcin animacin. Es el evento que se llama al iniciar el efecto. Es llamado antes de cada iteracin del ciclo de animacin. Es llamado despus de cada iteracin del ciclo de animacin. Es llamado despus de la ultima iteracin del ciclo de animacin. Es es el evento que se llama al finalizar el efecto.
51.1.1 Effect.Opacity
Este efecto cambia la opacidad de un elemento (transparencia).
Sintaxis
new Effect.Opacity('id_del_elemento', [opciones]); new Effect.Opacity(elemento, [opciones]);
Ejemplo
Ejemplo simple:
new Effect.Opacity('id_del_elemento', {duration:0.5, from:1.0, to:0.7});
Har transparente un elemento desde el 100% hasta el 70% de transparencia en un tiempo de medio segundo.
<div id='zoneCode'>Esto es la zona de cdigo</div> <a href='#' onClick='new Effect.Opacity("zoneCode", {duration:1.0, from:1.0, to:0.0});return false;'>Ocultar Zona de Codigo</a> <a href='#' onClick='new Effect.Opacity("zoneCode", {duration:1.0, from:0.0, to:1.0});return false;'>Mostrar Zona de Codigo</a>
166
51.1.2 Effect.Scale
Este efecto cambia las dimensiones (ancho y alto) y las unidades base de em (tamao de letra) de un objeto. Permite producir un smooth, escalamiento relativo automtico de todo el contenido del elemento escalado.
Sintaxis
new Effect.Scale('id_del_elemento', porcentaje, [opciones]); new Effect.Scale(elemento, porcentaje, [opciones]);
Descripcin Especifica si un elemento debe ser escalado horizontalmente. Por defecto si, true. Especifica si un elemento debe ser escalado verticalmente. Por defecto si, true. Indica si el contenido del objeto tambin debe ser escalado. Por defecto true Si es true, el escalamiento ocurre de una forma en la que el centro del objeto siempre sea el mismo. Hace parecer que el objeto crece/disminuye desde el mismo punto. Por defecto false. Si es 'box' (por defecto escala el rea visible del elemento o 'contents' que escala el elemento completo que es la parte normalmente visible mas lo que se ve si se hace un scroll por parte de un usuario. Puede tambin especficamente controlar el tamao que va a tener el objeto asignando la altura y ancho original con las variables originalHeight y originalWith a scaleMode de esta forma:
scaleMode: { originalHeight: 400, originalWidth: 200 }
scaleMode
scaleFrom
Especifica el porcentaje inicial del proceso de escalamiento antes de empezar a escalar el objeto. Por defecto 100.
51.1.3 Effect.Morph
Este efecto cambia las propiedades CSS de un elemento.
Sintaxis
Sencillo :
1. $('ejemplo_morph').morph('background:#080; color:#fff');
Complejo :
1. new Effect.Morph('error_message',{ 2. style:'background:#f00; color:#fff;'+
167
Estilos como llaves de un array (has) deben tener nombres javascript en vez de nombres css: Style as a hash (ej backgroundColor en vez de background-color):
1. new Effect.Morph('example',{ 2. style:{ 3. width:'200px' 4. } 5. });
Tambin puede usar $(element_id).morph({width:200px}), que es ms corto. Opcin Descripcin style El estilo destino de su elemento, se puede escribir como CSS estndar o como llaves de un array asociativo (hash).
Detalles
Effect.Morph toma los estilos originales dados por reglas CSS o atributos inline en consideracin cuando se calculan las transformaciones. Trabaja con todas las propiedades CSS de tamao y color, incluyendo margenes, paddings, bordes, opacidad t colores de texto y fondo.
51.1.4 Effect.Move
Este efecto permite mover un elemento. Effect.MoveBy es un nombre antiguo.
Ejemplo
Esto mover un objeto a la esquina de la ventana. (x=0, y=0)
new Effect.Move (obj,{ x: 0, y: 0, mode: 'absolute'});
Esto mover un objeto 30px arriba y 20px a la derecha (el modo predeterminado es relative):
new Effect.Move (obj,{ x: 20, y: -30, mode: 'relative'});
51.1.5 Effect.Highlight
Este efecto da importancia a un objeto cambiando el fondo de este por un color llamativo. Es muy usado para indicar a un usuario que un objeto a sido actualizado va javascript o AJAX cuando no sea obvio.
Sintaxis
Libro de Kumbia: Porque Programar debera ser ms fcil 168
Opcion startcolor
Descripcin Especifica el color de fondo inicial que tomar el objeto. Por defecto #ffff99 (light yellow) Indica el color que tomar el objeto en el ltimo frame del efecto. Es la mejor forma de indicar cual debe ser el color que debe tomar el objeto al terminar el efecto. Por defecto #ffffff (white).
endcolor
Indica el color de fondo del elemento al finalizar el efecto. Por defecto restorecolor toma el color de fondo que tenia el objeto antes de iniciar el efecto. Ver Nota.
Notas
Si la opcin restorecolor no es dada, Effect.Highlight trata de buscar el color actual de fondo y slo es posible en todos los exploradores si el color ha sido dado por una tripleta rgb, as: rgb(0, 255, 0). Este efecto requiere estrictamente 'new' para generarlo o sino se va a obtener un error JavaScript.
Ejemplos
new Effect.Highlight('my_field', {startcolor:'#ff99ff', endcolor:'#999999'})
Recuerde que puede pasar un elemento DOM como primer parmetro tambin.
51.1.6 Effect.Parallel
Este es un efecto especial que permite combinar varios efectos en un solo efecto paralelo. Es el nico que no recibe un elemento como primer parmetro sino que recibe un array de subefectos.
Sintaxis
new Effect.Parallel([array de subeffectos], [opciones]);
Ejemplo
1. new Effect.Parallel( 2. [ new Effect.MoveBy(element, 100, 0, 3. { sync: true }), 4. new Effect.Opacity(element, 5. { sync: true, to: 0.0, from: 1.0 } ) ], 6. { duration: 0.5, 7. afterFinish: function(effect)
169
8. 9. 10.
{ Element.hide(effect.effects[0].this.parentNode); } } );
Effect.Appear, Effect.Fade Effect.Puff Effect.DropOut Effect.Shake Effect.Highlight Effect.SwitchOff Effect.BlindDown, Effect.BlindUp Effect.SlideDown, Effect.SlideUp Effect.Pulsate Effect.Squish Effect.Fold Effect.Grow Effect.Shrink
Adicionalmente, existe la utilidad Effect.toggle que permite cambiar el estado de visibilidad a un objeto con animaciones Appear/Fade, Slide o Blind. Effect.toggle usa cualquiera de los siguientes pares: Parametro Toggle Appear Slide Blind Aparece con Effect.Appear Desaparece con Effect.Fade
51.2.1 Effect.Appear
Hace que un elemento aparezca. Si el elemento tenia undisplay:none; en los estilos del eleemtno entonces Appear mostrar automticamente el objeto. Esto significa que debe ser agregado como un atributo del objeto y no como una regla CSS en la cabecera del documento un archivo externo. Funciona bien en todos los elementos html excepto tablas y filas de tablas. En internet explorer solo en elementos que tengan capas como divs, p, span, etc.
Ejemplos
new Effect.Appear('id_of_element'); new Effect.Appear('id_of_element', { duration: 3.0 });
170
51.2.2 Effect.Fade
Hace que un elemento se disuelva y quede oculto al final del efecto colocando la propiedad CSS display en none. Es lo contrario a Effect.Appear
Ejemplos
new Effect.Fade('id_of_element'); new Effect.Fade('id_of_element', { transition: Effect.Transitions.wobble })
Funciona bien en todos los elementos html excepto tablas y filas de tablas. En internet explorer, slo en elementos que tengan capas como divs, p, span, etc.
51.2.3 Effect.Puff
Da la ilusin de que un objeto se est esfumando estilo una nube de humo.
Ejemplos
new Effect.Puff('id_of_element'); // con opciones new Effect.Puff('id_of_element', {duration:3});
51.2.4 Effect.DropOut
Hace que un elemento se oculte y se disuelva al mismo tiempo.
Ejemplos
new Effect.DropOut('id_of_element');
Trabaja bien con elementos tipo bloque(divs, p, span, etc) pero no con tablas.
51.2.5 Effect.Shake
Mueve el elemento repetidamente de izquierda a derecha haciendo un efecto de vibracin.
Ejemplos
new Effect.Shake('id_of_element');
51.2.6 Effect.SwitchOff
Hace un efecto de un switch estilo televisin.
Ejemplos
new Effect.SwitchOff('id_of_element');
Trabaja bien con elementos tipo bloque(divs, p, span, etc) pero no con tablas.
171
51.2.7 Effect.BlindDown
Simula que se agranda un elemento estilo persiana. Es lo contrario de BlindUp.
Ejemplos
new Effect.BlindDown('id_of_element'); new Effect.BlindUp('id_of_element'); // Hacer la transicin ms larga new Effect.BlindDown('id_of_element', {duration:3});
Trabaja bien con elementos tipo bloque(divs, p, span, etc) pero no con tablas.
51.2.8 Effect.BlindUp
Simula que se acorta un elemento estilo persiana. Es lo contrario de BlindDown.
Ejemplos
new Effect.BlindDown('id_of_element'); new Effect.BlindUp('id_of_element'); // Hacer la transicin ms larga new Effect.BlindUp('id_of_element', {duration:3});
Trabaja bien con elementos tipo bloque(divs, p, span, etc) pero no con tablas.
51.2.9 Effect.SlideDown
Hace un efecto de deslizamiento hacia abajo para mostrar un objeto. Es lo contrario de SlideUp. Ejemplos
new Effect.SlideDown('id_of_element'); new Effect.SlideUp('id_of_element'); // Hacer la transicin ms larga new Effect.SlideDown('id_of_element', {duration:3});
51.2.10 Effect.SlideUp
Hace un efecto de deslizamiento hacia arriba para ocultar un objeto. Es lo contrario de SlideDown.
51.2.11 Effect.Pulsate
Hace un efecto de pulsacin sobre un elemento.
Ejemplos
new Effect.Pulsate('id_of_element');
172
51.2.12 Effect.Squish
Reduce un objeto desde desde su esquina superior izquierda.
Ejemplos
new Effect.Squish('id_of_element');
51.2.13 Effect.Fold
Reduce un objeto hasta su altura 0 y luego hasta ancho 0 hasta hacerlo desaparecer.
Ejemplos
new Effect.Squish('id_of_element');
51.2.14 Effect.Grow
Hace que un objeto crezca y aparezca. Debe estar oculto.
Ejemplos
Se puede indicar en que forma debe crecer. Puede ser: top-left, top-right, bottom-left, bottom-right y center.
51.2.15 Effect.Shrink
Hace que un objeto se reduzca y desaparesca. Debe estar visible.
Ejemplos
Se puede indicar en que forma debe reducirse. Puede ser: top-left, top-right, bottom-left, bottom-right y center.
Sintaxis
new Draggable('id_of_element',[options]);
Las posibles opciones son: Opcin handle Predeterminado (none) Descripcin Indica si el objeto slo puede ser arrastrado dentro de un lmite demarcado por otro objeto html. El valor que toma es una referencia a este objeto o su id.
173
handle
(none)
Handle tambin puede contener el nombre de una clase CSS que indica que familia de objetos limitan el arrastre del objeto. Si es true el objeto vuelve a su posicin inicial una vez termina el arrastre. Revert tambin puede ser una funcin que se ejecuta al finalizar el proceso de arrastre. Si es false no hay snap. De cualquier otra forma toma la forma xy [x,y] una function(x,y){ return [x,y] }. Indica cunto avanza al mover el objeto. La propiedad CSS zindex del objeto. Si es vertical o horizontal indica la limitante en la cual solo puede ser arrastrado. Clona el objeto original y permite arrastrar la copia de este. Define que efecto es aplicado al iniciar el arrastre. Define que efecto es usado para devolver el objeto a su posicin original. Define el efecto que finaliza el proceso de arrastre.
revert revert
false false
Adicionalmente puede tener algunos eventos (callbacks) para realizar ciertas acciones de usuario: Callback Descripcin change Es llamado cuando el objeto es movido.
51.3.1 Ejemplos
// mover un objeto y volver a su posicin inicial al terminar new Draggable('product_1',{revert:true}); // limite de direccin y espacio donde puede ser arrastrado new Draggable('my_div',{constraint:'horizontal',handle:'handle'}); Para eliminar el arrastre se debe hacer de la siguiente forma: var mydrag = new Draggable('product_1', {revert:true}) (... acciones varias ..) mydrag.destroy();
Sintaxis
Droppables.add('id_of_element',[options]);
Opciones: Opcin accept Predeterminado (none) Descripcin Acepta un string o un array de strings que referencian clases CSS. El Droppable solamente aceptar objetos que tengan estas clases. El dropabble solo aceptar objetos que sean igual a este el valor de este parmetro o el conjunto de elementos en una lista de ids que puede ser pasada como una lista. Si esta indicada el objeto cambiar su estilo CSS al indicado por la clase cuando un objeto arrastrable se encuentre sobre l. Si es horizontal vertical el droppable slo reaccionar antes un objeto Draggable si ms del 50% de ste se encuentra sobre el otro objeto en la direccin indicada.
containment (none)
hoverclass
(none)
overlap
(none)
Adicionalmente, tiene una serie de eventos que permiten indicar lgica de usuario personalizada:
Descripcin Es llamado cuando el objeto que puede recibir objetos arrastrables tiene uno sobre el. Llamado cuando el objeto recibe un objeto arrastrable.
Ejemplo
Droppables.add('shopping_cart', { accept: 'products', onDrop: function(element) { $('shopping_cart_text').innerHTML = 'Han arrastrado el objeto ' + element.alt + ' sobre mi.'; } } );
175
51.5 Ms Informacin
Script.Aculo.Us tiene muchas cosas ms interesantes como Sliders, Listas Ordenables, Autocompletadores AJAX y Edicin In-Place. Para encontrar la referencia completa de estas funciones visite:
Drag And Drop: Draggables, Droppables, Sortables, Slider Autocompletion: Autocompletado de campos tipo AJAX In Place Editing: Campos de Texto editables AJAX.
176
52 Ventanas PrototypeWindows
Las Ventanas Prototype son ventanas no intrusivas que reemplazan los pop-ups y nos permiten interactuar con los usuarios de las aplicaciones de forma ms estructura, estilizada y segura. Estas ventanas fueron creadas por Sebastien Gruhier (http://xilinus.com, http://itseb.com) basndose en script.aculo.us y prototype framework. Finalmente fueron adaptadas al core de Kumbia para que puedan ser utilizadas sin menor complicaciones.
177
En el ejemplo, cargamos las libreras necesarias para utilizar las ventanas Prototype incluyendo el archivo window.js como indica en el ejemplo en la linea 1 y los css de los temas que van a ser usados, en este caso el tema de Mac OS X. Lo siguiente es cargar la ventana a partir de un evento, para esto aprovechamos la utilidad Event.observe de prototype para agregar una funcin javascript que se ejecute al momento de cargar (load) la ventana del explorador. La referencia a window en la lnea 8 se refiere a el objeto DOM window. En la funcin del evento creamos una instancia de la clase Window que recibe como parmetros algunas opciones bsicas para crear la ventana. Usamos la variable unaVentana para referirnos a la ventana creada con la utilidad Prototype Window. En la lnea 15 indicamos que el contenido de la ventana es el contenido del div con id, contenido. Por ultimo visualizamos en pantalla la ventana usando el mtodo showCenter() para ubicar la ventana en el centro de la pantalla. Como podemos ver las ventanas pueden ser minimizadas usando el botn amarillo, maximizadas usando el botn verde y cerradas usando el botn rojo. Usuarios familiarizados con Windows o Linux preferirn usar otros temas como Vista.
178
Descripcin
Contructor de la clase Window que es usado cuando se crea una nueva ventana. new Window(id, options) Argumentos: id DOM id de la ventana que debe ser nico options Hash de opciones para la ventana, las claves para este hash se listan a continuacin.
minWidth / minHeight 100/20 resizable closable minimizable maximizable draggable showEffect true true true true true Effect.Appear Element.show
179
disponible. hideEffect Effect.Fade Element.hide none none none none 1 true 1 1 Efecto script.aculo.us con el cual se oculta la ventana. El valor por defecto depende si script.aculo.us esta disponible. Opciones utilizadas en el efecto para mostrar la ventana. Revisar seccin de Efectos Visuales. Opciones utilizadas en el efecto para ocultar la ventana. Revisar seccin de Efectos Visuales. Opciones para mostrar y ocultar. Revisar seccin de Efectos Visuales. Funcin Onload de la ventana principal, div o iframe . Opacidad de la ventana. Recentrar la ventana cuando el tamao de la ventana principal ha cambiado. Movimiento y Ajuste de tamao de la ventana usara una grilla de este tamao en X. Movimiento y Ajuste de tamao de la ventana usara una grilla de este tamao en Y. Movimiento/Ajuste de Tamao utilizara una capa wired, personalizable en <className>_wired_frame del archivo css de la clase. Destruir objeto de la ventana cuando el objeto se oculte, por defecto la ventana es tan solo ocultada. Todos los callbacks (eventos) usados en la ventana: onDestroy onStartResize onStartMove onResize onMove onEndResize onEndMove onFocus onBlur onBeforeShow onShow onHide onMinimize onMaximize onClose
wiredDrag
false
destroyOnClose
false
all callbacks
none
Mtodo
destroy() getId() setDestroyOnClose() setCloseCallback(function) setContent(id, autoresize, autoposition)
Descripcin
Destructor del objeto de la ventana Devuelve el Window id de la ventana La ventana ser destruida al hacer clic en el botn en cerrar en vez de ocultarla. Especifica la funcin que ser llamada al cerrar la ventana. Si esta funcin devuelve true la ventana puede ser cerrada. Especifica el objeto que ser insertado como el contenido de la ventana. No funciona con URLs/Iframes.
180
Argumentos: id Elemento a insertar en la ventana autoresize (default false) Ajusta el tamao para que concuerde con su contenido. autoposition (default false) Indica si la posicin de la ventana es la del objeto insertado. setHTMLContent(html) setURL(url) getURL() refresh() Especifica el contenido usando un cdigo HTML como parmetro. Especifica el contenido de la ventana usando una URL. El contenido ser visualizado dentro de un iframe. Obtener la URL del iframe interno de la ventana, solo si este existe. Actualiza el contenido de la ventana.
setAjaxContent(url, options, Especifica el contenido de la ventana usando una peticin AJAX. La showCentered, showModal) peticin debe devolver cdigo HTML. Revisa la documentacin de Ajax.Request para opciones detalladas del parmetro options. Cuando la respuesta sea obtenida, la ventana es visualizada. getContent() setCookie(name, expires, path, domain, secure) setLocation(top, left) getSize() setSize(width, height) updateWidth() updateHeight() toFront() show(modal) Devuelve el contenido de la ventana ya sea desde el iframe o el div interno. Especifica la informacin de la cookie que almacena los datos de tamao y posicin de la ventana. Especifica la posicin superior e izquierda de la ventana. Obtiene un hash con los valores de ancho y alto de la ventana. Especifica el tamao de ancho y alto de la ventana. Recomputar el tamao de la ventana con base en el ancho de su contenido. Recomputar el tamao de la ventana con base en el alto de su contenido. Coloca a la ventana por encima de todas las dems ventanas abiertas. Muestra/Visualiza la ventana. El parmetro boleano modal indica si la ventana se muestra en modo modal. El modo modal hace que la ventana pida siempre la atencin durante el tiempo que este abierta. Ideal para los cuadros de dialogo. Muestra la ventana en el centro de la pgina. El parmetro boleano modal indica si la ventana se muestra en modo modal. El modo modal hace que la ventana pida siempre la atencin durante el tiempo que este abierta. Ideal para los cuadros de dialogo. Si se indica el parmetro top se centrar solamente horizontalmente y viceversa. Minimiza la ventana, slo la barra superior es visualizada. Maximiza la ventana hasta el tamao mximo de rea visible de la ventana.
minimize() maximize()
181
Devuelve true si la ventana est minimizada. Devuelve true si la ventana est maximizada. Especifica la opacidad de la ventana. 0 es transparente y 1 es opaca. Un 0.5 es semi-opaca o semi-transparente. Especifica la propiedad CSS zIndex de la ventana que indica su posicin de atrs hacia adelante de los objetos visualizados en la pantalla. Un valor alto asegura que la ventana se muestre por encima de todos los dems objetos de la pgina. Especifica el ttulo de la ventana. Obtiene el ttulo de la ventana. Especifica el texto de la barra de estado de la ventana.
182
7. height:200, 8. url: "http://www.kumbia.org/", 9. showEffectOptions: { 10. duration:1.5 11. } 12. }) 13. win.show();
183
184
53 Funciones de Reportes
53.1 Manual de Referencia de FPDF
FPDF (http://www.fpdf.org/) es una librera PHP que es incluida en la distribucin Kumbia y que facilita la creacin de reportes y documentos en formato PDF.
53.2 Qu es FPDF?
FPDF es una clase escrita en PHP que permite generar documentos PDF directamente desde PHP, es decir, sin usar la biblioteca PDFlib. La ventaja es que, mientras PDFlib es de pago para usos comerciales, la F de FPDF significa Free (gratis y libre): puede usted usarla para cualquier propsito y modificarla a su gusto para satisfacer sus necesidades. FPDF tiene otras ventajas: funciones de alto nivel. Esta es una lista de sus principales caractersticas:
Eleccin de la unidad de medida, formato de pgina y mrgenes Gestin de cabeceras y pies de pgina Salto de pgina automtico Salto de lnea y justificacin del texto automticos Admisin de imgenes (JPEG y PNG) Colores Enlaces Admisin de fuentes TrueType, Type1 y codificacin Compresin de pgina FPDF no necesita de ninguna extensin para PHP (excepto la biblioteca zlib si se va a activar la opcin de compresin) y funciona con PHP4 y PHP5.
La ltima versin del manual de FPDF se puede encontrar en: http://www.fpdf.org/es/doc/index.php Los reportes en PDF son hoy en da una excelente alternativa a los reportes HTML tradicionales. Generar reportes PDF tiene unas ventajas significativas: Un documento PDF encapsula las fuentes que necesite para que su documento se vea tal y como lo diseo. Las margenes, tamaos y tipos de papel son ms fciles de manipular para que al realizar la impresin se vea tal y como esperamos. Ideal cuando queremos que los reportes generados no sean modificados por los
185
usuarios de las aplicaciones. Desventajas de los reportes en PDF: Algunos datos copiados desde un documento PDF son difciles de manipular. El tamao de un archivo PDF es ligeramente ms grande que el un reporte en HTML. Es necesario que el usuario tenga instalado un visor PDF como Acrobat, GhostView o xpdf.
54 Correo Electrnico
Kumbia aprovecha la librera libre PHPMailer para proporcionar un mtodo ms completo de envo de correos electrnicos en aplicaciones desarrolladas con el Framework.
54.1 Qu es PHPMailer?
PHPMailer es una clase php para enviar emails basada en el componente active server ASPMail. Permite de una forma sencilla tareas complejas como por ejemplo:
Enviar mensajes de correo con ficheros adjuntos (attachments) enviar mensajes de correo en formato HTML
Con PHPMailer se pueden enviar emails via sendmail, PHP mail(), o con SMTP. Lo ms recomendable es usando smtp por dos razones:
Con phpmailer se pueden usar varios servidores SMTP. Esto permite repartir la carga entre varias computadoras, con lo que se podrn enviar un mayor nmero de mensajes en un tiempo menor. Adems los servidores SMTP permiten mensajes con mltiples to's (destinatarios), cc's (Las direcciones que aparezcan en este campo recibirn el mensaje. Todos los destinatarios vern las direcciones que aparecen en la seccin Cc), bcc's (Las direcciones que aparezcan en el campo Bcc recibirn el mensaje. Sin embargo, ninguno de los destinatarios podr ver las direcciones que fueron incluidas en la seccin Bcc) y Reply-tos (direcciones de respuesta)
incluso utilizar tu propio servidor smtp aunque ste requiera autenticacin (un nombre de usuario y contrasea), con lo que se podr usar una cuenta gratuita de correo obtenida por ejemplo en hotpop. Puede encontrar un interesante tutorial en esta direccin: http://www.programacion.net/php/articulo/phpmailer/
54.3 Ejemplo
Hace un envo masivo, segn Pas, y actividad,que se la pasamos con un formulario :
1. <?php 2. 3. class MailingController extends ApplicationController { 4. 5. /** 6. * El controlador utiliza el mismo layout que el controlador 7. * posts osea utiliza views/layouts/posts.phtml 8. * 9. * @var string 10. */ 11. public $template = "posts"; 12. public $mensaje = array(); 13. public $paises = array(); 14. public $actividades = array(); 15. public $compte; 16. 17. public function index(){ 18. $this->paises = $this->Pais->find(); 19. $this->actividades=$this->Actividad->find(); 20. } 21. 22. public function enviar(){ 23. Session::set_data('mensaje', $this->post('mensaje')); 24. Session::set_data('adjunto', $this->post('adjunto')); 25. Session::set_data('asunto', $this->post('asunto')); 26. $this->mensaje[1] = $this->post('mensaje'); 27. $this->mensaje[2] = $this->post('adjunto'); 28. $this->mensaje[3] = $this->post('asunto'); 29. 30. $mylog = new Logger(); 31. $mail = new PHPMailer(); 32. $mail->From = "jcortes@gesproinf.com"; 33. $mail->FromName = "Prueba"; 34. $envios = 0; 35. $erroneos = 0; 36. $mybody = str_replace("\'","'",$this->post('mensaje')); 37. $mybody = str_replace('\"',"'",$mybody); 38. $mail->Subject=$this->mensaje[3]; 39. //Sender -->es para el Return-Path , para los retornos, me los envie aqui 40. $mail->Sender = "boletin@*********.com "; 41. $mail->IsHTML(true); 42. $mail->IsSMTP(); 43. $mail->Host='localhost';
187
44. $mail->Port=25; 45. $mail->Timeout=120; 46. $mail->Body=$mybody; 47. 48. $db=db::raw_connect(); 49. if(($this->post('paismail')<>"NIN") && ($this->post('actividad') == '17')){ 50. $db->query("select * from ecuentas where baja <> '1' and pais_id ='{$this->post('paismail')}'"); 51. } elseif (($this->post('paismail')=="NIN") && ($this>post('actividad')<>'17')) { 52. $db->query("select * from ecuentas where baja <> '1' and actividad_id ='{$this->post('actividad')}'"); 53. }elseif (($this->post('paismail')<>"NIN") && ($this>post('actividad')<>'17')){ 54. $db->query("select * from ecuentas where baja <> '1' and actividad_id ='{$this->post('actividad')}' and pais_id ='{$this>post('paismail')}'"); 55. }elseif (($this->post('paismail')=="NIN") && ($this>post('actividad')=='17')){ 56. $db->query("select * from ecuentas where baja <> '1'"); 57. } 58. echo ("hay" . $db->num_rows()); 59. $i = 1; 60. $grupos = $this->post('agrupar'); 61. 62. while ($ecuentasbas = $db->fetch_array()){ 63. $mail -> AddAddress ($ecuentasbas['email']); 64. 65. $exito = $mail->Send(); 66. $intentos=1; 67. 68. while ((!$exito) && ($intentos < 2)) { 69. sleep(1); 70. $exito = $mail->Send(); 71. $intentos=$intentos+1; 72. } 73. if(!$exito) 74. { 75. $erroneos = $erroneos + 1; 76. $mylog->Log("Cuenta No Enviada Id=" .$ecuentasbas['id'] ."mail= " .$ecuentasbas['email'],Logger::DEBUG); 77. } 78. else 79. { 80. $envios = $envios + 1; 81. $mylog->Log("Cuenta Enviada Id=" .$ecuentasbas['id'] ." mail= ".$ecuentasbas['email'],Logger::DEBUG); 82. } 83. $mail->ClearAddresses(); 84. $num = $num+1; 85. } 86. } 87. echo("Envio realizado completamente"); 88. $mylog->Log("Envio Finalizado Con= " .$envios ." Envios y " .$erroneos. "Envios Erroneos" ,Logger::DEBUG); 89. $mail->AddAddress("publicacion@**********.com"); 90. $mail->Subject= "Envio Finalizado Con=" .$envios." Envios y " .$erroneos. "Envios Erroneos"; 91. $mail->Send(); 92. $mylog->close(); 93. $db->close();
188
189
Usted puede crear funciones habituales y modificadores de variables customizados, de modo que el lenguaje de la platilla es altamente extensible. Sintaxis de etiquetas delimitadoras para configuracin de la plantilla, as lo puede usar {}, {{}}, , etc. Los construtoress if/elseif/else/endif son pasados por el interpretador de PHP, as la sintaxis de la expresin {if ...} puede ser compleja o simple de la forma que usted quiera. Permite un anidamiento ilimitado de sections, ifs, etc. Es posible incrustar directamente codigo PHP en los archivos de plantilla, aunque esto puede no ser necesario(no recomendado) dado que la herramienta se puede ajustar. Soporte de caching incrustado Fuentes de Plantilla absoluto Funciones habituales de manipulacin de cache Arquitectura de Plugin
Ahora tenemos la vista views/saludo/hola.tpl, Ntese que la extensin .phtml cambi a .tpl lo que indica que es una plantilla de Smarty, ahora aqu tenemos:
1. {* Smarty *} 2. 3. Hello {$name}, {$fecha}!
Con esto visualizamos en pantalla: 1. Hello Andrs Felipe, 2007-02-27 01:13! Los valores de los atributos de los controladores pasan automticamente como valores de Smarty, esto es transparente y adems ganamos velocidad ya que la vista es cacheada hasta que vuelve a cambiar.
191
56 Loggers
Los Loggers permiten crear logs para almacenar informacin que pueda ser utilizada para registrar transacciones, revisar movimientos, hacer un debug, etc Para crear un log puede utilizar la clase Logger de Kumbia:
1. //Empieza un log en logs/logDDMMY.txt 2. $myLog = new Logger(); 3. 4. $myLog->log("Loggear esto como un debug", Logger::DEBUG); 5. 6. //Esto se guarda al log inmediatamente 7. $myLog->log("Loggear esto como un error", Logger::ERROR); 8. 9. //Inicia una transaccin 10.$myLog->begin(); 11. 12.//Esto queda pendiente hasta que se llame a commit para guardar 13.// rollback para cancelar 14.$myLog->log("Esto es un log en la fila", Logger::WARNING) 15.$myLog->log("Esto es un otro log en la fila", Logger::WARNING)* 16. 17.//Se guarda al log 18.$myLog->commit(); 19. 20.//Cierra el Log 21.$myLog->close();
56.1.3 begin
Logger permite crear transacciones para evitar la escritura a disco cada vez que se llame a log sino hasta que se llame al mtodo commit o se cancele mediante rollback.
192
56.1.4 commit
Logger permite crear transacciones para evitar la escritura a disco cada vez que se llame a log sino hasta que se llame al mtodo commit se cancele mediante rollback. Commit acepta la transaccin y los valores se escriben al archivo
1. 2. 3. 4. $myLog->begin(); $myLog->log("Esto es un log en la fila", Logger::WARNING); $myLog->log("Esto es un otro log en la fila", Logger::WARNING); $myLog->commit();
56.1.5 rollback
Logger permite crear transacciones para evitar la escritura a disco cada vez que se llame a log sino hasta que se llame al mtodo commit o se cancele mediante rollback. Rollback cancela la transaccin y los valores no se escriben al archivo
1. 2. 3. 4. $myLog->begin(); $myLog->log("Esto es un log en la fila", Logger::WARNING); $myLog->log("Esto es un otro log en la fila", Logger::WARNING); $myLog->rollback();
56.1.6 close
Cierra el log para que no se pueda escribir ms en l.
1. $myLog->close();
193
194
57 Session
La clase Session proporciona un acceso orientado a objetos a datos de sesin. Los datos de sesin son usualmente utilizados para mantener valores a travs de toda la ejecucin de una sesin de aplicacin. El caso ms comn es mantener alguna variable para indicar si un usuario est logeado en el sistema o por ejemplo mantener la direccin de la cual viene un usuario antes de solicitarle autenticacin y poderlo redireccionar despus a ella de nuevo. Kumbia serializa automticamente los datos de sesin. Esto significa que puedes guardar con seguridad objetos y en algunos casos valores de recurso (resource) como conexiones a bases de datos.
57.1.3 Session::unset_data($name)
Elimina valores de sesin:
1. Session::unset_data('nombre_cliente');
57.1.4 Session::isset_data($name)
Elimina valores de sesin:
1. Session::isset_data('nombre_cliente');
195
196
58 Coders
Como dice el lema del framework Porque programar debera ser ms fcil, los Coders son esto y mucho ms. Los coders es una iniciativa por parte del grupo de desarrollo para implementar una caracterstica en Kumbia que permita que el framework identifique determinadas situaciones en las cuales pueda crear archivos, codificar o configurar componentes de la aplicacin sin que el programador deba hacerlo. Los coders son una solucin innovadora a un problema general de los frameworks de exigir al desarrollador realizar x y pasos que son obvios u obligatorios para poder obtener un resultado ms inmediato. Si sumsemos todos estos pasos podramos darnos cuenta cmo empezamos a perder tiempo y dejamos de ser tan productivos. Esta metodologa representa una mayor interaccin entre el desarrollador y su framework con la meta de lograr de convertir a Kumbia en una herramienta que trabaje en sincrona con los objetivos de quien lo use.
Crear una base de datos y una tabla clientes con algunos campos de prueba Configurar la conexin a la base de datos en Kumbia en el archivo 197
forms/config/config.ini
Activar los coders como se explica en el prrafo anterior Abrir el explorador y ver la direccin http://localhost/demo/clientes, donde demo es el nombre de tu proyecto en Kumbia.
Al realizar la peticin de este controlador Kumbia ha generado una excepcin que se puede visualizar en rojo y fondo rosa que indica el nombre de la excepcin y su tipo, con esto fcilmente podemos ver que hemos olvidado o todava no hemos trabajado en la codificacin de un formulario que trabaje con la tabla clientes. Sin embargo para nuestra fortuna Kumbia ha identificado que puede realizar esta tarea por nosotros mostrndonos el cuadro de dilogo en la parte superior con fondo lila. Adicional a esto Kumbia ha identificado que el nombre del controlador coincide con el nombre de una tabla en la base de datos y nos ofrece la opcin de crear un formulario de tipo StandardForm como opcin predeterminada. Escogemos esta opcin y damos clic en Aceptar. Libro de Kumbia: Porque Programar debera ser ms fcil 198
Kumbia ha generado un formulario con base en la tabla StandarForm creando los archivos controllers/clientes_controller.php codificando lo siguiente:
1. <?php 2. 3. class ClientesController extends StandardForm { 4. 5. public $scaffold = true; 6. 7. public function __construct(){ 8. 9. } 10. 11. } 12. 13. ?>
y adicional a esto, ha creado el modelo correspondiente en el directorio models con el nombre de clientes.php:
1. <?php
199
2. 3. 4. 5. 6. 7. ?>
Y si en este momento piensas, yo podra haber hecho eso, Kumbia te responde: no te molestes yo lo har por ti.
200
59 ACL
La Lista de Control de Acceso o ACLs (del ingls, Access Control List) es un concepto de seguridad informtica usado para fomentar la separacin de privilegios. Es una forma de determinar los permisos de acceso apropiados a un determinado objeto, dependiendo de ciertos aspectos del proceso que hace el pedido. Cada lista ACL contiene una lista de Roles, unos resources y unas acciones de acceso.
201
202
203
Nota: Para usar encoding debes tener instalada la extension iconv, cualquier otra salida en unicode. Ms Ejemplos: En esta vista de KUMBIA, Leo de un fichero xls, y creo una tabla con filas y columnas, y miro si est repetido escribo una fila con los valores de los campos:
1. <?php 2. 3. include_once "lib/excel/main.php"; 4. 5. $reader = new Spreadsheet_Excel_Reader(); 6. $reader->setUTFEncoder("iconv"); 7. $reader->setOutputEncoding('UTF-8'); 8. $reader->read("public/img/upload/Libro1.xls"); 9. $data = $reader->sheets[0];?> 10.<table cellspacing='0' cellpadding='2' border='1' style='border: 1px solid #CFCFCF'> 11. <tr class="date"> 12. <h1><b>Correo</b></h1> 13. </tr> 14. <?$db=db::raw_connect();?> 15. <? for ($i = 1; $i <= $reader->sheets[0]['numRows']; $i++) { 16. $db->query("select * from ecuentas where baja<>'1' and email='{$reader-
204
>sheets[0]['cells'][$i][2]}'"); 17. if ($db->num_rows()>0){ 18. echo("<tr>"); 19. while ($fila=$db->fetch_array()){ 20. $t = 0; 21. while ($t <= 26){ 22. echo ("<td id='repe'>"); 23. echo $fila[$db->field_name($t)]; 24. echo ("</td>"); 25. $t++; 26. } 27. } 28. echo("</tr>"); 29. } 30. echo ("<tr>"); 31. for ($j = 1; $j <= $reader->sheets[0]['numCols']; $j++) 32. { 33. if ($db->num_rows()>0){ 34. echo ("<td id='repe'>"); 35. }else{ 36. echo ("<td id='norepe'>"); 37. } 38. echo $reader->sheets[0]['cells'][$i][$j]; 39. echo ("</td>"); 40. } 41. echo "</tr>"; 42. } 43. $db->close(); 44.?> 45.</table>
205
29. $data->sheets[0]['numRows'] - count rows 30. $data->sheets[0]['numCols'] - count columns 31. $data->sheets[0]['cells'][$i][$j] - data from $i-row $j-column 32. $data->sheets[0]['cellsInfo'][$i][$j] - extended info about cell 33. $data->sheets[0]['cellsInfo'][$i][$j]['type'] = "date" | "number" | "unknown" 34. if 'type' == "unknown" - use 'raw' value, because cell contain value with format '0.00'; 35. $data->sheets[0]['cellsInfo'][$i][$j]['raw'] = value if cell without format 36. $data->sheets[0]['cellsInfo'][$i][$j]['colspan'] 37. $data->sheets[0]['cellsInfo'][$i][$j]['rowspan'] 38. */ 39. error_reporting(E_ALL ^ E_NOTICE); 40. for ($i = 1; $i <= $data->sheets[0]['numRows']; $i++) { 41. for ($j = 1; $j <= $data->sheets[0]['numCols']; $j++) { 42. echo "\"".$data->sheets[0]['cells'][$i][$j]."\","; 43. } 44. echo "\n"; 45. } 46. //print_r($data); 47. //print_r($data->formatRecords); 48. ?>
60.4.1 create_standardform($nombre)
Permite crear una clase StandardForm automticamente
60.4.2 create_model($nombre)
Permite crear una clase ActiveRecord automticamente
60.4.3 create_controller($nombre)
Permite crear una clase Application automticamente. Libro de Kumbia: Porque Programar debera ser ms fcil 206
207
Como podemos ver en la vista al realizar el submit sobre el formulario se ejecutar la accin validar en el controlador login, as que vamos a codificarlo:
1. <?php 2. 3. class LoginController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. function validar(){ 10. 11. $nombre_usuario = $this->request("usuario"); 12. $password = $this->request("password"); 13. 14. if($nombre_usuario=="felipe"&&$password=="mipassword"){ 15. Flash::success("Bienvenido Felipe"); 16. } else { 17. Flash::error("Usuario/Password incorrectos"); 18. $this->route_to("action: index"); 19. } 20. } 21. 22. } 23. 24. ?>
Lo que hacemos es recibir los valores de usuario y password que vienen de la vista y Libro de Kumbia: Porque Programar debera ser ms fcil 208
cargarlos en 2 variables locales. A continuacin hemos realizado una validacin sencilla con valores de usuario y password fijos. En caso de xito mostrar un mensaje de bienvenida, en caso contrario lo enrutar de nuevo al formulario de ingreso y mostrar un mensaje de error en la forma justo donde est el llamado a content().
Como se pudo ver, el ejemplo muestra una validacin que aunque til como ejemplo no muestra el caso habitual que resulta al validar contra una tabla de usuarios en la base de datos. Vamos a crear una tabla en MySQL llamada usuarios con la siguiente estructura:
+----------+--------------+------+-----+---------+----------------+ | Field | Type | Null | Key | Default | Extra | +----------+--------------+------+-----+---------+----------------+ | id | int(11) | NO | PRI | NULL | auto_increment | | nombre | varchar(100) | NO | | | | | login | varchar(32) | NO | | | | | password | varchar(40) | NO | | | | +----------+--------------+------+-----+---------+----------------+
Una caracterstica especial de esta tabla es el campo password que tiene un tipo de dato char(40), esto debido a que en este campo se van a guardar valores encriptado con sha1 que genera una cadena de 40 caracteres. Para poder interactuar entre la tabla y nuestro controlador login, vamos a necesitar de un modelo, para esto creamos el archivo models/usuarios.php: Libro de Kumbia: Porque Programar debera ser ms fcil 209
Ahora podemos realizar la validacin segn los registros guardados en la base de datos. Cambiamos la accin validar para que verifique usando el modelo recin creado as:
1. <?php 2. 3. class LoginController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. function validar(){ 10. 11. $nombre_usuario = $this->request("usuario"); 12. $password = $this->request("password"); 13. 14. if($this->Usuarios->find_first("login = '$nombre_usuario' and password = sha1('$password')")){ 15. Flash::success("Bienvenido {$this->Usuarios->nombre}"); 16. 17. 18. 19. 20. 21. 22. 23. 24. 25. ?> } else { Flash::error("Usuario/Clave incorrectos"); return $this->route_to("action: index"); } } }
210
ejemplo
con
una
accin
reporte
en
1. <?php 2. 3. class EjemploController extends ApplicationController { 4. 5. function reporte(){ 6. 7. $this->set_response("view"); 8. 9. $reporte = new FPDF(); 10. 11. //Abrimos el PDF y agregamos una pagina 12. $reporte->Open(); 13. $reporte->AddPage(); 14. 15. //Seleccionamos las fuentes 16. $reporte->AddFont('Verdana','','verdana.php'); 17. $reporte->SetFont('Verdana','', 14); 18. 19. //Agregamos el Titulo del Reporte 20. $reporte->MultiCell(0, 6, "Reporte de Clientes", 0, C, 0); 21. 22. //Pasamos a la siguiente Linea 23. $reporte->Ln(); 24. 25. //Cambiamos colores de Fondo (Fill), borde (Draw), Texto (Text) 26. $reporte->SetFillColor(0xF2, 0xF2, 0xF2); 27. $reporte->SetTextColor(0); 28. $reporte->SetDrawColor(0, 0, 0); 29. $reporte->SetFont('Arial', 'B', 10); 30. 31. //Nos movemos un poco a la derecha 32. $reporte->SetX(30); 33. 34. //Agregamos los encabezados del reporte 35. $reporte->Cell(4, 7, "Id", 1, 0, 'C', 1); 36. $reporte->Cell(50, 7, "Nombre", 1, 0, 'C', 1); 37. $reporte->Cell(22, 7, "Fecha", 1, 0, 'C', 1); 38. $reporte->Cell(26, 7, "Telefono", 1, 0, 'C', 1); 39. $reporte->Cell(50, 7, "Direccin", 1, 0, 'C', 1); 40. 41. //Pasamos a la siguiente Linea 42. $reporte->Ln(); 43. 44. //Cambiamos el color de fondo y letra 45. $reporte->SetFillColor(0xFF, 0xFF, 0xFF); 46. $reporte->SetFont('Arial', '', 10); 47. 48. //Consultamos los Clientes 49. foreach($this->Clientes->find() as $cliente){ 50. 51. $reporte->SetX(30); 52. 53. $reporte->Cell(4, 7, $cliente->id, 1, 0, 'C', 1);
211
54. 55. 56. 57. 58. 59. 60. 61. 62. 63. 64. 65. 66. 67. 68. ?>
7, 7, 7, 7,
$cliente->nombre, 1, 0, 'L', 1); $cliente->creado_at, 1, 0, 'C', 1); $cliente->telefono, 1, 0, 'R', 1); $cliente->direccion, 1, 0, 'L', 1);
El reporte posee comentarios a medida que se va generando el reporte. Para una explicacin detallada de cada mtodo consulte la documentacin de FPDF. Al finalizar nuestro reporte visualizamos en el navegador lo siguiente:
212
ejemplo
una
accin
index
en
1. <?php 2. 3. class EjemploController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. } 10. 11. ?>
Ahora vamos a crear dos tablas en MySQL: pais y ciudad con la siguiente estructura:
mysql> create table pais ( -> id integer not null auto_increment, -> nombre varchar(50), -> primary key(id) -> ); mysql> create table ciudad ( -> id integer not null auto_increment, -> pais_id integer not null, -> nombre varchar(50), -> primary key(id) -> );
213
Para que podamos interactuar con las tablas debemos crear los modelos pais y ciudad en models:
1. <?php 2. 3. class Ciudad extends ActiveRecord { 4. 5. function __construct(){ 6. $this->belongs_to("pais"); 7. } 8. 9. } 10. 11. ?> 12. <?php 13. 14. class Pais extends ActiveRecord { 15. 16. function __construct(){ 17. $this->has_many("ciudad"); 18. } 19. 20. } 21. 22. ?>
214
Ahora en la vista vamos a agregar un evento a el primer combo que ejecute una accin ajax que actualice los valores del combo correspondiente:
1. <h2>Combos Actualizables con Kumbia</h2> 2. <div> 3. <select id='pais_id'> 4. <option>Seleccione una...</option> 5. <? foreach($Pais->find() as $pais): ?> 6. <option value='<?= $pais->id ?>'><?= $pais->nombre ?></option> 7. <? endforeach; ?> 8. </select> 9. </div> 10. <div id='div_ciudad'> 11. <select id='ciudad_id'> 12. <option>Seleccione una...</option> 13. </select> 14. </div> 15. 16. <script type="text/javascript"> 17. new Event.observe("pais_id", "change", function(){ 18. new AJAX.viewRequest({ 19. action: "ejemplo/obtener_ciudades/"+$F("pais_id"), 20. container: "div_ciudad" 21. }) 22. }) 23. </script>
El evento se llama al realizar el cambio de la opcin seleccionada en pais_id, en vez de realizar un tpico onchange='...' lo hacemos con un observer que es ms profesional. El AJAX.viewRequest actualiza el contenedor div_ciudad con la vista de la accin Libro de Kumbia: Porque Programar debera ser ms fcil 215
Como vemos la consulta puede realizarse de varias formas aunque hay algunas otras ms, se puede consultar en $this->ciudades las ciudades que correspondan al pas seleccionado. En la vista views/ejemplo/obtener_ciudades.phtml volvemos a generar el combo pero con los valores de ciudad correspondientes:
1. <select id='ciudad_id'> 2. <option>Seleccione una...</option> 3. <? foreach($ciudades as $ciudad): ?> 4. <option value='<?= $ciudad->id ?>'><?= $ciudad->nombre ?></option> 5. <? endforeach; ?> 6. </select>
Con eso terminamos nuestro ejemplo el cual podemos visualizar ahora en el explorador:
216
217
El mtodo obtener_xml realiza la salida XML tal y como est comentado. Ahora veamos la vista views/ejemplo/index.phtml donde realizamos la peticin AJAX:
1. <script type="text/javascript"> 2. new Event.observe(window, "load", function(){ 3. new AJAX.xmlRequest({ 4. action: "ejemplo/obtener_xml", 5. callbacks: { 6. oncomplete: function(transport){ 7. xml = transport.responseXML 8. rows = xml.getElementsByTagName("row");
218
for(i=0;i<=rows.length-1;i++){ alert(rows[i].getAttribute("valor")) } } } })
Al final visualizamos unos mensajes de Texto con la salida que fue consultada en obtener_xml as:
219
El formulario se ve as:
220
El mtodo de aplicationController upload_file resume los detalles de subir un archivo, esta funcin esta disponible a partir de la versin 0.4.6RC4. En caso de tener una versin inferior el siguiente cdigo logra el mismo resultado:
1. <?php 2. 3. class EjemploController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. public function upload_file($name, $dir){ 10. if($_FILES[$name]){ 11. return move_uploaded_file($_FILES[$name]['tmp_name'], htmlspecialchars("$dir/{$_FILES[$name]['name']}")); 12. } else return false; 13. } 14. 15. function subir_archivo(){ 16. 17. if($this->upload_file("archivo", "public/files")){ 18. Flash::success("Se subió el archivo correctamente"); 19. } else { 20. Flash::error("No se pudo subir el archivo, revise permisos"); 21. } 22. return $this->route_to("action: index"); 23. 24. } 25. 26. } 27. 28. ?>
221
9. }) 10. </script>
Para crear un editor In-Place simplemente creamos un div o un span y le agregamos un id en nuestro caso con el id nombre. Seguido a esto creamos un nuevo Ajax.InPlaceEditor que se refiere a nombre, seguido a esto una url que enva el valor del componente despus de editarlo y unas opciones adicionales para traducir algunos textos al espaol. Nuestro formulario debera verse as al dar clic sobre el div nombre:
Como vemos un botn de OK y uno de cancelar aparecen y el texto se ha hecho editable al dar clic sobre el div. Al oprimir guardar el texto es enviado a la accin AJAX indicada con un parmetro value con el valor del componente. Para nuestro ejemplo hemos definido el mtodo guardar_nombre de esta forma:
1. <?php 2. 3. class EjemploController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. function guardar_nombre(){ 10. 11. $this->set_response(view); 12. 13. $nombre = $this->request("value"); 14. 15. $this->render_text("Se guardó $nombre");
222
} }
As al guardar aparecer el texto 'Se guard' y el nombre que fue enviado desde el formulario.
223
El texto se va a llenar con los valores que devuelva la accin ejemplo/ver_sugerencias que codificamos as:
1. <?php 2. 3. class EjemploController extends ApplicationController { 4. 5. function index(){ 6. 7. } 8. 9. function ver_sugerencias(){ 10. 11. $this->set_response("view"); 12. 13. $nombre = $this->request("nombre"); 14. 15. $this->clientes = $this->Clientes->find("nombre like '%$nombre%'"); 16. 17. } 18. 19. } 20. 21. ?>
En la vista views/ejemplo/ver_sugerencias.phtml cargamos los valores en una lista ul y cada opcin en un li. Despus de esto Autocompleter carga automticamente los valores y los transforma en cada opcin de la lista:
1. 2. 3. 4. 5. <ul> <? foreach($clientes as $cliente): ?> <li id='<?= $cliente->id ?>'><?= $cliente->nombre ?></li> <? endforeach ?> </ul>
224
225
60.14 Ordenar registros usando Listas Ordenables 60.15 Grficas estadsticas en Kumbia 60.16 Crear un sindicado RSS para nuestro Sitio 60.17 Un sitio Web 2.0 con Etiquetas 60.18 Crear una Validacin de Permisos de Usuario 60.19 Una Insercin y Validacin con AJAX 60.20 Llenando una Etiqueta SELECT 60.21 Usando Parmetros con Nombre en tus Aplicaciones 60.22 Creando tus propios Vistas Helpers
226
61 Tutorial/Curso de Kumbia
Introduccin al Tutorial
Prologo
Bienvenido a el tutorial del framework Kumbia. Este curso tutorial es un trabajo en progreso e invitamos a mejorarlo y dejar comentarios que ayuden a su mejoramiento y claridad, para que cada leccin sea clara y completa. El contenido de este curso puede cambiar regularmente por esto pueden estar pendientes de cambios, estos cambios pueden o no ser informados en el grupo, o en el sitio Web de Kumbia. Todos los conceptos, definicin, ejemplos y temas en general tratados en este tutorial deben ser probados con la ultima versin del framework (kumbia0.4.4+), esta puede ser descargada de Sourceforge.net o de los archivos del grupo en Google.
Pre-Requisitos
Recomendamos los siguientes pre-requisitos para sacar el mximo provecho al tutorial y al framework.
Programacin en PHP (Preferiblemente PHP5, Todo lo que es programacin orientada a objetos) Tener instalado el Framework en su ultima versin Tener un Motor de Base de datos soportado instalado (Preferiblemente MySQL)
Comentarios
El contenido de este Tutorial puede ser cambiado por cualquiera siempre y cuando su valor acadmico sea representativo. Comentarios pueden ser realizados en el Grupo de Google o directamente en la parte inferior en el enlace que dice Discusin.
227
Excepciones: Nos ayudan a informar errores en ejecucin en el momento indicado, y en el lugar correcto, as podemos dar solucin a un problema mejor. Visibilidad: Podemos ocultar acciones y atributos en nuestras clases, controlando el acceso a ellas y evitando problemas que sean difciles de detectar. PHP5 en php.net: http://es.php.net/manual/es/language.oop5.php Excepciones en php.net: http://es.php.net/manual/es/language.exceptions.php
Muchas otras caractersticas de PHP5 son ampliamente utilizadas a lo largo del framework.
Patrones de Diseo: http://es.wikipedia.org/wiki/Patrones_de_dise%C3%B1o MVC: http://es.wikipedia.org/wiki/MVC ActiveRecord: http://www.martinfowler.com/eaaCatalog/activeRecord.html ActiveRecord Explicando la Implementacin MVC
229
Kumbia es un framework PHP, diseado para darle al programador la facilidad para realizar desarrollos rpidos que mantengan un balance entre costo, funcionalidad y tiempo, y en resumen que nos haga felices a todos (programadores, analistas, diseadores, usuarios e inversionistas). Kumbia est en espaol, as que encontrars toda la informacin en tu idioma para usar este framework. Kumbia es un framework productivo. En unos pocos minutos trabajando con l ya habrs desarrollado gran parte de tu sistema sin haberte dado cuenta. Kumbia es fcil ante todo, en cuanto tengas el concepto del por qu de muchas cosas te dars cuenta lo productivo y fcil que fue trabajar con l, luego no querrs volver atrs. Con Kumbia puedes dedicar ms tiempo al diseo de tu aplicacin, as tendrs un mejor producto sin tener efectos secundarios ni afectar la calidad funcional de sta.
Ahora tambin puedes preocuparte por interfaces, lgica y procesos ms intuitivos y prcticos para usuarios, sin que esto sea problema para ti, ni para el tiempo de desarrollo del proyecto. Buscar en que manera podra ser ms fcil sin que aumente el trabajo considerablemente. y finalmente, Por qu Kumbia y no otro Framework?, porque: Implementa los mejores patrones de programacin orientados a la Web y adems los hace ver fciles Fomenta la utilizacin de caractersticas Web 2.0 en nuestro software Hace la mayor parte del trabajo y se ocupa de los detalles Mantener una aplicacin es ms fcil Es software libre por lo tanto obtiene todas las ventajas que este proporciona Su Documentacin esta principalmente en espaol
230
Crear una aplicacin de comercio electrnico para vender por internet albunes y dvds de todo tipo de msica Los administradores del sistema pueden mantener la informacin de albunes, canciones, gneros y artistas Debemos tener un stock de existencias por lbum Los usuarios deben registrarse y mantener su informacin personal Se debe implementar un sistema de seguridad para controlar que determinados usuarios puedan realizar slo las acciones a las que tienen permisos Generar algunos reportes de ndices de ventas para entregar a los gerentes
A simple vista, no se podra determinar cunto tiempo tardaramos desarrollando el sistema, ya que muchos requerimientos que no aparecen en la lista son en cierta forma implcitos y requieren de anlisis especial, como por ejemplo el proceso de pago o Disear el carrito de compras. La aplicacin tiene una complejidad media, pero nos va a permitir explorar muchas facetas del framework, que es lo que nos interesa realmente. En cunto tiempo daremos solucin a todo esto?
231
232
233
He resaltado en verde acciones que ya se pueden reconocer en el dibujo. Con color amarillo he resaltado a uno de los actores de nuestro sistema, el comprador. Con verde he resaltado algunas entidades que podemos reconocer tambin. Con lila estn resaltadas probables entidades en las cuales se va a trabajar ms adelante 234
He cometido alguno que otro error por el afn, como dibujar la accin cambiar estado en el dibujo de 'comprador' cuando esta accin es del 'Vendedor', esto para corregir ms adelante sobre el camino y ver cmo el framework reacciona ante esto. Tambin he definido un concepto muy general de Productos, bsicamente sabemos que tienen otra informacin asociada, pero despus lo detallaremos en el modelo de datos.
235
Como podemos ver no son muchas las entidades que vamos a trabajar, aunque hemos omitido las entidades de seguridad y muchos otros atributos que pueden ser tiles. Adicional a esto, ya tenemos detalles de la cardinalidad (relaciones) entre las entidades. El ltimo detalle para resaltar aqu es el campo precio que est duplicado tanto en productos como en Detalle de la orden, esto lo hacemos porque el precio cambiar con el tiempo y queremos mantener el valor de ste en la orden en el momento en que se realiz. Ya podemos aventurarnos a mostrar a nuestro cliente el adelanto del proyecto con el poco pero sustancioso dominio del sistema. Libro de Kumbia: Porque Programar debera ser ms fcil 236
238
Una vez en este archivo vamos a prestar atencin a la variable mode, en [project], actualmente dice production, esto significa que estamos trabajando actualmente con los parmetros de conexin [production]. Los nombres de los apartados no tienen ninguna relevancia para Kumbia, sin embargo para nosotros es claro que ya podemos hacer conexiones a bases de datos diferentes de acuerdo al modo que queramos trabajar y de pronto que no vayamos a hacer pruebas sobre una base de datos que tenemos destinada a produccin. Los parmetros en cada apartado son perfectamente claros, sin embargo puede consultar Explicando la Configuracin, para profundizar en estos archivos .ini. Ahora vamos a cambiar la variable mode a development y vamos a cambiar el respectivo apartado de parmetros, con esto nos hacemos a la idea que estamos en modo de desarrollo.
239
; Kumbia Web Framework Configuration ; Parmetros Generales del Proyecto [project] mode = development name = "KUMBIA PROJECT" interactive = Off ; Parmetros de base de datos ; Utiliza el nombre del controlador nativo (mysql, postgresql, oracle) [production] database.host = localhost database.username = root database.password = database.name = test database.type = mysql [development] database.host = localhost database.username = andres database.password = rocks database.name = tienda database.type = mysql
Cmo diferenciar una base de datos que vayamos a usar para desarrollo de una que tengamos para produccin?, pues simplemente por su nombre, ahora nos limitamos a usar tienda para ambos modos, pero podramos crear una como desarrollo_tienda o tienda_prueba, y as.
El campo id, es una convencin, esto significa que Kumbia espera que las tablas que creemos tengan este campo como llave primaria y como un auto-numrico. Acostumbrados a usar llaves primarias como el campo nico representativo en una 240
entidad, ahora usaremos id y podremos hacer una validacin de nicos en esos campos que deben ser nicos. He omitido por ahora los campos relacin a generos, artistas y disqueras, para enfocarnos en este ejemplo ms sencillo y luego ver como se tratan las relaciones a otras tablas.
Antes que todo debemos notar que el nombre del archivo es el mismo de la tabla y que el nombre de la clase que definimos en este archivo es tambin el nombre de la tabla. Segn esta definicin podemos pensar que una clase Productos representa la tabla productos en Kumbia, y pues estamos en lo cierto porque es as. Un modelo en Kumbia representa alguna tabla en la base de datos y encapsula los campos de la tabla como atributos de la clase, adems implementa las acciones como insertar, consultar, modificar y borrar como parte de la clase para lograr una forma ms natural de trabajar sobre entidades de nuestra base de datos. Ms adelante aplicaremos estos mtodos encapsulados para realizar acciones sobre las tablas que estamos trabajando. Por ltimo, debemos notar que la clase Productos hereda de la clase ActiveRecord que es la que contiene toda la lgica que da el funcionamiento a los modelos. Al instanciar Productos, Kumbia automticamente va a traer los meta-datos, es decir que los nombres de campos, tipos de datos, tamaos, llaves primarias, llaves forneas y dems datos descriptivos del modelo y luego sin darnos en cuenta podremos trabajar esta clase como si la hubiramos definido as:
1. <?php 2. 3. class Productos extends ActiveRecord { 4. 5. public $id; 6. public $nombre; 7. public $precio; 8. public $cantidad;
241
Un modelo es todo lo que necesita Kumbia para realizar las operaciones sobre la base de datos y conocer la estructura de alguna tabla o entidad que de ahora en adelante llamaremos modelo.
Bueno y ahora que hacemos?, que hace esto?, pues veamos que hace y que la imagen hable por si sola:
242
243
70 Glosario de Conceptos
70.1 AJAX
En las aplicaciones Web tradicionales los usuarios interactan mediante formularios, que al enviarse, realizan una peticin al servidor Web. El servidor se comporta segn lo enviado en el formulario y contesta enviando una nueva pgina Web. Se desperdicia mucho ancho de banda, ya que gran parte del HTML enviado en la segunda pgina Web, ya estaba presente en la primera. Adems, de esta manera no es posible crear aplicaciones con un grado de interaccin similar al de las aplicaciones habituales. En aplicaciones AJAX se pueden enviar peticiones al servidor Web para obtener yo nicamente la informacin necesaria, empleando SOAP o algn otro lenguaje para servicios Web basado en XML, y usando JavaScript en el cliente para procesar la respuesta del servidor Web. Esto redunda en una mayor interaccin gracias a la reduccin de informacin intercambiada entre servidor y cliente ya que parte del proceso de la informacin lo hace el propio cliente, liberando al servidor de ese trabajo. La contrapartida es que la descarga inicial de la pgina es ms lenta al tenerse que bajar todo el cdigo JavaScript.
244
la capa de presentacin est partida en controlador y vista. La principal separacin es entre presentacin y dominio; la separacin entre VC es menos clara. Aunque se pueden encontrar diferentes implementaciones de MVC, el flujo que sigue el control generalmente es el siguiente: 1. El usuario interacta con la interfaz de usuario de alguna forma (por ejemplo, el usuario pulsa un botn, enlace) 2. El controlador recibe (por parte de los objetos de la interfaz-vista) la notificacin de la accin solicitada por el usuario. El controlador gestiona el evento que llega, frecuentemente a travs de un gestor de eventos (handler) o callback. 3. El controlador accede al modelo, actualizndolo, posiblemente modificndolo de forma adecuada a la accin solicitada por el usuario (por ejemplo, el controlador actualiza el carro de la compra del usuario). Los controladores complejos estn a menudo estructurados usando un patrn de comando que encapsula las acciones y simplifica su extensin. 4. El controlador delega a los objetos de la vista la tarea de desplegar la interfaz de usuario. La vista obtiene sus datos del modelo para generar la interfaz apropiada para el usuario donde se refleja los cambios en el modelo (por ejemplo, produce un listado del contenido del carro de la compra). El modelo no debe tener conocimiento directo sobre la vista. Sin embargo, el patrn de observador puede ser utilizado para proveer cierta indireccin entre el modelo y la vista, permitiendo al modelo notificar a los interesados de cualquier cambio. Un objeto vista puede registrarse con el modelo y esperar a los cambios, pero aun as el modelo en s mismo sigue sin saber nada de la vista. El controlador no pasa objetos de dominio (el modelo) a la vista aunque puede dar la orden a la vista para que se actualice. Nota: En algunas implementaciones la vista no tiene acceso directo al modelo, dejando que el controlador enve los datos del modelo a la vista. 5. La interfaz de usuario espera nuevas interacciones del usuario, comenzando el ciclo nuevamente.
70.3 Framework
En el desarrollo de software, un framework es una estructura de soporte definida en la cual otro proyecto de software puede ser organizado y desarrollado. Tpicamente, un framework puede incluir soporte de programas, libreras y un lenguaje de scripting entre otros software para ayudar a desarrollar y unir los diferentes componentes de un proyecto. Un framework representa una arquitectura de software que modela las relaciones generales de las entidades del dominio. Provee una estructura y una metodologa de trabajo la cual extiende o utiliza las aplicaciones del dominio.
245
70.4 ActiveRecord
Es un patrn de software utilizado en aplicaciones robustas, que permite trabajar los registros de una tabla en una base de datos como instancias de una clase, por ejemplo Clientes Productos en los cuales podemos aplicar mtodos Buscar, Guardar y Borrar sin necesidad de utilizar sentencias SQL.
70.8 PHP
El fcil uso y la similaridad con los lenguajes ms comunes de programacin estructurada, como C y Perl, permiten a la mayora de los programadores experimentados crear aplicaciones complejas con una curva de aprendizaje muy suave. Tambin les permite involucrarse con aplicaciones de contenido dinmico sin tener que aprender todo un nuevo grupo de funciones y prcticas. La principal ventaja se basa en ser un lenguaje multiplataforma. Capacidad de conexin con la mayora de los manejadores de base de datos que se utilizan en la actualidad. Leer y manipular datos desde diversas fuentes, incluyendo datos que pueden ingresar los usuarios desde formularios HTML Capacidad de expandir su potencial utilizando la enorme cantidad de mdulos (llamados ext's o extensiones). Posee una muy buena documentacin en su pgina oficial. Es Libre, por lo que se presenta como una alternativa de fcil acceso para todos. Permite las tcnicas de Programacin Orientada a Objetos.
246
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things. To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights. We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software. Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations. Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with
247
modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you". Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does. 1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. 2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions: a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change. b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License. c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.) These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it. Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program. In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License. 3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
248
a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or, c) Accompany it with the information you received as to the offer to distribute corresponding source code.(This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.) The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable. If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code. 4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance. 5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it. 6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. 7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program. If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
249
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice. This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License. 8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License. 9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation. 10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally. NO WARRANTY 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS
250
Ejemplo de link_to_remote usando callbacks AJAX Ejemplo de form_to_remote usando callbacks AJAX Agregada seccin de Cambios de Este Libro Captulo de Coders Captulo de Prototype Windows Captulo de Porque Kumbia usa PHP5? Se cambio tipo de papel de A4 a Letter Mejoras en el captulo de Explicando la Implementacin MVC Mejoras en el captulo de Vistas Cambios en las imgenes por unas ms modernas Recetas en Kumbia ahora es Pasos de Baile en Kumbia Ms Pasos de Baile y ejemplos Mejoras en muchos aspectos de la documentacin
Revisin de la numeracin
251
252