Class IgepSession

Description

IgepSession es una clase que enmascara el acceso a la Session de Igep. Con ella conseguimos que el acceso a la SESSION sea ordenado y no se produzcan conflictos entre los diferentes paneles que almacenan valores en ella.

Es importante tener en cuenta cual es el uso que se debe dar de la SESSION por parte de los programadores:

  • El más habitual es consultar, dentro de una clase manejadora de un panel (las clases ubicadas en action), el valor de cierto campo, atributo, tupla seleccionada,... Para ello se puede hacer uso de los métodos de consulta de esta clase. Notese que en este caso NUNCA se deberá almacenar valores en la SESSION, ya que si se quiere almacenar valores se deben de almacenar como variables de clase e Igep, internamente, ya se encargará de almacenarlos en la SESSION.
  • Otro uso, menos habitual, pero que puede requerirse es el de crear una instancia de una clase manejadora de un panel desde otra clase manejadora. En este caso los encargados de almacenar los valores en la SESSION serán los programadores. Por esta razón se proporcionan métodos para almacenar valores.

Located in /include/IgepSession.php (line 60)

ComunSession
   |
   --IgepSession
Method Summary
static void anyadeModuloValor (string $nomModulo, [array $valor = null], [ $descripcion = null])
static none borraMensaje (string $clasePanel)
static void borraPanel (string $clasePanel)
static void borraVariable (string $clasePanel, string $variable)
static void clear ()
static string dameCampoTuplaSeleccionada (string $clasePanel, string $campo)
static integer dameFilaActual (string $clasePanel)
static IgepMensaje dameMensaje (string $clasePanel)
static array dameModuloDinamico (string $nomModulo)
static array dameModulos ()
static void damePanel (string $clasePanel)
static array dameTuplaSeleccionada (string $clasePanel)
static array dameUltimaConsulta (string $clasePanel)
static array dameUltimaEdicion (string $clasePanel)
static any dameVariable (string $clasePanel, string $variable)
static any dameVariableGlobal (string $nomVariable)
static integer existeMensaje (string $clasePanel)
static bool existePanel (string $clasePanel)
static bool existeVariable (string $clasePanel, string $variable)
static void guardaMensaje (string $clasePanel, object $mensaje)
static integer guardaPanel (string $clasePanel, object $objeto)
static void guardaVariable (string $clasePanel, string $nombreVar, mixed $valor)
static void guardaVariableGlobal (string $nombreVar, mixed $valor, string $clasePanel)
static bool hayModulo (string $nomModulo)
static bool hayModuloDinamico (string $nomModulo)
static void quitaModuloValor (string $nomModulo, [array $valor = null])
static void session_start ([string $app = null], [ $start = true])
static void _borrarPanelesVisitados ()
static none _marcarPanelVisitado (nombrePanel $nombrePanel)
Methods
static method anyadeModuloValor (line 418)

Añade el módulo $nomModulo dinámicamente,

el segundo parámetro, $valor es opcional, si se utiliza, se añadira el $valor, al registro de valores del modulo

  • access: public
static void anyadeModuloValor (string $nomModulo, [array $valor = null], [ $descripcion = null])
  • array $valor
  • string $nomModulo: nomModulo
  • $descripcion
static method borraMensaje (line 318)

Método que borra un panel de la SESSION

static none borraMensaje (string $clasePanel)
  • string $clasePanel
static method borraPanel (line 136)

Borra de la SESSION la posición correspondiente a un Panel

  • access: public
static void borraPanel (string $clasePanel)
  • string $clasePanel
static method borraVariable (line 376)

Borra la referencia a una variable de un Panel en la SESSION.

  • access: public
static void borraVariable (string $clasePanel, string $variable)
  • string $clasePanel
  • string $variable
static method clear (line 125)

Borra de la SESSION la toda la informacion de la aplicación Se llama en el inicio de la aplicación.

  • access: public
static void clear ()
static method dameCampoTuplaSeleccionada (line 261)

Devuelve el valor de un campo de la tupla seleccionada de la última consulta.

  • access: public
static string dameCampoTuplaSeleccionada (string $clasePanel, string $campo)
  • string $clasePanel
  • string $campo
static method dameFilaActual (line 194)

Devuelve el índice de la tupla actualmente seleccionada en el panel. Este índice hace referencia a la posición dentro del array de resultados.

Si no está activo el indice es porque la posición actual es 0.

  • access: public
static integer dameFilaActual (string $clasePanel)
  • string $clasePanel
static method dameMensaje (line 308)

Método que devuelve el mensaje de un panel almacenado en la SESSION

static IgepMensaje dameMensaje (string $clasePanel)
  • string $clasePanel
static method dameModuloDinamico (line 519)

Devuelve el array con los valores de un módulo Dinámico

concreto para la aplicación actual. Si no existe retorna -1

  • access: public
static array dameModuloDinamico (string $nomModulo)
  • string $nomModulo: nomModulo
static method dameModulos (line 504)

Sobrecarga el método de la clase padre, devolviendo un array formado por los móodulos dinámicos y los modulos concedidos para un usuario y para la aplicación actual, información que preoviene de comun.

  • access: public
static array dameModulos ()

Redefinition of:
ComunSession::dameModulos()
Devuelve el array con todos los modulos concedidos para un usuario y para la aplicación actual.
static method damePanel (line 147)

Devuelve el contenido de un panel

  • access: public
static void damePanel (string $clasePanel)
  • string $clasePanel
static method dameTuplaSeleccionada (line 243)

Devuelve un array con la tupla seleccionada de la última consulta.

  • access: public
