Documentación GVHIDRA 3.1.5
Referencia de la Clase IgepComunicaUsuario
Diagrama de herencias de IgepComunicaUsuario
IgepComunicaIU

Métodos públicos

 __construct (&$comunica, &$datosPreinsertados, &$listasPanel)
 reset ($parametroOperacion='')
 setOperacion ($parametroOperacion)
 setIndice ($indice)
 getOperacion ()
 getIndice ($parametroOperacion='')
 currentTupla ($parametroOperacion='')
 getValue ($nombreCampo, $parametroOperacion='')
 getOldValue ($nombreCampo)
 setSelected ($nombreCampo, $valorCampo, $parametroOperacion='')
 setChecked ($name, $check, $parametroOperacion='')
 isChecked ($name, $parametroOperacion='')
 setValue ($nombreCampo, $valorCampo, $parametroOperacion='')
 nextTupla ($parametroOperacion='')
 fetchTupla ($parametroOperacion='')
 setTupla ($tupla, $parametroOperacion='')
 getAllTuplas ($parametroOperacion='')
 getAllTuplasAntiguas ($parametroOperacion='')
 getAllOldTuplas ($parametroOperacion='')
 setAllTuplas ($vTuplas, $parametroOperacion='')
 hayDatos ($parametroOperacion='')
 getLista ($nombreCampo, $parametroOperacion='')
 setLista ($nombreCampo, $objListaStruc, $parametroOperacion= '')
 getFileInfo ($nombreCampo, $pametroOperacion='')
 setRowColor (&$row, $color)
 _prepararOperacion ($conexion, $v_desCampos)
 getForward ($name)

Métodos públicos estáticos

static prepararPresentacion (&$a_parametros, $a_tipo, $a_decimales='2')

Campos de datos

 $comunica
 $datosPreinsertados
 $listasPanel
 $obj_mensaje = null

Descripción detallada

Definición en la línea 55 del archivo IgepComunicaUsuario.php.


Documentación del constructor y destructor

__construct ( &$  comunica,
&$  datosPreinsertados,
&$  listasPanel 
)

Constructor. Recibe como parmetro una instancia viva de la clase IgepComunicacion

public

Parámetros:
object$comunica

Definición en la línea 93 del archivo IgepComunicaUsuario.php.

                                                                                        {

                $this->comunica = & $comunica;
                $this->datosPreinsertados = & $datosPreinsertados;
                $this->listasPanel = & $listasPanel;
        } 

Documentación de las funciones miembro

_prepararOperacion ( conexion,
v_desCampos 
)

private Mtodo privado que prepara los datos antes de realizar una operacion en la BD.

Definición en la línea 470 del archivo IgepComunicaUsuario.php.

                                                       {
        
        $m_datos = $this->getAllTuplas();
        $conexion->prepararOperacion($m_datos,$v_desCampos);
        $this->setAllTuplas($m_datos);
        $this->reset();
        if($this->getOperacion()=='actualizar'){
            $m_datosAnt = $this->getAllTuplasAntiguas();
            $conexion->prepararOperacion($m_datosAnt,$v_desCampos);
            $this->comunica->m_datos_antiguosTpl = $m_datosAnt;
            $this->reset();
        }
    }
currentTupla ( parametroOperacion = '')

currentTupla Este mtodo devuelve el registro activo sobre el origen de datos actual (cursor)

public

Parámetros:
$parametroOperacionel tipo de operacin, si no se indica se coge el fijado para la instancia
Devuelve:
array

Definición en la línea 174 del archivo IgepComunicaUsuario.php.

                                                             {
        
                return $this->comunica->currentTupla($parametroOperacion);
        }
fetchTupla ( parametroOperacion = '')

fetchTupla devuelve el registro/tupla correspondiente y avanza la posicin del cursor sobre el origen de datos

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 297 del archivo IgepComunicaUsuario.php.

                                                           {
        
                return $this->comunica->fetchTupla($parametroOperacion);
        }
getAllOldTuplas ( parametroOperacion = '')

Definición en la línea 347 del archivo IgepComunicaUsuario.php.

                                                                {

                return $this->comunica->getAllTuplasAntiguas($parametroOperacion);
        }
getAllTuplas ( parametroOperacion = '')

getAllTuplas obtiene la matriz de registros correspondiente al origen de datos pasado como argumento o prestablecido

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 328 del archivo IgepComunicaUsuario.php.

                                                             {
                
                return $this->comunica->getAllTuplas($parametroOperacion);
        }
getAllTuplasAntiguas ( parametroOperacion = '')

