Se arregla la documentacion (embellecimiento).

[mecon/meconlib.git] / lib / MECON / HTML / TablaDB.php

diff --git a/lib/MECON/HTML/TablaDB.php b/lib/MECON/HTML/TablaDB.php
index 62dcb64f477d4d735695ee94586ee35aa7c3e380..591cdc2d3d0871f47bd6d5170dab2c76a24565b3 100644 (file)
--- a/lib/MECON/HTML/TablaDB.php
+++ b/lib/MECON/HTML/TablaDB.php
@@ -47,6 +47,8 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      * Cada elemento del array es a su vez un array cuyo primer elemento es el
      * formato del texto a agregar (tipo printf()) y el segundo es un array con los
      * campos de la DB a utilizar para ese formato en una fila dada.
      * Cada elemento del array es a su vez un array cuyo primer elemento es el
      * formato del texto a agregar (tipo printf()) y el segundo es un array con los
      * campos de la DB a utilizar para ese formato en una fila dada.

+     * Cuando se utiliza una callback para "dibujar" el campo, el campo puede
+     * ser un array de campos de la base que se quiere pasar a la callback.

      */
     var $_prependRowsData = array();
 
      */
     var $_prependRowsData = array();
 


@@ -59,7 +61,7 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
     /**
      * Prefijo a usar para las variables GET que genera la tabla.
      */
     /**
      * Prefijo a usar para las variables GET que genera la tabla.
      */

