Class IgepComunicacion

Description

IgepComunicacion es una clase que se encarga de recoger los datos que vienen de la presentación a través de POST o GET del formulario que ha realizado el submit. Estos datos se almacenan en varios repositorios dependiendo de la operación a la que se vayan a destinar (inserción, actualización o borrado). Posteriormente, las clases interesadas podrán recuperar estos datos por los métodos habilitados a tal efecto.

La clase proporciona dos tipos de acceso a la información: por cursor o por matriz. El primero de ellos devuelve una tupla por cada una de las solicitudes del programador. El segundo devuelve la matriz completa con todas las tuplas que intervienen en la operación.

Toda esta información vendrá en un formato adaptado para el programador, es decir los nombres de los campos de la matriz serán los que corresponden a los componentes de la Tpl. De este modo el acceso a la información se realizará de una forma uniforme para todos los métodos del programador.

La información a la que puede tener acceso el programador corresponde a las siguientes operaciones básicas:

    Located in /include/IgepComunicacion.php (line 66)

    
    	
    			
    Variable Summary
    Method Summary
    static void transform_User2FW ( &$a_parametros, [ $a_tipo = TIPO_CARACTER])
    IgepComunicacion IgepComunicacion ([ $descCampoPanel = ""], array $matching)
    void construirArrayFocusChanged ( $actionForm)
    void construirArrayOrdenarTabla ( $actionForm)
    matriz currentTupla ([ $parametroOperacion = ''])
    void damePanelActivo ()
    none data2Arrays ()
    matriz fetchTupla ([ $parametroOperacion = ''])
    mixed getAllTuplas ([string $parametroOperacion = ''])
    void getAllTuplasAntiguas ([ $parametroOperacion = ''])
    void getCampo ( $nombreCampo, [ $parametroOperacion = ''])
    void getForward ( $name)
    integer getIndice ([ $parametroOperacion = ''])
    string getOldValue ( $nombreCampo)
    string getOperacion ()
    void hayDatos ([ $parametroOperacion = ''])
    boolean nextTupla ([ $parametroOperacion = ''])
    none reset ([ $parametroOperacion = ''])
    void setAllTuplas ( $vTuplas, [ $parametroOperacion = ''])
    void setArrayOperacion ( $m_datos)
    void setCampo ( $nombreCampo,  $valorCampo, [ $parametroOperacion = ''])
    void setLista ( $nombreCampo,  $v_lista, [ $parametroOperacion = ''])
    void setMapping ( $actionMapping)
    none setOperacion ( $parametroOperacion)
    void setTupla ( $tupla, [ $str_operacion = ''])
    void _getPosicionRegistroPantalla ( $nombreCampoEnTpl)
    void _setAllTuplasAntiguas ( $vTuplas, [ $parametroOperacion = ''])
    Variables
    array $descCampoPanel (line 102)

    Array de definición de los campos que aparecen en un panel

    • var: desCampoPanel
    integer $int_filaSeleccionada (line 81)

    Entero referencia a la fila actual

    • var: int_filaSeleccionada
    array $m_datosCamposDependientes (line 73)

    matriz de datos relativos a los campos Dependientes o Calculados

    • var: m_datosCamposDependientes
    array $m_datosFicherosUpLoad (line 160)

    Array que contiene los datos de los ficheros que se han subido por Upload

    • var: m_datosFicherosUpLoad
    array $m_datosVentanaSeleccion (line 88)

    matriz de datos relativos a la ventana de Seleccion

    • var: m_datosVentanaSeleccion
    array $m_datos_actualizarTpl (line 116)

    Array que contiene un conjunto de punteros que recrean los datos modificados en la tpl

    • var: m_datos_actualizarTpl
    array $m_datos_borrarTpl (line 123)

    Array que contiene un conjunto de punteros que recrean los datos borrados en la tpl

    • var: m_datos_borrarTpl
    array $m_datos_buscarTpl (line 153)

    Array que contiene los datos del panel de busqueda en el formato TPL

    • var: m_datos_buscarTpl
    mixed $m_datos_iniciarVentanaTpl (line 162)
    array $m_datos_insertarTpl (line 109)

    Array que contiene un conjunto de punteros que recrean los datos insertados en la tpl

    • var: m_datos_insertarTpl
    array $m_datos_postConsultarTpl (line 137)

    Array que contiene un conjunto de punteros que recrean los datos a ser editados en la tpl

    • var: m_datos_postConsultarTpl
    array $m_datos_seleccionarPadreTpl (line 146)

    Array que contiene un conjunto de punteros que recrean los datos seleccionados del padre en el método recargar. Se gasta para almacenar la tupla seleccionada por el padre para que el programador tenga acceso a esta información.

    • var: m_datos_seleccionarPadreTpl
    array $m_datos_seleccionarTpl (line 130)

    Array que contiene un conjunto de punteros que recrean los datos a ser editados en la tpl

    • var: m_datos_seleccionarTpl
    array $m_datos_visiblesTpl (line 95)

    matriz de datos visibles en el panel. Es decir que capturamos todo lo que se vea independientemente de si se les ha practicado algun cambio o no.

    • var: m_datosVisbles
    Methods
    static method transform_User2FW (line 1257)
    • access: public
    static void transform_User2FW ( &$a_parametros, [ $a_tipo = TIPO_CARACTER])
    • &$a_parametros
    • $a_tipo
    Constructor IgepComunicacion (line 182)

    Constructor. Recibe como parámetro el matching con el que trabajará el objeto

    • access: public
    IgepComunicacion IgepComunicacion ([ $descCampoPanel = ""], array $matching)
    • array $matching
    • $descCampoPanel
    checkDataTypes (line 587)

    Esta funcion se encargará de realizar la validación de los datos en el servidor antes de realizar una operación de inserción o actualización en la BD Si ha habido errores previamente en la transformacion, estan en ConfigFramework

    • return: Devuelve 0 si no hay errores y un string con el error en caso de error.
    • access: public
    any checkDataTypes ()
    construirArrayBorrar (line 405)

    Construye el array de datos a Borrar y el de datos Antiguos para realizar las operaciones de DELETE correspondientes.

    • access: public
    integer construirArrayBorrar ()
    construirArrayBuscar (line 462)
    • access: public
    void construirArrayBuscar ()
    construirArrayFocusChanged (line 524)
    void construirArrayFocusChanged ( $actionForm)
    • $actionForm
    construirArrayIniciarVentana (line 488)

    Carga los datos al iniciar la ventana. No tiene m_datos normal porque ningún campo puede tener matching

    void construirArrayIniciarVentana ()
    construirArrayOrdenarTabla (line 518)
    void construirArrayOrdenarTabla ( $actionForm)
    • $actionForm
    construirArraySeleccionar (line 361)

    Construye únicamente el array de Seleccionados. En este caso es importante tener en cuenta si se venimos de un panel Ficha o Tabla. Esto se debe a que la forma de marcar la fila seleccionada es diferente de uno a otro (la tabla permite los checks).

    • access: public
    integer construirArraySeleccionar ()
    currentTupla (line 952)

    Este método devuelve una matriz con los campos que aparecen en la tpl para la tupla actual dentro del cursor de la operacion. No avanza la posiccion en el cursor.

    • access: public
    matriz currentTupla ([ $parametroOperacion = ''])
    • $parametroOperacion
    damePanelActivo (line 678)
    void damePanelActivo ()
    data2Arrays (line 198)

    Recupera los datos de pantalla y los almacena en estructuras conocidas por el Framework.

    Esto permite un acceso coherente a los datos por parte del programador y del propio sistema.

    • access: public
    none data2Arrays ()
    fetchTupla (line 1021)

    Este método devuelve una matriz con los campos que aparecen en la tpl para la tupla actual dentro del cursor de la operacion y avanza a la siguiente posición del cursor.

    • access: public
    matriz fetchTupla ([ $parametroOperacion = ''])
    • $parametroOperacion
    getAllTuplas (line 1076)

    getAllTuplas metodo que devuelve la matriz de datos de la operación activa.

    • access: public
    mixed getAllTuplas ([string $parametroOperacion = ''])
    • string $parametroOperacion: indica la operacion de la que se quiere obtener la matriz, no es obligatorio
    getAllTuplasAntiguas (line 1140)

    Este método devuelve todas las tuplas de antiguas para una operacion dada.

    void getAllTuplasAntiguas ([ $parametroOperacion = ''])
    • $parametroOperacion
    getCampo (line 973)
    void getCampo ( $nombreCampo, [ $parametroOperacion = ''])
    • $nombreCampo
    • $parametroOperacion
    getForward (line 1252)
    void getForward ( $name)
    • $name
    getIndice (line 877)

    Este método devuelve el valor del indice del cursor sobre la operación.

    • access: public
    integer getIndice ([ $parametroOperacion = ''])
    • $parametroOperacion
    getOldValue (line 994)

    Este método devuelve el valor antiguo de una campo para la operacion activa.

    • access: public
    string getOldValue ( $nombreCampo)
    • $nombreCampo
    getOperacion (line 866)

    Este método permite el acceso a la propiedad interna que indica la operación actual.

    • access: public
    string getOperacion ()
    hayDatos (line 1222)
    void hayDatos ([ $parametroOperacion = ''])
    • $parametroOperacion
    nextTupla (line 1039)

    Este método avanza a la siguiente posición del cursor y devuelve verdadero si quedan tuplas/registros en el cursor, y falso cuando se llega al final

    • access: public
    boolean nextTupla ([ $parametroOperacion = ''])
    • $parametroOperacion
    reset (line 818)

    Este método se encarga de inicializar el indice del cursor que pertenece a la operación.

    • access: public
    none reset ([ $parametroOperacion = ''])
    • $parametroOperacion
    setAllTuplas (line 1156)
    void setAllTuplas ( $vTuplas, [ $parametroOperacion = ''])
    • $vTuplas
    • $parametroOperacion
    setArrayOperacion (line 851)
    void setArrayOperacion ( $m_datos)
    • $m_datos
    setCampo (line 999)
    void setCampo ( $nombreCampo,  $valorCampo, [ $parametroOperacion = ''])
    • $nombreCampo
    • $valorCampo
    • $parametroOperacion
    setLista (line 1209)
    void setLista ( $nombreCampo,  $v_lista, [ $parametroOperacion = ''])
    • $nombreCampo
    • $v_lista
    • $parametroOperacion
    setMapping (line 1248)
    void setMapping ( $actionMapping)
    setOperacion (line 844)

    Este método indica a la instancia cual es la operación en curso e inicializa el indice del cursor de dicha operación. La operación en curso se utilizará siempre que no se especifique como parámetro para el resto de métodos. OJO: Falta dar una lista clara de las operaciones para el usuario (internas puede haber más)

    • access: public
    none setOperacion ( $parametroOperacion)
    • $parametroOperacion
    setTupla (line 1049)
    void setTupla ( $tupla, [ $str_operacion = ''])
    • $tupla
    • $str_operacion
    _getPosicionRegistroPantalla (line 446)
    void _getPosicionRegistroPantalla ( $nombreCampoEnTpl)
    • $nombreCampoEnTpl
    _setAllTuplasAntiguas (line 1192)

    Este método guarda todas las tuplas de antiguas.

    void _setAllTuplasAntiguas ( $vTuplas, [ $parametroOperacion = ''])
    • $vTuplas
    • $parametroOperacion

    Documentation generated on Wed, 05 Oct 2011 10:36:32 +0200 by phpDocumentor 1.4.1