getAllTuplasAntiguas obtiene la matriz de registros original correspondiente al origen de datos pasado como argumento o prestablecido

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 342 del archivo IgepComunicaUsuario.php.

                                                                     {

                return $this->comunica->getAllTuplasAntiguas($parametroOperacion);
        }
getFileInfo ( nombreCampo,
pametroOperacion = '' 
)

getFileInfo metodo que devuelve para una tupla dada la informacin de un campo de tipo 'FILE' que se ha subido al servidor.

Parámetros:
stringnombreCampo Nombre del campo FILE del que se quiere obtener la informacin
stringparametroOperacion Indica la operacin sobre la que se quiere la tupla
Devuelve:
array

Definición en la línea 442 del archivo IgepComunicaUsuario.php.

                                                                 {

                return $this->comunica->getFileInfo($nombreCampo, $pametroOperacion);
        }
getForward ( name)

getForward este mtodo permite recuperar un actionForward (un destino). Esto permite cambiar el destino de una accion.

public

Parámetros:
string$nameidentificador del actionForward que se quiere recuperar.
Devuelve:
actionForward

Reimplementado en IgepComunicaIU.

Definición en la línea 549 del archivo IgepComunicaUsuario.php.

                                          {

                $fordward = $this->comunica->getForward($name);
                if(empty($fordward))
                        die('Error: no existe el retorno '.$name.', consulte el fichero de mapeo.');
                
                return $fordward; 
        }        
getIndice ( parametroOperacion = '')

getIndice Devuelve el valor del indice del cursor sobre el origen de datos actual

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
integer

Definición en la línea 161 del archivo IgepComunicaUsuario.php.

                                                          {

                return $this->comunica->getIndice($parametroOperacion);
        } 
getLista ( nombreCampo,
parametroOperacion = '' 
)

getLista obtiene la estructura de la lista

public

Parámetros:
$nombreCamponombre del campo de la lista.
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar).
Devuelve:
_IgepEstructuraLista

Definición en la línea 388 del archivo IgepComunicaUsuario.php.

                                                                      {

                //Comprobamos si es una lista
                if(get_class($this->listasPanel[$nombreCampo])!='gvHidraList')
                        return null;

                $objLista = & $this->listasPanel[$nombreCampo];
                //Recogemos el valor del campo
                $valorSeleccionado = $this->getValue($nombreCampo, $parametroOperacion);

                //Montamos la lista
                //Si no tiene dependencia cogemos el valor de camposPreInsertados
                if(!$objLista->hayDependencia()) {      
                        
                        $listaResultado = $this->datosPreinsertados[$nombreCampo];
                }
                else {

                        //Tenemos que construir la dependencia
                        $tupla = $this->comunica->currentTupla($parametroOperacion);
                        $listaResultado = $objLista->construyeLista($tupla);
                }

                $listaResultado['seleccionado'] = $valorSeleccionado;
                //Modificar aqui
                $objListaStruc = new _IgepEstructuraLista($listaResultado); 

                return $objListaStruc;  
        }
getOldValue ( nombreCampo)

getOldValue devuelve el valor antiguo del campo indicado como prametro del registro activo

public

Parámetros:
string$nombreCampoNombre del campo
Devuelve:
mixed

Definición en la línea 202 del archivo IgepComunicaUsuario.php.

                                                  {
                
                return $this->comunica->getOldValue($nombreCampo);
        }
getOperacion ( )

getOperacion Permite cual es el origen de los datos actual

public

Devuelve:
string

Definición en la línea 148 del archivo IgepComunicaUsuario.php.

                                       {

                return $this->comunica->getOperacion();
        }
getValue ( nombreCampo,
parametroOperacion = '' 
)

getValue devuelve el campo indicado como prametro del registro activo sobre el origen de datos actual (cursor)

public

Parámetros:
string$nombreCampoNombre del campo
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 189 del archivo IgepComunicaUsuario.php.

                                                                       {

                return $this->comunica->getCampo($nombreCampo, $parametroOperacion);
        }
hayDatos ( parametroOperacion = '')

hayDatos indica si el origen de datos prestablecido

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 374 del archivo IgepComunicaUsuario.php.

                                                         {

                return $this->comunica->hayDatos($parametroOperacion);
        }
isChecked ( name,
parametroOperacion = '' 
)

isChecked mtodo que permite saber si un check esta marcado o no

Parámetros:
stringname nombre del check
stringoperacion Operacion sobre la que se quiere actuar
Devuelve:
boolean

