lib/MECON/HTML/TablaDB.php

   1 <?php /* vim: set binary expandtab tabstop=4 shiftwidth=4 textwidth=80:
   2 -------------------------------------------------------------------------------
   3                              Ministerio de Economía
   4                                     meconlib
   5 -------------------------------------------------------------------------------
   6 This file is part of meconlib.
   7
   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)
  11 any later version.
  12
  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.
  16
  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 -------------------------------------------------------------------------------
  24 $Id$
  25 -----------------------------------------------------------------------------*/
  26
  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';
  32
  33 /**
  34  * Libreria para le manejo de las tablas de los sistemas de intranet.
  35  *
  36  */
  37 class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
  38
  39     /**
  40      * Descripción de los elementos listados.
  41      * Se utiliza en mensajes del paginador y otros mensajes.
  42      */
  43     var $_desc = 'resultados';
  44
  45     /**
  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.
  50      */
  51     var $_prependRowsData = array();
  52
  53     /**
  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.
  56      */
  57     var $_appendRowsData = array();
  58
  59     /**
  60      * Constructor.
  61      * Puede recibir como parametro un string con los atributos que se
  62      * quieren dar a la tabla en cuestion. Estos atributos estan
  63      * seteados por default segun el archivo de configuracion.
  64      * Ademas puede recibir la indicacion de algun estilo en particular.
  65      *
  66      * @param string $desc Descripción de los elementos listados.
  67      * @param mixed $attrs Atributos diferentes a los estandares para la tabla
  68      * @param string $estilo Tipo de tabla
  69      *
  70      * @access public
  71      */
  72     function MECON_HTML_TablaDB($desc = null, $attrs = null, $estilo = 'comun') {
  73         if ($desc) {
  74             $this->_desc = $desc;
  75         }
  76         parent::MECON_HTML_Tabla($attrs, $estilo);
  77     }
  78
  79     /**
  80      * Agrega un páginador a la tabla, basado en un resultado de una base de datos.
  81      * Ejemplo:
  82      * @code
  83      * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
  84      * $result = $db->query('SELECT nombre, apellido FROM tabla');
  85      * if (DB::isError($result)) {
  86      *      die('Error');
  87      * }
  88      * $pager = $tabla->addPager($result);
  89      * $tabla->addRow(array('Nombre', 'Apellido'), 'cabecera');
  90      * $tabla->addRows($result, array('nombre', 'apellido'));
  91      * $tabla->display();
  92      * @endcode
  93      *
  94      * @param DB_Result $result Resultado de una consulta de base de datos.
  95      * @param mixed $tipo Tipo de link(s) a agregar. Puede ser:
  96      *                    <ul>
  97      *                      <li><tt>'anterior'</tt></li>
  98      *                      <li><tt>'siguiente'</tt></li>
  99      *                      <li><tt>'paginas'</tt></li>
 100      *                      <li><tt>'total'</tt></li>
 101      *                      <li><tt>'info'</tt></li>
 102      *                    </ul>
 103      *                    Puede pasarse uno solo como un string o varios como un
 104      *                    array. Si se pasa <tt>'todo'</tt>, se incluyen todos.
 105      *                    Si se pasa null, se incluyen <tt>'anterior'</tt>,
 106      *                    <tt>'siguiente'</tt> y <tt>'paginas'</tt>.
 107      * @param mixed $link Dirección a la que apuntan los links generados. Puede
 108      *                    ser un MECON_HTML_Link (para poder pasar variables por
 109      *                    GET) o un string.
 110      * @param int $limit Parámetro usado para crear el MECON_DB_Pager.
 111      * @param int $maxpages Parámetro usado para crear el MECON_DB_Pager.
 112      *
 113      * @return MECON_DB_Pager Pager que se puede usar para realizar los fetch de
 114      *         los resultados de la página actual.
 115      *
 116      * @see MECON_DB_Pager.
 117      */
 118     function addPager($result, $tipo = null, $link = null, $limit = 10, $maxpages = 21) {
 119         // Creo el pager con el resultado.
 120         $pager = new MECON_DB_Pager($result, @$_GET['pager_from'], $limit, $maxpages);
 121         // Obtengo un link válido.
 122         if (!$link) {
 123             $link = @$_SERVER['PHP_SELF'];
 124         }
 125         if (is_string($link)) {
 126             $link = new MECON_HTML_Link($link, '');
 127         }
 128         // Si es el tipo por defecto pone paginador nada más.
 129         if (!$tipo) {
 130             $tipo = array('anterior', 'paginas', 'siguiente');
 131         }
 132         // Convierte tipo a array.
 133         if (!is_array($tipo)) {
 134             $tipo = array($tipo);
 135         }
 136         // Si se quiere mostrar todas las decoraciones del paginador.
 137         if (in_array('todo', $tipo)) {
 138             $tipo = array('anterior', 'paginas', 'siguiente', 'total', 'info');
 139         }
 140         // Me fijo si tiene cada uno de los elementos y los agrego.
 141         if (in_array('anterior', $tipo) and $pager->numRows() and $pager->currentpage != 1) {
 142             $link->setGetVar('pager_from', $pager->prev);
 143             $this->addLink('anterior', $link);
 144         }
 145         if (in_array('siguiente', $tipo) and $pager->numRows() and $pager->currentpage != $pager->numpages) {
 146             $link->setGetVar('pager_from', $pager->next);
 147             $this->addLink('siguiente', $link);
 148         }
 149         if (in_array('paginas', $tipo) and $pager->numRows() and $pager->numpages > 1) {
 150             $from = @$_GET['pager_from'];
 151             $pags = '';
 152             $lnk = $link->getContents();
 153             foreach ($pager->pages as $page => $start_row) {
 154                 if ($start_row == $from) {
 155                     $pags .= $page;
 156                 } else {
 157                     $link->setGetVar('pager_from', $start_row);
 158                     $link->setContents($page);
 159                     $pags .= $link->toHtml();
 160                 }
 161                 if ($page != $pager->lastpage) {
 162                     $pags .= ' | ';
 163                 }
 164             }
 165             $link->setContents($lnk);
 166             $this->updatePie($pags, 'centro');
 167         }
 168         if (in_array('total', $tipo) and $pager->numRows()) {
 169             $this->updateCabecera("Se encontraron {$pager->numrows} {$this->_desc}.", 'izquierda');
 170         }
 171         if (in_array('info', $tipo) and $pager->numRows()) {
 172             $this->updateCabecera("'Página {$pager->currentpage} de {$pager->numpages} - "
 173                 . "{$pager->limit} {$this->_desc} por página.", 'derecha');
 174         }
 175         return $pager;
 176     }
 177
 178     /**
 179      * Agrega filas desde el resultado de una consulta a una base de datos.
 180      * Si no hay resultados, muestra un mensaje. Dependiendo de si es se pasa
 181      * un objeto a usar o no, llama a addRowsObject() o addRowsResult()
 182      * respectivamente.
 183      * Ejemplo:
 184      * @code
 185      * @endcode
 186      *
 187      * @param DB_Result $result Resultados de una consulta.
 188      * @param array $campos Propiedades del objeto a mostrar.
 189      * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
 190      *                   string con el nombre de la clase.
 191      *
 192      * @see Ejemplo en addPager();
 193      */
 194     function addRows($result, $campos, $obj = null) {
 195         if ($result->numRows()) {
 196             if ($obj) {
 197                 $this->addRowsObject($result, $campos, $obj);
 198             } else {
 199                 $this->addRowsResult($result, $campos, $obj);
 200             }
 201         } else {
 202             $id = $this->addRow(array(new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
 203             $this->updateCellAttributes($id, 0, array('colspan' => count($campos)));
 204         }
 205     }
 206
 207     /**
 208      * Agrega filas usando un resultado.
 209      *
 210      * @param DB_Result $result Resultados de una consulta.
 211      * @param array $campos Campos de la base de datos a mostrar.
 212      */
 213     function addRowsResult($result, $campos) {
 214         while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC)) {
 215             $datos = array();
 216             if ($this->_prependRowsData) {
 217                 $datos = $this->_buildRowsData($datos, $row, $this->_prependRowsData);
 218             }
 219             foreach ($campos as $campo) {
 220                 $datos[] = $row[$campo];
 221             }
 222             if ($this->_appendRowsData) {
 223                 $datos = $this->_buildRowsData($datos, $row, $this->_appendRowsData);
 224             }
 225             $this->addRow($datos);
 226         }
 227     }
 228
 229     /**
 230      * Agrega filas usando un objeto.
 231      * El objeto debe tener un método llamado cargar que acepte como primer (y
 232      * único obligatorio) parámetro un DB_Result para cargar sus datos desde una
 233      * base de datos.
 234      *
 235      * @param DB_Result $result Resultados de una consulta.
 236      * @param array $campos Propiedades del objeto a mostrar.
 237      * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
 238      *                   string con el nombre de la clase.
 239      *
 240      * @see La interfaz MECON_DBO que tiene el método MECON_DBO::cargar().
 241      */
 242     function addRowsObject($result, $campos, $obj) {
 243         if (is_string($obj)) {
 244             $obj = new $obj;
 245         }
 246         if (!method_exists($obj, 'cargar')) {
 247             $this->raiseError('La clase ' . get_class($obj) . ' no tiene un metodo cargar().');
 248         }
 249         while ($obj->cargar($result)) {
 250             $datos = array();
 251             foreach ($campos as $campo) {
 252                 $datos[] = $obj->$campo;
 253             }
 254             $this->addRow($datos);
 255         }
 256     }
 257
 258     function prependRowsData($format, $campos = array()) {
 259         if (!is_array($campos)) {
 260             $campos = array($campos);
 261         }
 262         $this->_prependRowsData[] = array($format, $campos);
 263     }
 264
 265     function appendRowsData($format, $campos = array()) {
 266         if (!is_array($campos)) {
 267             $campos = array($campos);
 268         }
 269         $this->_appendRowsData[] = array($format, $campos);
 270     }
 271
 272     function _buildRowsData($datos, $row, $array) {
 273         if ($array) {
 274             foreach ($array as $data) {
 275                 list($format, $fields) = $data;
 276                 if ($fields) {
 277                     $args = array($format);
 278                     foreach ($fields as $field) {
 279                         if (is_array($row)) {
 280                             $args[] = $row[$field];
 281                         } else {
 282                             $args[] = $row->$field;
 283                         }
 284                     }
 285                     $datos[] = call_user_func_array('sprintf', $args);
 286                 } else {
 287                     $datos[] = $format;
 288                 }
 289             }
 290         }
 291         return $datos;
 292     }
 293
 294 }
 295
 296 ?>