-    var $_getVarPrefix = 'tabladb_';
+    var $_getVarPrefix = '_';

 
     /**
      * Constructor. 
 
     /**
      * Constructor. 


@@ -102,7 +104,7 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
      * $result = $db->query('SELECT nombre, apellido FROM tabla');
      * if (DB::isError($result)) {
      * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
      * $result = $db->query('SELECT nombre, apellido FROM tabla');
      * if (DB::isError($result)) {

-     *      die('Error');
+     *      trigger_error('Error', E_USER_ERROR);

      * }
      * // Agrega el paginador por defecto y lo guarda para mostrar solo los
      * // resultados paginados después.
      * }
      * // Agrega el paginador por defecto y lo guarda para mostrar solo los
      * // resultados paginados después.


@@ -221,8 +223,12 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
                 $this->addRowsResult($result, $campos, $obj);
             }
         } else {
                 $this->addRowsResult($result, $campos, $obj);
             }
         } else {

-            $id = $this->addRow(array(new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
-            $this->updateCellAttributes($id, 0, array('colspan' => count($campos)));
+            $id = $this->addRow(array(
+                new MECON_HTML_Error("No se encontraron {$this->_desc}.")));
+            $this->updateCellAttributes($id, 0,
+                array('colspan' => count($campos)
+                    + count($this->_prependRowsData)
+                    + count($this->_appendRowsData)));

         }
     }
 
         }
     }
 


@@ -289,41 +295,118 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
      * $result = $db->query('SELECT nombre, apellido, activo FROM tabla');
      * if (DB::isError($result)) {
      * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
      * $result = $db->query('SELECT nombre, apellido, activo FROM tabla');
      * if (DB::isError($result)) {

-     *      die('Error');
+     *      trigger_error('Error', E_USER_ERROR);

      * }
      * }

-     * $tabla->addRow(array('Col1', 'Nombre', 'Apellido', 'Activo'), 'cabecera');
+     * $tabla->addRow(
+     *      array('Col1', 'Nombre', 'Apellido', 'Activo', 'PopUp1', 'PopUp2'),
+     *      'cabecera');

      * // Agrega una columna con una leyenda 'El nombre es: {nombre}' al principio.
      * $tabla->addRowsData('Me llamo %s.', 'nombre', 'prepend');
      * // Agrega una columna al final con checkbox para seleccionar filas. El
      * // segundo elemento será procesado por la callback checked_callback().
      * $tabla->addRowsData('<input type="checkbox" name="datos[%s]" value="1" %s />',
      *          array('nombre', array('activo', 'checked_callback')));
      * // Agrega una columna con una leyenda 'El nombre es: {nombre}' al principio.
      * $tabla->addRowsData('Me llamo %s.', 'nombre', 'prepend');
      * // Agrega una columna al final con checkbox para seleccionar filas. El
      * // segundo elemento será procesado por la callback checked_callback().
      * $tabla->addRowsData('<input type="checkbox" name="datos[%s]" value="1" %s />',
      *          array('nombre', array('activo', 'checked_callback')));

+     * // Agrega el nombre con un link a un popup (sin javascript).
+     * $tabla->addRowsData(
+     *      new MECON_HTML_Link('popup.php', '%s', array('nombre' => null),
+     *          array('target' => '_blank')),
+     *      'nombre',
+     *      'prepend');
+     * // Agrega el nombre con un link a un popup (con javascript).
+     * $tabla->addRowsData('<a href="popup.php?nombre=%s" '
+     *          . 'onclick="'."javascript:window.open('popup.php?nombre=%s',"
+     *          . "'win_id','width=400,height=400,scrollbars=no');"
+     *          . 'return false;">%s</a>',
+     *      array('nombre', 'nombre', 'apellido'));

      * // Agrega resultados de la tabla.
      * $tabla->addRows($result, array('nombre', 'apellido'));
      * // Agrega resultados de la tabla.
      * $tabla->addRows($result, array('nombre', 'apellido'));

+     * 
+     * 
+     * //Ejemplo utilizando una funcion callback con varios parametros obtenidos
+     * //de la DB.
+     * $tabla->addRowsData (
+     *      'Mi nombre es: %s, por lo tanto %s', //Formato de la columna a agregar.
+     *      array(                               //Array de campos a incluir en el formato
+     *          'nombre',                        //El dato de este campo reemplazara el primer %s
+     *          //El resultado de la llamada a la funcion nombre_callback que tomo
+     *          //como paramteros los campos de la db que estan dentro del array
+     *          //reemplazara al segundo %s
+     *          array(array('nombre', 'apellido'), 'nombre_callback') 
+     *      )
+     *  );
+     * 

      * $tabla->display();
      * $tabla->display();

+     *
+     * // Funcion callback para darle formato al campo 'activo'.
+     * // En este caso devuelve 'checked' para indicar que el checkbox está
+     * // activado si activo es true.
+     * function checked_callback($activo) {
+     *      return $activo ? 'checked' : '';
+     * }
+     *
+     * //Funcion callback que acepta mas de un parametro en un array
+     * function nombre_callback($parametros) {
+     *      if ($parametros['nombre'] == 'Juan Carlos' &&
+     *      $parametros['apellido'] == 'Gomez') {
+     *          return 'soy Charly';
+     *      }
+     *      else {
+     *          return 'no soy Charly';
+     *      }
+     * }
+     * 

      * @endcode
      *
      * @param mixed $format Si es un string, especifica el formato a usar al
      *                      estilo de sprintf. Si es un MECON_HTML_Link, se
      *                      traduce cada variable por GET que empiece con el
      *                      \ref getGetVarPrefix "prefijo" y cuyo valor sea null
      * @endcode
      *
      * @param mixed $format Si es un string, especifica el formato a usar al
      *                      estilo de sprintf. Si es un MECON_HTML_Link, se
      *                      traduce cada variable por GET que empiece con el
      *                      \ref getGetVarPrefix "prefijo" y cuyo valor sea null

-     *                      al campo correspondiente de la DB. Si e valor en vez
-     *                      de ser null es un string, se fija si existe una
-     *                      función con ese nombre para llamar con el campo de
-     *                      la DB como argumento para formatearlo. Si no existe
-     *                      la función, se toma el string como formato para
-     *                      sprintf para darle formato.
+     *                      al campo correspondiente de la DB:
+     * @code $tabla->addRowsData(new MECON_HTML_Link('abm.php', 'Ver %s',
+     *      array($tabla->getGetVarPrefix().'id' => null), 'nombre'); @endcode
+     *                      Si el valor en vez de ser null es un string, se
+     *                      fija si existe una función con ese nombre para llamar
+     *                      con el campo de la DB como argumento para
+     *                      formatearlo:
+     * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Mostrar',
+     *      array($tabla->getGetVarPrefix().'campo1' => 'callback_campo1'));
+     * function callback_campo1($campo1) {
+     *      return 'El campo1 es '.strtoupper($campo3);
+     * } @endcode
+     *                      Si no existe la función, se toma el string como
+     *                      formato para sprintf para darle formato:
+     * @code $tabla->addRowsData(new MECON_HTML_Link('print.php', 'Ver',
+     *      array($tabla->getGetVarPrefix().'campo1' => 'campo1: %s')); @endcode

      * @param mixed $campos Campos de la DB a usar como argumentos del sprintf.
      *                      Puede ser un string para pasar un solo campo sin
      * @param mixed $campos Campos de la DB a usar como argumentos del sprintf.
      *                      Puede ser un string para pasar un solo campo sin

-     *                      formato. Si es un array, cada elemento es un campo
+     *                      formato:
+     *                      @code $tabla->addRowsData('%s', 'campo1'); @endcode
+     *                      Si es un array, cada elemento es un campo

      *                      que puede ser un string representando el nombre de
      *                      que puede ser un string representando el nombre de

-     *                      un campo a usar sin agumento o un array cuyo primer
-     *                      elemento es el nombre del campo a usar y el segundo
-     *                      argumento es una funcion callback a llamar con el
-     *                      valor del campo como argumento para darle formato.
-     *                      @code $tabla->addRowsData('%s', array('campo1', 'campo2', array('campo3', 'callback_campo3')))); @endcode
+     *                      un campo a usar:
+     *                      @code $tabla->addRowsData('%s',
+     *      array('campo1', 'campo2'); @endcode
+     *                      o un array cuyo primer elemento es un string o un
+     *                      array con los nombres de los campos de la db a utilizar
+     *                      y el segundo argumento es una funcion
+     *                      callback a llamar con el valor del campo (o los
+     *                      campos si se paso un array de campos) como
+     *                      argumento para darle formato:
+     *                      @code $tabla->addRowsData('%s',
+     *      array('campo1', array(array('campo2', 'campo3'), 'callback_campo_2_3'))));
+     * function callback_campo_2_3($campos) {
+     *      return strtoupper($campos['campo2']) . ', ' . strtolower($campos['campo3']);
+     * } @endcode
+     *                      Para ver un ejemplo de una callback con muchos
+     *                      parametros ver la descripcion detallada de esta funcion.
+     *                      Si no se encuentra la funcion callback, se toma como
+     *                      un string para formatear el campo con sprintf():
+     *                      @code $tabla->addRowsData('%s', array('campo1',
+     *      array('campo2', 'campo2 = %s')); @endcode

      * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
      * @param string $lugar Indica donde hay que agregar la columna. Puede ser:

-     *                      <tt>prepend</tt> o <tt>append</tt>.
+     *                      <tt>'prepend'</tt> o <tt>'append'</tt>:
+     *                      @code $tabla->addRowsData('Hola %s!', 'nombre',
+     *      'prepend'); @endcode

      *
      * @warning Este método debe ser llamado antes de llamar a addRows().
      * @note Las funciones callback toman todas un solo argumento (el valor del
      *
      * @warning Este método debe ser llamado antes de llamar a addRows().
      * @note Las funciones callback toman todas un solo argumento (el valor del


@@ -351,7 +434,7 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      *
      * @param array $data Datos sobre la columna, en el formato especificado
      *                    para un elemento del array usado en _prependRowsData.
      *
      * @param array $data Datos sobre la columna, en el formato especificado
      *                    para un elemento del array usado en _prependRowsData.

-     * @param mixed $row Fila de un resultado de una base de dotos. Puede ser un
+     * @param mixed $row Fila de un resultado de una base de datos. Puede ser un

      *                   array asociativo o un objeto (en cuyo caso cada campo
      *                   debe ser un atributo del mismo).
      *
      *                   array asociativo o un objeto (en cuyo caso cada campo
      *                   debe ser un atributo del mismo).
      *


@@ -378,14 +461,37 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
                     list($campo, $callback) = $campo;
                 }
                 if (is_array($row)) {
                     list($campo, $callback) = $campo;
                 }
                 if (is_array($row)) {

-                    $campo = $row[$campo]; // Es un campo de un array.
-                } else {
-                    $campo = $row->$campo; // Es un atributo de un objeto.
+                    if (is_array($campo)) {
+                        foreach ($campo as $c) {
+                            $tmp[$c] = $row[$c];
+                        }
+                        $campo = $tmp;
+                    }
+                    else {
+                        $campo = $row[$campo]; // Es un campo de un array.
+                    }
+                } else { //$row es un objeto
+                    if (is_array($campo)) {
+                        foreach ($campo as $c) {
+                            $tmp[$c] = $row->$c;
+                        }
+                        $campo = $tmp;
+                    }
+                    else {
+                        $campo = $row->$campo; // Es un atributo de un objeto.
+                    }

                 }
                 // Si usa callback, cambio el campo por el resultado del
                 // llamado a su callback.
                 }
                 // Si usa callback, cambio el campo por el resultado del
                 // llamado a su callback.

-                if (isset($callback) and function_exists($callback)) {
-                    $campo = $callback($campo);
+                if (isset($callback)) {
+                    if(function_exists($callback)) {
+                        $campo = $callback($campo);
+                    } else {
+                        //Si no existe la funcion de callback usa el callback como
+                        //formato y los campos como argumentos para el sprintf
+                        array_unshift($campo, $callback);
+                        $campo = call_user_func_array('sprintf', $campo);
+                    }

                 }
                 // Agrego argumento procesado a la lista de argumentos.
                 $args[] = $campo;
                 }
                 // Agrego argumento procesado a la lista de argumentos.
                 $args[] = $campo;


@@ -445,6 +551,25 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
 
     /**
      * Agrega un ícono predefinido a la tabla.
 
     /**
      * Agrega un ícono predefinido a la tabla.

+     * Ejemplo:
+     * @code
+     * $tabla = new MECON_HTML_TablaDB('personas', array('width' => '100%'));
+     * $result = $db->query('SELECT nombre, apellido FROM tabla');
+     * if (DB::isError($result)) {
+     *      trigger_error('Error', E_USER_ERROR);
+     * }
+     * $tabla->addRow(array('Col1', 'Nombre', 'Apellido', 'Modificar', 'Borrar',
+     *      'Agregar'), 'cabecera');
+     * // Agrega ícono de modificar que apunta a modificar.php y pasa el 'id'.
+     * $tabla->addRowsIcon('modificar', 'id', 'modificar.php');
+     * // Agrega ícono de borrar desactivado.
+     * $tabla->addRowsIcon('no_borrar');
+     * // Agrega ícono con una flecha que apunta a agregar.php y no pasa nada.
+     * $tabla->addRowsIcon('ir', null, 'modificar.php');
+     * // Agrega resultados de la tabla.
+     * $tabla->addRows($result, array('nombre', 'apellido'));
+     * $tabla->display();
+     * @endcode

      *
      * @param string $id Identificador del tipo de ícono a agregar. Puede ser:
      *                   <ul>
      *
      * @param string $id Identificador del tipo de ícono a agregar. Puede ser:
      *                   <ul>


@@ -469,7 +594,7 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      *                    parámetro $formato en addRowsData() con la excepción
      *                    de que el contenido del Link no es tomado en cuenta).
      * @param string $lugar Indica donde hay que agregar la columna. Puede ser:
      *                    parámetro $formato en addRowsData() con la excepción
      *                    de que el contenido del Link no es tomado en cuenta).
      * @param string $lugar Indica donde hay que agregar la columna. Puede ser:

-     *                      <tt>prepend</tt> o <tt>append</tt>.
+     *                      <tt>'prepend'</tt> o <tt>'append'</tt>.

      *
      * @warning Este método debe ser llamado antes de llamar a addRows().
      * @note Las funciones callback toman todas un solo argumento (el valor del
      *
      * @warning Este método debe ser llamado antes de llamar a addRows().
      * @note Las funciones callback toman todas un solo argumento (el valor del


@@ -477,6 +602,9 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
      *       formateado.
      */
     function addRowsIcon($id, $campos = array(), $link = null, $lugar = 'append') {
      *       formateado.
      */
     function addRowsIcon($id, $campos = array(), $link = null, $lugar = 'append') {

+        if (!$campos) {
+            $campos = array();
+        }

         if (is_string($campos)) {
             $campos = array($campos);
         }
         if (is_string($campos)) {
             $campos = array($campos);
         }


@@ -489,6 +617,7 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
         switch ($id) {
             case 'modificar':
                 $img = new MECON_HTML_Image('/MECON/images/general_modificar', '(M)');
         switch ($id) {
             case 'modificar':
                 $img = new MECON_HTML_Image('/MECON/images/general_modificar', '(M)');

+                $img->updateAttributes(array('title' => 'Modificar'));

                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $format = null;
                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $format = null;


@@ -501,10 +630,12 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
                 break;
             case 'no_modificar':
                 $img = new MECON_HTML_Image('/MECON/images/general_modificar_des', '(-)');
                 break;
             case 'no_modificar':
                 $img = new MECON_HTML_Image('/MECON/images/general_modificar_des', '(-)');

+                $img->updateAttributes(array('title' => 'Modificar'));

                 $this->addRowsData($img, array(), $lugar);
                 break;
             case 'borrar':
                 $img = new MECON_HTML_Image('/MECON/images/general_eliminar', '(B)');
                 $this->addRowsData($img, array(), $lugar);
                 break;
             case 'borrar':
                 $img = new MECON_HTML_Image('/MECON/images/general_eliminar', '(B)');

+                $img->updateAttributes(array('title' => 'Borrar'));

                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $link->setGetVar($this->_getVarPrefix.$campo, null);
                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $link->setGetVar($this->_getVarPrefix.$campo, null);


@@ -513,10 +644,12 @@ class MECON_HTML_TablaDB extends MECON_HTML_Tabla {
                 break;
             case 'no_borrar':
                 $img = new MECON_HTML_Image('/MECON/images/general_eliminar_des', '(-)');
                 break;
             case 'no_borrar':
                 $img = new MECON_HTML_Image('/MECON/images/general_eliminar_des', '(-)');

+                $img->updateAttributes(array('title' => 'Borrar'));

                 $this->addRowsData($img, array(), $lugar);
                 break;
             case 'ir':
                 $img = new MECON_HTML_Image('/MECON/images/general_ir4', '->');
                 $this->addRowsData($img, array(), $lugar);
                 break;
             case 'ir':
                 $img = new MECON_HTML_Image('/MECON/images/general_ir4', '->');

+                $img->updateAttributes(array('title' => 'Ir'));

                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $link->setGetVar($this->_getVarPrefix.$campo, null);
                 $link->addContents($img);
                 foreach ($campos as $campo) {
                     $link->setGetVar($this->_getVarPrefix.$campo, null);