1 <?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
2 -------------------------------------------------------------------------------
5 -------------------------------------------------------------------------------
6 This file is part of meconlib.
8 meconlib is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2 of the License, or (at your option)
13 meconlib is distributed in the hope that it will be useful, but WITHOUT
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15 FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License; if not,
18 write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
19 Boston, MA 02111-1307 USA
20 -------------------------------------------------------------------------------
21 Creado: fri mar 21 ART 2003
22 Autor: Martin Marrese <mmarre@mecon.gov.ar>
23 -------------------------------------------------------------------------------
25 -----------------------------------------------------------------------------*/
27 require_once 'DB.php';
28 require_once 'MECON/DB/Pager.php';
29 require_once 'MECON/HTML/Error.php';
30 require_once 'MECON/HTML/Link.php';
31 require_once 'MECON/HTML/Tabla.php';
34 * Libreria para le manejo de las tablas de los sistemas de intranet.
37 class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
40 * Descripción de los elementos listados.
41 * Se utiliza en mensajes del paginador y otros mensajes.
43 var $_desc = 'resultados';
46 * Datos a agregar delante de cada fila que se agregue desde una base de datos.
47 * Cada elemento del array es a su vez un array cuyo primer elemento es el
48 * formato del texto a agregar (tipo printf()) y el segundo es un array con los
49 * campos de la DB a utilizar para ese formato en una fila dada.
51 var $_prependRowsData = array();
54 * Datos a agregar al final de cada fila que se agregue desde una base de datos.
55 * El formato es el mismo que el de _prependRowsData.
57 var $_appendRowsData = array();
60 * Prefijo a usar para las variables GET que genera la tabla.
62 var $_getVarPrefix = '_';
66 * Puede recibir como parametro un string con los atributos que se
67 * quieren dar a la tabla en cuestion. Estos atributos estan
68 * seteados por default segun el archivo de configuracion.
69 * Ademas puede recibir la indicacion de algun estilo en particular.
71 * @param string $desc Descripción de los elementos listados.
72 * @param mixed $attrs Atributos diferentes a los estandares para la tabla
73 * @param string $estilo Tipo de tabla
77 function MECON_HTML_TablaDB($desc = null, $attrs = null, $estilo = 'comun') {
81 parent::MECON_HTML_Tabla($attrs, $estilo);
85 * Establece el prefijo usado para las variables de GET que genera la tabla.
87 function setGetVarPrefix($prefix) {
88 $this->_getVarPrefix = $prefix;
92 * Obtiene el prefijo usado para las variables de GET que genera la tabla.
94 function getGetVarPrefix() {
95 return $this->_getVarPrefix;
99 * Agrega un páginador a la tabla, basado en un resultado de una base de datos.
102 * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
103 * $result = $db->query('SELECT nombre, apellido FROM tabla');
104 * if (DB::isError($result)) {
107 * // Agrega el paginador por defecto y lo guarda para mostrar solo los
108 * // resultados paginados después.
109 * $pager = $tabla->addPager($result);
110 * // Agrega cabecera con los nombres de las columnas.
111 * $tabla->addRow(array('Nombre', 'Apellido'), 'cabecera');
112 * // Agrega los resultados paginados de la DB.
113 * $tabla->addRows($pager, array('nombre', 'apellido'));
117 * @param DB_Result $result Resultado de una consulta de base de datos.
118 * @param mixed $tipo Tipo de link(s) a agregar. Puede ser:
120 * <li><tt>'anterior'</tt></li>
121 * <li><tt>'siguiente'</tt></li>
122 * <li><tt>'paginas'</tt></li>
123 * <li><tt>'total'</tt></li>
124 * <li><tt>'info'</tt></li>
126 * Puede pasarse uno solo como un string o varios como un
127 * array. Si se pasa <tt>'todo'</tt>, se incluyen todos.
128 * Si se pasa null, se incluyen <tt>'anterior'</tt>,
129 * <tt>'siguiente'</tt> y <tt>'paginas'</tt>.
130 * @param mixed $link Dirección a la que apuntan los links generados. Puede
131 * ser un MECON_HTML_Link (para poder pasar variables por
133 * @param int $limit Parámetro usado para crear el MECON_DB_Pager.
134 * @param int $maxpages Parámetro usado para crear el MECON_DB_Pager.
135 * @param string $getvar Nombre de la variable GET a usar para indicar el número
136 * de página actual (se le pone el \ref setGetPrefix prefijo)
138 * @return MECON_DB_Pager Pager que se puede usar para realizar los fetch de
139 * los resultados de la página actual.
141 * @see MECON_DB_Pager, addRows().
143 function addPager($result, $tipo = null, $link = null, $limit = 10, $maxpages = 21, $getvar = 'from') {
144 // Creo el pager con el resultado.
145 $pager = new MECON_DB_Pager($result, @$_GET[$this->_getVarPrefix.$getvar], $limit, $maxpages);
146 // Obtengo un link válido.
148 $link = @$_SERVER['PHP_SELF'];
150 if (is_string($link)) {
151 $link = new MECON_HTML_Link($link, '');
153 // Si es el tipo por defecto pone paginador nada más.
155 $tipo = array('anterior', 'paginas', 'siguiente');
157 // Convierte tipo a array.
158 if (!is_array($tipo)) {
159 $tipo = array($tipo);
161 // Si se quiere mostrar todas las decoraciones del paginador.
162 if (in_array('todo', $tipo)) {
163 $tipo = array('anterior', 'paginas', 'siguiente', 'total', 'info');
165 // Me fijo si tiene cada uno de los elementos y los agrego.
166 if (in_array('anterior', $tipo) and $pager->numRows() and $pager->currentpage != 1) {
167 $link->setGetVar($this->_getVarPrefix.$getvar, $pager->prev);
168 $this->addLink('anterior', $link);
170 if (in_array('siguiente', $tipo) and $pager->numRows() and $pager->currentpage != $pager->numpages) {
171 $link->setGetVar($this->_getVarPrefix.$getvar, $pager->next);
172 $this->addLink('siguiente', $link);
174 if (in_array('paginas', $tipo) and $pager->numRows() and $pager->numpages > 1) {
175 $from = @$_GET[$this->_getVarPrefix.$getvar];
177 $lnk = $link->getContents();
178 foreach ($pager->pages as $page => $start_row) {
179 if ($start_row == $from) {
182 $link->setGetVar($this->_getVarPrefix.$getvar, $start_row);
183 $link->setContents($page);
184 $pags .= $link->toHtml();
186 if ($page != $pager->lastpage) {
190 $link->setContents($lnk);
191 $this->updatePie($pags, 'centro');
193 if (in_array('total', $tipo) and $pager->numRows()) {
194 $this->updateCabecera("Se encontraron {$pager->numrows} {$this->_desc}.", 'izquierda');
196 if (in_array('info', $tipo) and $pager->numRows()) {
197 $this->updateCabecera("'Página {$pager->currentpage} de {$pager->numpages} - "
198 . "{$pager->limit} {$this->_desc} por página.", 'derecha');
204 * Agrega filas desde el resultado de una consulta a una base de datos.
205 * Si no hay resultados, muestra un mensaje. Dependiendo de si es se pasa
206 * un objeto a usar o no, llama a addRowsObject() o addRowsResult()
209 * @param DB_Result $result Resultados de una consulta.
210 * @param array $campos Propiedades del objeto a mostrar.
211 * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
212 * string con el nombre de la clase.
214 * @see addRowsData(), addRowsIcon(), ejemplo en addPager().
216 function addRows($result, $campos, $obj = null) {
217 if ($result->numRows()) {
219 $this->addRowsObject($result, $campos, $obj);
221 $this->addRowsResult($result, $campos, $obj);
224 $id = $this->addRow(array(new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
225 $this->updateCellAttributes($id, 0, array('colspan' => count($campos)));
230 * Agrega filas usando un resultado.
232 * @param DB_Result $result Resultados de una consulta.
233 * @param array $campos Campos de la base de datos a mostrar.
235 function addRowsResult($result, $campos) {
236 while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC)) {
238 foreach ($this->_prependRowsData as $data) {
239 $columnas[] = $this->_buildCustomColumn($data, $row);
241 foreach ($campos as $campo) {
242 $columnas[] = $row[$campo];
244 foreach ($this->_appendRowsData as $data) {
245 $columnas[] = $this->_buildCustomColumn($data, $row);
247 $this->addRow($columnas);
252 * Agrega filas usando un objeto.
253 * El objeto debe tener un método llamado cargar que acepte como primer (y
254 * único obligatorio) parámetro un DB_Result para cargar sus datos desde una
257 * @param DB_Result $result Resultados de una consulta.
258 * @param array $campos Propiedades del objeto a mostrar.
259 * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
260 * string con el nombre de la clase.
262 * @see La interfaz MECON_DBO que tiene el método MECON_DBO::cargar().
264 function addRowsObject($result, $campos, $obj) {
265 if (is_string($obj)) {
268 if (!method_exists($obj, 'cargar')) {
269 $this->raiseError('La clase ' . get_class($obj) . ' no tiene un metodo cargar().');
271 while ($obj->cargar($result)) {
272 foreach ($this->_prependRowsData as $data) {
273 $columnas[] = $this->_buildCustomColumn($data, $row);
275 foreach ($campos as $campo) {
276 $columnas[] = $obj->$campo;
278 foreach ($this->_appendRowsData as $data) {
279 $columnas[] = $this->_buildCustomColumn($data, $row);
281 $this->addRow($columnas);
286 * Agrega una columna arbitraria a la tabla basado en valores de una fila.
289 * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
290 * $result = $db->query('SELECT nombre, apellido, activo FROM tabla');
291 * if (DB::isError($result)) {
295 * array('Col1', 'Nombre', 'Apellido', 'Activo', 'PopUp1', 'PopUp2'),
297 * // Agrega una columna con una leyenda 'El nombre es: {nombre}' al principio.
298 * $tabla->addRowsData('Me llamo %s.', 'nombre', 'prepend');
299 * // Agrega una columna al final con checkbox para seleccionar filas. El
300 * // segundo elemento será procesado por la callback checked_callback().
301 * $tabla->addRowsData('<input type="checkbox" name="datos[%s]" value="1" %s />',
302 * array('nombre', array('activo', 'checked_callback')));
303 * // Agrega el nombre con un link a un popup (sin javascript).
304 * $tabla->addRowsData(
305 * new MECON_HTML_Link('popup.php', '%s', array('nombre' => null),
306 * array('target' => '_blank')),
309 * // Agrega el nombre con un link a un popup (con javascript).
310 * $tabla->addRowsData('<a href="popup.php?nombre=%s" '
311 * . 'onclick="'."javascript:window.open('popup.php?nombre=%s',"
312 * . "'win_id','width=400,height=400,scrollbars=no');"
313 * . 'return false;">%s</a>',
314 * array('nombre', 'nombre', 'apellido'));
315 * // Agrega resultados de la tabla.
316 * $tabla->addRows($result, array('nombre', 'apellido'));
319 * // Funcion callback para darle formato al campo 'activo'.
320 * // En este caso devuelve 'checked' para indicar que el checkbox está
321 * // activado si activo es true.
322 * function checked_callback($activo) {
323 * return $activo ? 'checked' : '';
327 * @param mixed $format Si es un string, especifica el formato a usar al
328 * estilo de sprintf. Si es un MECON_HTML_Link, se
329 * traduce cada variable por GET que empiece con el
330 * \ref getGetVarPrefix "prefijo" y cuyo valor sea null
331 * al campo correspondiente de la DB:
332 * @code $tabla->addRowsData(new MECON_HTML_Link('abm.php', 'Ver %s',
333 * array($tabla->getGetVarPrefix().'id' => null), 'nombre'); @endcode
334 * Si el valor en vez de ser null es un string, se
335 * fija si existe una función con ese nombre para llamar
336 * con el campo de la DB como argumento para
338 * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Mostrar',
339 * array($tabla->getGetVarPrefix().'campo1' => 'callback_campo1'));
340 * function callback_campo1($campo1) {
341 * return 'El campo1 es '.strtoupper($campo3);
343 * Si no existe la función, se toma el string como
344 * formato para sprintf para darle formato:
345 * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Ver',
346 * array($tabla->getGetVarPrefix().'campo1' => 'campo1: %s')); @endcode
347 * @param mixed $campos Campos de la DB a usar como argumentos del sprintf.
348 * Puede ser un string para pasar un solo campo sin
350 * @code $tabla->addRowsData('%s', 'campo1'); @endcode
351 * Si es un array, cada elemento es un campo
352 * que puede ser un string representando el nombre de
354 * @code $tabla->addRowsData('%s',
355 * array('campo1', 'campo2'); @endcode
356 * o un array cuyo primer elemento es el nombre del
357 * campo a usar y el segundo argumento es una funcion
358 * callback a llamar con el valor del campo como
359 * argumento para darle formato:
360 * @code $tabla->addRowsData('%s',
361 * array('campo1', 'campo2', array('campo3', 'callback_campo3'))));
362 * function callback_campo3($campo3) {
363 * return strtoupper($campo3);
365 * Si no se encuentra la funcion callback, se toma como
366 * un string para formatear el campo con sprintf():
367 * @code $tabla->addRowsData('%s', array('campo1',
368 * array('campo2', 'campo2 = %s')); @endcode
369 * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
370 * <tt>'prepend'</tt> o <tt>'append'</tt>:
371 * @code $tabla->addRowsData('Hola %s!', 'nombre',
372 * 'prepend'); @endcode
374 * @warning Este método debe ser llamado antes de llamar a addRows().
375 * @note Las funciones callback toman todas un solo argumento (el valor del
376 * campo a formatear) y deben devolver un string con el campo
379 function addRowsData($format, $campos = array(), $lugar = 'append') {
380 if (!is_array($campos)) {
381 $campos = array($campos);
383 switch (strtolower($lugar)) {
385 $this->_prependRowsData[] = array($format, $campos);
388 $this->_appendRowsData[] = array($format, $campos);
391 $this->raiseError('Lugar incorrecto. Lugares soportados: append, prepend.');
396 * Contruye una columna personalizada.
398 * @param array $data Datos sobre la columna, en el formato especificado
399 * para un elemento del array usado en _prependRowsData.
400 * @param mixed $row Fila de un resultado de una base de dotos. Puede ser un
401 * array asociativo o un objeto (en cuyo caso cada campo
402 * debe ser un atributo del mismo).
404 * @return mixed Columna formateada para agregar a la tabla.
408 function _buildCustomColumn($data, $row) {
409 list($format, $campos) = $data;
410 // Si tiene formatos y argumentos.
412 // Si el formato es un MECON_HTML_Link, uso como formato a
414 if (is_a($format, 'mecon_html_link')) {
415 $args = array($format->getContents());
417 $args = array($format);
419 // Proceso cada agumento.
420 foreach ($campos as $campo) {
421 // Si el agumento es un array, usa una callback para
423 if (is_array($campo)) {
424 list($campo, $callback) = $campo;
426 if (is_array($row)) {
427 $campo = $row[$campo]; // Es un campo de un array.
429 $campo = $row->$campo; // Es un atributo de un objeto.
431 // Si usa callback, cambio el campo por el resultado del
432 // llamado a su callback.
433 if (isset($callback) and function_exists($callback)) {
434 $campo = $callback($campo);
436 // Agrego argumento procesado a la lista de argumentos.
439 // Si es un link, le seteo los contenidos procesados.
440 if (is_a($format, 'mecon_html_link')) {
441 $format->setContents(call_user_func_array('sprintf', $args));
442 // Si no formateo la cadena con los argumentos procesados.
444 $format = call_user_func_array('sprintf', $args);
447 // Si es un link, traduce las variables GET.
448 if (is_a($format, 'mecon_html_link')) {
449 $format = $this->_translateGetVars($format, $row);
451 // devuelve la columna.
456 * Traduce las variables GET de un link.
457 * Puede formatearlas con printf() o llamando una callback.
459 * @param MECON_HTML_Link $link Link con las variables GET a formatear.
460 * @param mixed $row Fila de un resultado de una base de dotos. Puede ser un
461 * array asociativo o un objeto (en cuyo caso cada campo
462 * debe ser un atributo del mismo).
464 * @return MECON_HTML_Link Link con las variables GET traducidas.
468 function _translateGetVars($link, $row) {
469 $vars = $link->getGetVars();
470 foreach ($vars as $var => $val) {
471 if (preg_match("/^{$this->_getVarPrefix}(.+)$/", $var, $m)) {
473 $campo = is_array($row) ? $row[$campo] : $row->$campo;
474 // Si no tiene valor, se lo reemplaza por el
477 $link->setGetVar($var, $campo);
478 // Si existe una funcion, se la usa para obtener
480 } elseif (function_exists($val)) {
481 $link->setGetVar($var, $val($campo));
482 // Si no es ni null ni link, lo toma como
483 // formato para el sprintf
485 $link->setGetVar($var, sprintf($val, $campo));
493 * Agrega un ícono predefinido a la tabla.
496 * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
497 * $result = $db->query('SELECT nombre, apellido FROM tabla');
498 * if (DB::isError($result)) {
501 * $tabla->addRow(array('Col1', 'Nombre', 'Apellido', 'Modificar', 'Borrar',
502 * 'Agregar'), 'cabecera');
503 * // Agrega ícono de modificar que apunta a modificar.php y pasa el 'id'.
504 * $tabla->addRowsIcon('modificar', 'id', 'modificar.php');
505 * // Agrega ícono de borrar desactivado.
506 * $tabla->addRowsIcon('no_borrar');
507 * // Agrega ícono con una flecha que apunta a agregar.php y no pasa nada.
508 * $tabla->addRowsIcon('ir', null, 'modificar.php');
509 * // Agrega resultados de la tabla.
510 * $tabla->addRows($result, array('nombre', 'apellido'));
514 * @param string $id Identificador del tipo de ícono a agregar. Puede ser:
516 * <li><tt>'modificar'</tt>: Ícono de modificar.</li>
517 * <li><tt>'no_modificar'</tt>: Ícono de modificar desactivado.</li>
518 * <li><tt>'borrar'</tt>: Ícono de borrar.</li>
519 * <li><tt>'no_borrar'</tt>: Ícono de borrar desactivado.</li>
520 * <li><tt>'ir'</tt>: Flecha hacia la derecha.</li>
522 * @param mixed $campos Campos de la DB a usar para generar el link. Estos
523 * campos serán pasados por GET a la página destino.
524 * Cada campo es pasado como la variable GET compuesta
525 * por el @ref getGetVarPrefix "prefijo" más el nombre
526 * del campo (ver parámetro $campos de addRowsData()
527 * para conocer de que formas se puede formatear un
529 * @param mixed $link Si es un string, se usa como URL del link a generar.
530 * Si es un MECON_HTML_Link, se usa como base para el
531 * link a generar y se le va agregando las variables de
532 * GET generadas por el parámetro $campos (el link es
533 * procesado de la misma forma en que es procesado el
534 * parámetro $formato en addRowsData() con la excepción
535 * de que el contenido del Link no es tomado en cuenta).
536 * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
537 * <tt>'prepend'</tt> o <tt>'append'</tt>.
539 * @warning Este método debe ser llamado antes de llamar a addRows().
540 * @note Las funciones callback toman todas un solo argumento (el valor del
541 * campo a formatear) y deben devolver un string con el campo
544 function addRowsIcon($id, $campos = array(), $link = null, $lugar = 'append') {
548 if (is_string($campos)) {
549 $campos = array($campos);
552 $link = @$_SERVER['PHP_SELF'];
554 if (is_string($link)) {
555 $link = new MECON_HTML_Link($link, '');
559 $img = new MECON_HTML_Image('/MECON/images/general_modificar', '(M)');
560 $img->updateAttributes(array('title' => 'Modificar'));
561 $link->addContents($img);
562 foreach ($campos as $campo) {
564 if (is_array($campo)) {
565 list($campo, $format) = $campo;
567 $link->setGetVar($this->_getVarPrefix.$campo, $format);
569 $this->addRowsData($link, array(), $lugar);
572 $img = new MECON_HTML_Image('/MECON/images/general_modificar_des', '(-)');
573 $img->updateAttributes(array('title' => 'Modificar'));
574 $this->addRowsData($img, array(), $lugar);
577 $img = new MECON_HTML_Image('/MECON/images/general_eliminar', '(B)');
578 $img->updateAttributes(array('title' => 'Borrar'));
579 $link->addContents($img);
580 foreach ($campos as $campo) {
581 $link->setGetVar($this->_getVarPrefix.$campo, null);
583 $this->addRowsData($link, array(), $lugar);
586 $img = new MECON_HTML_Image('/MECON/images/general_eliminar_des', '(-)');
587 $img->updateAttributes(array('title' => 'Borrar'));
588 $this->addRowsData($img, array(), $lugar);
591 $img = new MECON_HTML_Image('/MECON/images/general_ir4', '->');
592 $img->updateAttributes(array('title' => 'Ir'));
593 $link->addContents($img);
594 foreach ($campos as $campo) {
595 $link->setGetVar($this->_getVarPrefix.$campo, null);
597 $this->addRowsData($link, array(), $lugar);
600 $this->raiseError("No hay un ícono predefinido llamado '$id'.");