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      * Constructor.
  47      * Puede recibir como parametro un string con los atributos que se
  48      * quieren dar a la tabla en cuestion. Estos atributos estan
  49      * seteados por default segun el archivo de configuracion.
  50      * Ademas puede recibir la indicacion de algun estilo en particular.
  51      *
  52      * @param string $desc Descripción de los elementos listados.
  53      * @param mixed $attrs Atributos diferentes a los estandares para la tabla
  54      * @param string $estilo Tipo de tabla
  55      *
  56      * @access public
  57      */
  58     function MECON_HTML_TablaDB($desc = null, $attrs = null, $estilo = 'comun') {
  59         if ($desc) {
  60             $this->_desc = $desc;
  61         }
  62         parent::MECON_HTML_Tabla($attrs, $estilo);
  63     }
  64
  65     /**
  66      * Agrega un páginador a la tabla, basado en un resultado de una base de datos.
  67      * Ejemplo:
  68      * @code
  69      * $tabla = new MECON_HTML_Tabla();
  70      * $result = $db->query('SELECT * FROM tabla');
  71      * if (DB::isError($result)) {
  72      *      die('Error');
  73      * }
  74      * $pager = $tabla->addPager($result);
  75      * $tabla->addRow(array('Nombre', 'Apellido'), 'cabecera');
  76      * if ($pager->numRows()) {
  77      *      while ($row = $pager->fetchRow(DB_FETCHMODE_ASSOC)) {
  78      *          $tabla->addRow(array($row['nombre'], $row['apellido']));
  79      *      }
  80      * } else {
  81      *      $tabla->addRow(array(new MECON_HTML_Error('No se encontraron agentes.')),
  82      *          array('colspan' => 2));
  83      * }
  84      * $tabla->display();
  85      * @endcode
  86      *
  87      * @param DB_Result $result Resultado de una consulta de base de datos.
  88      * @param mixed $tipo Tipo de link(s) a agregar. Puede ser:
  89      *                    <ul>
  90      *                      <li><tt>'anterior'</tt></li>
  91      *                      <li><tt>'siguiente'</tt></li>
  92      *                      <li><tt>'paginas'</tt></li>
  93      *                      <li><tt>'total'</tt></li>
  94      *                      <li><tt>'info'</tt></li>
  95      *                    </ul>
  96      *                    Puede pasarse uno solo como un string o varios como un
  97      *                    array. Si se pasa <tt>'todo'</tt>, se incluyen todos.
  98      *                    Si se pasa null, se incluyen <tt>'anterior'</tt>,
  99      *                    <tt>'siguiente'</tt> y <tt>'paginas'</tt>.
 100      * @param mixed $link Dirección a la que apuntan los links generados. Puede
 101      *                    ser un MECON_HTML_Link (para poder pasar variables por
 102      *                    GET) o un string.
 103      * @param int $limit Parámetro usado para crear el MECON_DB_Pager.
 104      * @param int $maxpages Parámetro usado para crear el MECON_DB_Pager.
 105      *
 106      * @return MECON_DB_Pager Pager que se puede usar para realizar los fetch de
 107      *         los resultados de la página actual.
 108      *
 109      * @see MECON_DB_Pager.
 110      */
 111     function addPager($result, $tipo = null, $link = null, $limit = 10, $maxpages = 21) {
 112         // Creo el pager con el resultado.
 113         $pager = new MECON_DB_Pager($result, @$_GET['pager_from'], $limit, $maxpages);
 114         // Obtengo un link válido.
 115         if (!$link) {
 116             $link = @$_SERVER['PHP_SELF'];
 117         }
 118         if (is_string($link)) {
 119             $link = new MECON_HTML_Link($link, '');
 120         }
 121         // Si es el tipo por defecto pone paginador nada más.
 122         if (!$tipo) {
 123             $tipo = array('anterior', 'paginas', 'siguiente');
 124         }
 125         // Convierte tipo a array.
 126         if (!is_array($tipo)) {
 127             $tipo = array($tipo);
 128         }
 129         // Si se quiere mostrar todas las decoraciones del paginador.
 130         if (in_array('todo', $tipo)) {
 131             $tipo = array('anterior', 'paginas', 'siguiente', 'total', 'info');
 132         }
 133         // Me fijo si tiene cada uno de los elementos y los agrego.
 134         if (in_array('anterior', $tipo) and $pager->numRows() and $pager->currentpage != 1) {
 135             $link->setGetVar('pager_from', $pager->prev);
 136             $this->addLink('anterior', $link);
 137         }
 138         if (in_array('siguiente', $tipo) and $pager->numRows() and $pager->currentpage != $pager->numpages) {
 139             $link->setGetVar('pager_from', $pager->next);
 140             $this->addLink('siguiente', $link);
 141         }
 142         if (in_array('paginas', $tipo) and $pager->numRows() and $pager->numpages > 1) {
 143             $from = @$_GET['pager_from'];
 144             $pags = '';
 145             $lnk = $link->getContents();
 146             foreach ($pager->pages as $page => $start_row) {
 147                 if ($start_row == $from) {
 148                     $pags .= $page;
 149                 } else {
 150                     $link->setGetVar('pager_from', $start_row);
 151                     $link->setContents($page);
 152                     $pags .= $link->toHtml();
 153                 }
 154                 if ($page != $pager->lastpage) {
 155                     $pags .= ' | ';
 156                 }
 157             }
 158             $link->setContents($lnk);
 159             $this->updatePie($pags, 'centro');
 160         }
 161         if (in_array('total', $tipo) and $pager->numRows()) {
 162             $this->updateCabecera("Se encontraron {$pager->numrows} {$this->_desc}.", 'izquierda');
 163         }
 164         if (in_array('info', $tipo) and $pager->numRows()) {
 165             $this->updateCabecera("'Página {$pager->currentpage} de {$pager->numpages} - "
 166                 . "{$pager->limit} {$this->_desc} por página.", 'derecha');
 167         }
 168         return $pager;
 169     }
 170
 171     /**
 172      * Agrega filas desde el resultado de una consulta a una base de datos.
 173      * Si no hay resultados, muestra un mensaje. Dependiendo de si es se pasa
 174      * un objeto a usar o no, llama a addRowsObject() o addRowsResult()
 175      * respectivamente.
 176      * Ejemplo:
 177      * @code
 178      * $tabla = new MECON_HTML_TablaDB('agentes', array('width' => '100%'));
 179      * $tabla->addRow(array('Nombre', 'Apellido'));
 180      * // Supongo que $result tiene un DB_Result.
 181      * $tabla->addRows($result, array('nombre', 'cuil'));
 182      * $tabla->display();
 183      * @endcode
 184      *
 185      * @param DB_Result $result Resultados de una consulta.
 186      * @param array $campos Propiedades del objeto a mostrar.
 187      * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
 188      *                   string con el nombre de la clase.
 189      */
 190     function addRows($result, $campos, $obj = null) {
 191         if ($result->numRows()) {
 192             if ($obj) {
 193                 $this->addRowsObject($result, $campos, $obj);
 194             } else {
 195                 $this->addRowsResult($result, $campos, $obj);
 196             }
 197         } else {
 198             $id = $this->addRow(array(new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
 199             $this->updateCellAttributes($id, 0, array('colspan' => count($campos)));
 200         }
 201     }
 202
 203     /**
 204      * Agrega filas usando un resultado.
 205      *
 206      * @param DB_Result $result Resultados de una consulta.
 207      * @param array $campos Campos de la base de datos a mostrar.
 208      */
 209     function addRowsResult($result, $campos) {
 210         while ($row = $result->fetchRow(DB_FETCHMODE_ASSOC)) {
 211             $datos = array();
 212             foreach ($campos as $campo) {
 213                 $datos[] = $row[$campo];
 214             }
 215             $this->addRow($datos);
 216         }
 217     }
 218
 219     /**
 220      * Agrega filas usando un objeto.
 221      * El objeto debe tener un método llamado cargar que acepte como primer (y
 222      * único obligatorio) parámetro un DB_Result para cargar sus datos desde una
 223      * base de datos.
 224      *
 225      * @param DB_Result $result Resultados de una consulta.
 226      * @param array $campos Propiedades del objeto a mostrar.
 227      * @param mixed $obj Objeto a usar. Puede ser un objeto instanciado o un
 228      *                   string con el nombre de la clase.
 229      *
 230      * @see La interfaz MECON_DBO que tiene el método MECON_DBO::cargar().
 231      */
 232     function addRowsObject($result, $campos, $obj) {
 233         if (is_string($obj)) {
 234             $obj = new $obj;
 235         }
 236         if (!method_exists($obj, 'cargar')) {
 237             $this->raiseError('La clase ' . get_class($obj) . ' no tiene un metodo cargar().');
 238         }
 239         while ($obj->cargar($result)) {
 240             $datos = array();
 241             foreach ($campos as $campo) {
 242                 $datos[] = $obj->$campo;
 243             }
 244             $this->addRow($datos);
 245         }
 246     }
 247
 248 }
 249
 250 ?>