Definición en la línea 246 del archivo IgepComunicaUsuario.php.

                                                                 {

                //Devolvemos true o false dependiendo del valor del check
                $value = $this->comunica->getCampo($name, $parametroOperacion);
                $desc = $this->comunica->descCampoPanel[$name];
                ($value==$desc['valueChecked'])?$result = true: $result = false;
                
                return $result; 
        }
nextTupla ( parametroOperacion = '')

nextTupla Avanza la posicin del cursor sobre el origen de datos actual (cursor) y devuelve el registro/tupla correspondiente

public

Parámetros:
string$nombreCampoNombre del campo
string$valorCampoValor del campo
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 283 del archivo IgepComunicaUsuario.php.

                                                          {

                return $this->comunica->nextTupla($parametroOperacion);
        }
static prepararPresentacion ( &$  a_parametros,
a_tipo,
a_decimales = '2' 
) [static]

prepararPresentacion este mtodo prepara los datos que vienen de estado FW y los pasa a estado presentacin Devuelve el resultado por referencia y como valor de retorno.

public

Parámetros:
any$a_parametros
any$a_tipo
any$a_decimales,:usado cuando convertimos valor individual
Devuelve:
mixed

Definición en la línea 495 del archivo IgepComunicaUsuario.php.

                                                                                            {                

                if($a_decimales==='')
                        $a_decimales='2';
                
                if (!is_array($a_parametros) and $a_parametros!=='' and $a_tipo!='') {
                        // le doy estructura de vector para no repetir el codigo
                        $vector = false;
                        $a_parametros = array(array('col'=>$a_parametros,),);
                        $a_tipo = array('col'=>array('tipo'=>$a_tipo, 'parteDecimal'=>$a_decimales),);
                } else
                        $vector = true;         
                if (is_array($a_tipo)) {
                        $transformer = new IgepTransformer();
                        $carfw = ConfigFramework::getNumericSeparatorsFW();
                        $caruser = ConfigFramework::getNumericSeparatorsUser();
                        $transformer->setDecimal($carfw['DECIMAL'],$caruser['DECIMAL'],$carfw['GROUP'],$caruser['GROUP']);
                        
                        $fechafw = ConfigFramework::getDateMaskFW();
                        $fechauser = ConfigFramework::getDateMaskUser();        
                        $transformer->setDate($fechafw,$fechauser);

                        foreach($a_parametros as $fila => $tupla)
                                foreach($a_tipo as $campo => $descTipo)
                                        if (isset($tupla[$campo])) {
                                                $tipo_efectivo = (empty($descTipo['tipo'])? TIPO_CARACTER: ($descTipo['tipo']==TIPO_ENTERO? TIPO_DECIMAL: $descTipo['tipo']));
                                                if ($tipo_efectivo == TIPO_DECIMAL)
                                                        $a_parametros[$fila][$campo] = $transformer->expandExponent($a_parametros[$fila][$campo], $carfw['DECIMAL'], $carfw['GROUP']);
                                                if ($descTipo['tipo'] == TIPO_DECIMAL)
                                                        $a_parametros[$fila][$campo] = $transformer->decimalPad($a_parametros[$fila][$campo], $descTipo['parteDecimal']);

                                                if(empty($a_parametros[$fila][$campo]))
                                                        continue;
                                                elseif (($tipo_efectivo == TIPO_FECHA or $tipo_efectivo == TIPO_FECHAHORA) and is_object($a_parametros[$fila][$campo]))
                                                        $a_parametros[$fila][$campo] = $a_parametros[$fila][$campo]->format($fechauser.($tipo_efectivo==TIPO_FECHAHORA? ' H:i:s':''));
                                                else
                                                        $a_parametros[$fila][$campo] = $transformer->process($tipo_efectivo, $a_parametros[$fila][$campo]);
                                        }
                }
        if (!$vector)
                $a_parametros = $a_parametros[0]['col'];
        
        return $a_parametros;
    }
reset ( parametroOperacion = '')

reset reinicializa el acceso a datos

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
none

Definición en la línea 108 del archivo IgepComunicaUsuario.php.

                                                      {

                $this->comunica->reset($parametroOperacion);
        }
setAllTuplas ( vTuplas,
parametroOperacion = '' 
)

setAllTuplas establece obtiene la matriz de registros correspondiente al origen de datos pasado como argumento o prestablecido

public

Parámetros:
matriz$vTuplasConjunto de tuplas/registros a asignar
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Definición en la línea 361 del archivo IgepComunicaUsuario.php.

                                                                       {
        
                return $this->comunica->setAllTuplas($vTuplas, $parametroOperacion);
        }
setChecked ( name,
check,
parametroOperacion = '' 
)

setChecked mtodo que permite modificar el valor del un check.