static array dameTuplaSeleccionada (string $clasePanel)
  • string $clasePanel
static method dameUltimaConsulta (line 211)

Devuelve el array de resultados correspondiente a la última consulta. Es importante tener en cuenta que este array procede de la consulta realizada con la Select introducida en la variable $str_select. Esta consulta se lanza con el proceso buscar de Igep.

  • access: public
static array dameUltimaConsulta (string $clasePanel)
  • string $clasePanel
static method dameUltimaEdicion (line 228)

Devuelve el array de resultados correspondiente a la última edición. Es importante tener en cuenta que este array procede de la consulta realizada con la Select introducida en las variable $str_selectEditar. Esta consulta se lanza con el proceso editar de Igep.

  • access: public
static array dameUltimaEdicion (string $clasePanel)
  • string $clasePanel
static method dameVariable (line 346)

Devuelve el valor de una variable de un Panel contenido en la SESSION.

  • access: public
static any dameVariable (string $clasePanel, string $variable)
  • string $clasePanel
  • string $variable
static method dameVariableGlobal (line 360)

Devuelve el valor de una variable ubiucada en la zona global de la SESSION.

  • access: public
static any dameVariableGlobal (string $nomVariable)
  • string $nomVariable
static method existeMensaje (line 298)

Método que indice si existe el panel en la SESSION

static integer existeMensaje (string $clasePanel)
  • string $clasePanel
static method existePanel (line 74)

Comprueba si existe en la SESSION un objeto Panel

  • access: public
static bool existePanel (string $clasePanel)
  • string $clasePanel
static method existeVariable (line 333)

Comprueba si existe en la SESSION alguna variable particular dentro de la definición de un Panel.

  • access: public
static bool existeVariable (string $clasePanel, string $variable)
  • string $clasePanel
  • string $variable
static method guardaMensaje (line 286)

Almacena en la SESSION un mensaje. Este método enmascara la inserción de mensajes en la clase, ya que se encarga de comprobar que el objeto que recibe es un objeto de la clase IgepMensaje y realiza la asignación a la variable de gvHidraForm_DB destinada para el mensaje de los paneles, obj_mensaje. Si no cumple las condiciones requeridas no se realiza la asignación.

  • access: public
static void guardaMensaje (string $clasePanel, object $mensaje)
  • string $clasePanel
  • object $mensaje
static method guardaPanel (line 161)

Almacena en la SESSION un objeto Panel. Comprueba que el objeto coincida con la clase adecuada.

Si todo va bien devuelve 1 indicando que la operación se ha realizado con exito. De lo contrario retorna -1.

  • access: public
static integer guardaPanel (string $clasePanel, object $objeto)
  • string $clasePanel
  • object $objeto
static method guardaVariable (line 389)

Almacena en la SESSION el valor de una variable de un Panel

  • access: public
static void guardaVariable (string $clasePanel, string $nombreVar, mixed $valor)
  • string $clasePanel
  • string $nombreVar
  • mixed $valor
static method guardaVariableGlobal (line 403)

Almacena en la zona de la SESSION global el valor de una variable

  • access: public
static void guardaVariableGlobal (string $nombreVar, mixed $valor, string $clasePanel)
  • string $clasePanel
  • string $nombreVar
  • mixed $valor
static method hayModulo (line 462)

Sobrecarga la funcion de la clase padre, devuelve true siempre que existan módulos, sean o no dinamicos cierto módulo para la aplicación actual.

  • access: public
static bool hayModulo (string $nomModulo)
  • string $nomModulo: nomModulo

Redefinition of:
ComunSession::hayModulo()
Comprueba si el usuario al que pertenece la SESSION tiene concedido cierto módulo para la aplicación actual.
static method hayModuloDinamico (line 479)

Comprueba si el usuario al que pertenece la SESSION tiene concedido cierto módulo para la aplicación actual.

  • access: public
static bool hayModuloDinamico (string $nomModulo)
  • string $nomModulo: nomModulo
static method quitaModuloValor (line 437)

Quita el módulo $nomModulo dinámicamente,

el segundo parámetro, $valor es opcional, si aparece, se elimina el el módulo siempre que coincida el valor que tenía asignado con el valor previmanete registrado

  • access: public
static void quitaModuloValor (string $nomModulo, [array $valor = null])
  • array $valor
  • string $nomModulo: nomModulo
static method session_start (line 85)

Inicia la sesion de php, inicializando previamente todo lo necesario

  • access: public
static void session_start ([string $app = null], [ $start = true])
  • string $app: codigo de la aplicación
  • $start
static method _borrarPanelesVisitados (line 543)
static void _borrarPanelesVisitados ()
static method _marcarPanelVisitado (line 533)

Este método agrega un panel a la lista de paneles visitados

static none _marcarPanelVisitado (nombrePanel $nombrePanel)
  • nombrePanel $nombrePanel: nombre que identifica al panel (claseManejadora)
dameModulosDinamicos (line 492)

Devuelve el array con todos los modulos concedidos para un usuario y para la aplicación actual.

  • access: public
array dameModulosDinamicos ()

Inherited Methods

Inherited From ComunSession

ComunSession::borraAplicacion()
ComunSession::dameAplicacion()
ComunSession::dameBaseDatos()
ComunSession::dameDatosAplicacion()
ComunSession::dameDatosUsuario()
ComunSession::dameModulo()
ComunSession::dameModulos()
ComunSession::dameParam1()
ComunSession::dameParam2()
ComunSession::dameParam3()
ComunSession::dameRol()
ComunSession::dameServidor()
ComunSession::dameUsuario()
ComunSession::existeAplicacion()
ComunSession::hayModulo()

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