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(
225 new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
226 $this->updateCellAttributes($id, 0,
227 array('colspan' => count($campos)
228 + count($this->_prependRowsData)
229 + count($this->_appendRowsData)));
234 * Agrega filas usando un resultado.
236 * @param DB_Result $result Resultados de una consulta.
237 * @param array $campos Campos de la base de datos a mostrar.
239 function addRowsResult($result, $campos) {
240 while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC)) {
242 foreach ($this->_prependRowsData as $data) {
243 $columnas[] = $this->_buildCustomColumn($data, $row);
245 foreach ($campos as $campo) {
246 $columnas[] = $row[$campo];
248 foreach ($this->_appendRowsData as $data) {
249 $columnas[] = $this->_buildCustomColumn($data, $row);
251 $this->addRow($columnas);
256 * Agrega filas usando un objeto.
257 * El objeto debe tener un método llamado cargar que acepte como primer (y
258 * único obligatorio) parámetro un DB_Result para cargar sus datos desde una
261 * @param DB_Result $result Resultados de una consulta.
262 * @param array $campos Propiedades del objeto a mostrar.
263 * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
264 * string con el nombre de la clase.
266 * @see La interfaz MECON_DBO que tiene el método MECON_DBO::cargar().
268 function addRowsObject($result, $campos, $obj) {
269 if (is_string($obj)) {
272 if (!method_exists($obj, 'cargar')) {
273 $this->raiseError('La clase ' . get_class($obj) . ' no tiene un metodo cargar().');
275 while ($obj->cargar($result)) {
276 foreach ($this->_prependRowsData as $data) {
277 $columnas[] = $this->_buildCustomColumn($data, $row);
279 foreach ($campos as $campo) {
280 $columnas[] = $obj->$campo;
282 foreach ($this->_appendRowsData as $data) {
283 $columnas[] = $this->_buildCustomColumn($data, $row);
285 $this->addRow($columnas);
290 * Agrega una columna arbitraria a la tabla basado en valores de una fila.
293 * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
294 * $result = $db->query('SELECT nombre, apellido, activo FROM tabla');
295 * if (DB::isError($result)) {
299 * array('Col1', 'Nombre', 'Apellido', 'Activo', 'PopUp1', 'PopUp2'),
301 * // Agrega una columna con una leyenda 'El nombre es: {nombre}' al principio.
302 * $tabla->addRowsData('Me llamo %s.', 'nombre', 'prepend');
303 * // Agrega una columna al final con checkbox para seleccionar filas. El
304 * // segundo elemento será procesado por la callback checked_callback().
305 * $tabla->addRowsData('<input type="checkbox" name="datos[%s]" value="1" %s />',
306 * array('nombre', array('activo', 'checked_callback')));
307 * // Agrega el nombre con un link a un popup (sin javascript).
308 * $tabla->addRowsData(
309 * new MECON_HTML_Link('popup.php', '%s', array('nombre' => null),
310 * array('target' => '_blank')),
313 * // Agrega el nombre con un link a un popup (con javascript).
314 * $tabla->addRowsData('<a href="popup.php?nombre=%s" '
315 * . 'onclick="'."javascript:window.open('popup.php?nombre=%s',"
316 * . "'win_id','width=400,height=400,scrollbars=no');"
317 * . 'return false;">%s</a>',
318 * array('nombre', 'nombre', 'apellido'));
319 * // Agrega resultados de la tabla.
320 * $tabla->addRows($result, array('nombre', 'apellido'));
323 * // Funcion callback para darle formato al campo 'activo'.
324 * // En este caso devuelve 'checked' para indicar que el checkbox está
325 * // activado si activo es true.
326 * function checked_callback($activo) {
327 * return $activo ? 'checked' : '';
331 * @param mixed $format Si es un string, especifica el formato a usar al
332 * estilo de sprintf. Si es un MECON_HTML_Link, se
333 * traduce cada variable por GET que empiece con el
334 * \ref getGetVarPrefix "prefijo" y cuyo valor sea null
335 * al campo correspondiente de la DB:
336 * @code $tabla->addRowsData(new MECON_HTML_Link('abm.php', 'Ver %s',
337 * array($tabla->getGetVarPrefix().'id' => null), 'nombre'); @endcode
338 * Si el valor en vez de ser null es un string, se
339 * fija si existe una función con ese nombre para llamar
340 * con el campo de la DB como argumento para
342 * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Mostrar',
343 * array($tabla->getGetVarPrefix().'campo1' => 'callback_campo1'));
344 * function callback_campo1($campo1) {
345 * return 'El campo1 es '.strtoupper($campo3);
347 * Si no existe la función, se toma el string como
348 * formato para sprintf para darle formato:
349 * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Ver',
350 * array($tabla->getGetVarPrefix().'campo1' => 'campo1: %s')); @endcode
351 * @param mixed $campos Campos de la DB a usar como argumentos del sprintf.
352 * Puede ser un string para pasar un solo campo sin
354 * @code $tabla->addRowsData('%s', 'campo1'); @endcode
355 * Si es un array, cada elemento es un campo
356 * que puede ser un string representando el nombre de
358 * @code $tabla->addRowsData('%s',
359 * array('campo1', 'campo2'); @endcode
360 * o un array cuyo primer elemento es el nombre del
361 * campo a usar y el segundo argumento es una funcion
362 * callback a llamar con el valor del campo como
363 * argumento para darle formato:
364 * @code $tabla->addRowsData('%s',
365 * array('campo1', 'campo2', array('campo3', 'callback_campo3'))));
366 * function callback_campo3($campo3) {
367 * return strtoupper($campo3);
369 * Si no se encuentra la funcion callback, se toma como
370 * un string para formatear el campo con sprintf():
371 * @code $tabla->addRowsData('%s', array('campo1',
372 * array('campo2', 'campo2 = %s')); @endcode
373 * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
374 * <tt>'prepend'</tt> o <tt>'append'</tt>:
375 * @code $tabla->addRowsData('Hola %s!', 'nombre',
376 * 'prepend'); @endcode
378 * @warning Este método debe ser llamado antes de llamar a addRows().
379 * @note Las funciones callback toman todas un solo argumento (el valor del
380 * campo a formatear) y deben devolver un string con el campo
383 function addRowsData($format, $campos = array(), $lugar = 'append') {
384 if (!is_array($campos)) {
385 $campos = array($campos);
387 switch (strtolower($lugar)) {
389 $this->_prependRowsData[] = array($format, $campos);
392 $this->_appendRowsData[] = array($format, $campos);
395 $this->raiseError('Lugar incorrecto. Lugares soportados: append, prepend.');
400 * Contruye una columna personalizada.
402 * @param array $data Datos sobre la columna, en el formato especificado
403 * para un elemento del array usado en _prependRowsData.
404 * @param mixed $row Fila de un resultado de una base de dotos. Puede ser un
405 * array asociativo o un objeto (en cuyo caso cada campo
406 * debe ser un atributo del mismo).
408 * @return mixed Columna formateada para agregar a la tabla.
412 function _buildCustomColumn($data, $row) {
413 list($format, $campos) = $data;
414 // Si tiene formatos y argumentos.
416 // Si el formato es un MECON_HTML_Link, uso como formato a
418 if (is_a($format, 'mecon_html_link')) {
419 $args = array($format->getContents());
421 $args = array($format);
423 // Proceso cada agumento.
424 foreach ($campos as $campo) {
425 // Si el agumento es un array, usa una callback para
427 if (is_array($campo)) {
428 list($campo, $callback) = $campo;
430 if (is_array($row)) {
431 $campo = $row[$campo]; // Es un campo de un array.
433 $campo = $row->$campo; // Es un atributo de un objeto.
435 // Si usa callback, cambio el campo por el resultado del
436 // llamado a su callback.
437 if (isset($callback) and function_exists($callback)) {
438 $campo = $callback($campo);
440 // Agrego argumento procesado a la lista de argumentos.
443 // Si es un link, le seteo los contenidos procesados.
444 if (is_a($format, 'mecon_html_link')) {
445 $format->setContents(call_user_func_array('sprintf', $args));
446 // Si no formateo la cadena con los argumentos procesados.
448 $format = call_user_func_array('sprintf', $args);
451 // Si es un link, traduce las variables GET.
452 if (is_a($format, 'mecon_html_link')) {
453 $format = $this->_translateGetVars($format, $row);
455 // devuelve la columna.
460 * Traduce las variables GET de un link.
461 * Puede formatearlas con printf() o llamando una callback.
463 * @param MECON_HTML_Link $link Link con las variables GET a formatear.
464 * @param mixed $row Fila de un resultado de una base de dotos. Puede ser un
465 * array asociativo o un objeto (en cuyo caso cada campo
466 * debe ser un atributo del mismo).
468 * @return MECON_HTML_Link Link con las variables GET traducidas.
472 function _translateGetVars($link, $row) {
473 $vars = $link->getGetVars();
474 foreach ($vars as $var => $val) {
475 if (preg_match("/^{$this->_getVarPrefix}(.+)$/", $var, $m)) {
477 $campo = is_array($row) ? $row[$campo] : $row->$campo;
478 // Si no tiene valor, se lo reemplaza por el
481 $link->setGetVar($var, $campo);
482 // Si existe una funcion, se la usa para obtener
484 } elseif (function_exists($val)) {
485 $link->setGetVar($var, $val($campo));
486 // Si no es ni null ni link, lo toma como
487 // formato para el sprintf
489 $link->setGetVar($var, sprintf($val, $campo));
497 * Agrega un ícono predefinido a la tabla.
500 * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
501 * $result = $db->query('SELECT nombre, apellido FROM tabla');
502 * if (DB::isError($result)) {
505 * $tabla->addRow(array('Col1', 'Nombre', 'Apellido', 'Modificar', 'Borrar',
506 * 'Agregar'), 'cabecera');
507 * // Agrega ícono de modificar que apunta a modificar.php y pasa el 'id'.
508 * $tabla->addRowsIcon('modificar', 'id', 'modificar.php');
509 * // Agrega ícono de borrar desactivado.
510 * $tabla->addRowsIcon('no_borrar');
511 * // Agrega ícono con una flecha que apunta a agregar.php y no pasa nada.
512 * $tabla->addRowsIcon('ir', null, 'modificar.php');
513 * // Agrega resultados de la tabla.
514 * $tabla->addRows($result, array('nombre', 'apellido'));
518 * @param string $id Identificador del tipo de ícono a agregar. Puede ser:
520 * <li><tt>'modificar'</tt>: Ícono de modificar.</li>
521 * <li><tt>'no_modificar'</tt>: Ícono de modificar desactivado.</li>
522 * <li><tt>'borrar'</tt>: Ícono de borrar.</li>
523 * <li><tt>'no_borrar'</tt>: Ícono de borrar desactivado.</li>
524 * <li><tt>'ir'</tt>: Flecha hacia la derecha.</li>
526 * @param mixed $campos Campos de la DB a usar para generar el link. Estos
527 * campos serán pasados por GET a la página destino.
528 * Cada campo es pasado como la variable GET compuesta
529 * por el @ref getGetVarPrefix "prefijo" más el nombre
530 * del campo (ver parámetro $campos de addRowsData()
531 * para conocer de que formas se puede formatear un
533 * @param mixed $link Si es un string, se usa como URL del link a generar.
534 * Si es un MECON_HTML_Link, se usa como base para el
535 * link a generar y se le va agregando las variables de
536 * GET generadas por el parámetro $campos (el link es
537 * procesado de la misma forma en que es procesado el
538 * parámetro $formato en addRowsData() con la excepción
539 * de que el contenido del Link no es tomado en cuenta).
540 * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
541 * <tt>'prepend'</tt> o <tt>'append'</tt>.
543 * @warning Este método debe ser llamado antes de llamar a addRows().
544 * @note Las funciones callback toman todas un solo argumento (el valor del
545 * campo a formatear) y deben devolver un string con el campo
548 function addRowsIcon($id, $campos = array(), $link = null, $lugar = 'append') {
552 if (is_string($campos)) {
553 $campos = array($campos);
556 $link = @$_SERVER['PHP_SELF'];
558 if (is_string($link)) {
559 $link = new MECON_HTML_Link($link, '');
563 $img = new MECON_HTML_Image('/MECON/images/general_modificar', '(M)');
564 $img->updateAttributes(array('title' => 'Modificar'));
565 $link->addContents($img);
566 foreach ($campos as $campo) {
568 if (is_array($campo)) {
569 list($campo, $format) = $campo;
571 $link->setGetVar($this->_getVarPrefix.$campo, $format);
573 $this->addRowsData($link, array(), $lugar);
576 $img = new MECON_HTML_Image('/MECON/images/general_modificar_des', '(-)');
577 $img->updateAttributes(array('title' => 'Modificar'));
578 $this->addRowsData($img, array(), $lugar);
581 $img = new MECON_HTML_Image('/MECON/images/general_eliminar', '(B)');
582 $img->updateAttributes(array('title' => 'Borrar'));
583 $link->addContents($img);
584 foreach ($campos as $campo) {
585 $link->setGetVar($this->_getVarPrefix.$campo, null);
587 $this->addRowsData($link, array(), $lugar);
590 $img = new MECON_HTML_Image('/MECON/images/general_eliminar_des', '(-)');
591 $img->updateAttributes(array('title' => 'Borrar'));
592 $this->addRowsData($img, array(), $lugar);
595 $img = new MECON_HTML_Image('/MECON/images/general_ir4', '->');
596 $img->updateAttributes(array('title' => 'Ir'));
597 $link->addContents($img);
598 foreach ($campos as $campo) {
599 $link->setGetVar($this->_getVarPrefix.$campo, null);
601 $this->addRowsData($link, array(), $lugar);
604 $this->raiseError("No hay un ícono predefinido llamado '$id'.");