Parámetros:
stringname nombre del check
booleancheck Checked si o no
stringoperacion Operacion sobre la que se quiere actuar
Devuelve:
none

Reimplementado en IgepComunicaIU.

Definición en la línea 230 del archivo IgepComunicaUsuario.php.

                                                                          {

                //Seleccionamos el valor dependiendo si esta seleccionado
                $desc = $this->comunica->descCampoPanel[$name];
                ($check)?$value=$desc['valueChecked']:$value=$desc['valueUnchecked'];
                
                return $this->comunica->setCampo($name, $value, $parametroOperacion);   
        }
setIndice ( indice)

setIndice Cuando se trabaja con un conjunto de fichas mltiple, se utiliza para fijar la fila (registro/tupla del conjunto) sobre la que estamos trabajando, por defecto, es la ficha que se est visializando (esta activa)

public

Parámetros:
integer$indiceIndice de 0..nRegs que indica la tuplas
Devuelve:
none

Definición en la línea 136 del archivo IgepComunicaUsuario.php.

                                           {    

                $this->comunica->int_filaActual = $indice;      
        }
setLista ( nombreCampo,
objListaStruc,
parametroOperacion = '' 
)

setLista fija el contenido de una lista

public

Parámetros:
$nombreCamponombre del campo de la lista.
$objListaStrucestructura de la lista
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar).
Devuelve:
none

Reimplementado en IgepComunicaIU.

Definición en la línea 428 del archivo IgepComunicaUsuario.php.

                                                                                        {

                $v_lista = $objListaStruc->getEstructuraListaIgep();
                $this->comunica->setLista($nombreCampo, $v_lista, $parametroOperacion);         
        }
setOperacion ( parametroOperacion)

setOperacion Fija la operacin que va a ser origen de los datos

public

Parámetros:
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
none

Definición en la línea 121 del archivo IgepComunicaUsuario.php.

                                                          {
                
                $this->comunica->setOperacion($parametroOperacion);             
        }
setRowColor ( &$  row,
color 
)

Mtodo que dada una tupla, fija el color para poder ser representado en una tabla de gvHidra

Parámetros:
arrayrow tupla a la que se le quiere dar color.
stringcolor color que se le va a dar a la tupla.
Devuelve:
none

Definición en la línea 455 del archivo IgepComunicaUsuario.php.

                                                 {
                
                if(!is_array($row))
                        die('setColorRow_Error: el parmetro row no es un array');
                $row['__gvHidraRowColor'] = $color;
        }
setSelected ( nombreCampo,
valorCampo,
parametroOperacion = '' 
)

setSelected fija el valor de una lista

public

Parámetros:
string$nombreCampoNombre del campo
string$valorCampoValor del campo
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Reimplementado en IgepComunicaIU.

Definición en la línea 217 del archivo IgepComunicaUsuario.php.

                                                                                       {
        
                return $this->comunica->setCampo($nombreCampo, $valorCampo, $parametroOperacion);
        }
setTupla ( tupla,
parametroOperacion = '' 
)

setTupla sustituye el registro actual de la fuente de datos prestablecida por el registro/tupla (array asociativo) pasado como parmetro

public

Parámetros:
string$nombreCampoNombre del campo
string$valorCampoValor del campo
$parametroOperacionel tipo de operacin, si no se indica se coge el fijado para la instancia
Devuelve:
mixed

Definición en la línea 314 del archivo IgepComunicaUsuario.php.

                                                                 {

                return $this->comunica->setTupla($tupla, $parametroOperacion);
        }
setValue ( nombreCampo,
valorCampo,
parametroOperacion = '' 
)

setValue fija el valor pasado como parmetro sobre el campo indicado como prametro del registro activo sobre el origen de datos actual (cursor)

public

Parámetros:
string$nombreCampoNombre del campo
string$valorCampoValor del campo
$parametroOperacionOrigen de datos (datos para insertar, para modificar, para borrar)
Devuelve:
mixed

Reimplementado en IgepComunicaIU.

Definición en la línea 267 del archivo IgepComunicaUsuario.php.

                                                                                    {

                return $this->comunica->setCampo($nombreCampo, $valorCampo, $parametroOperacion);
        }

Documentación de los campos

$comunica

Definición en la línea 62 del archivo IgepComunicaUsuario.php.

$datosPreinsertados

Definición en la línea 69 del archivo IgepComunicaUsuario.php.

$listasPanel

Definición en la línea 76 del archivo IgepComunicaUsuario.php.

$obj_mensaje = null

Definición en la línea 83 del archivo IgepComunicaUsuario.php.


La documentación para esta clase fue generada a partir del siguiente fichero: