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