Class ConfigFramework

Description

Clase destinada a configurar parámetros de FrameWork gvHidra.

La clase servirá de base para la configuración de la organización (CUSTOM) Está estructurada como un patrón SINGLETON con persistencia funcional en SESION.

Located in /ConfigFramework.php (line 41)


	
			
Method Summary
static string getApplicationName ()
static void getConfig ()
static void getCustomDirName ()
static string getDateMaskFW ()
static string getDateMaskUser ()
static array getNumericSeparatorsFW ()
static array getNumericSeparatorsUser ()
static void getTemporalDir ()
static string getTimeMask ()
static void getTransformErrors ()
static void setTransformErrors ( $lis)
void __destruct ()
string getAppVersion ()
string getCustomTitle ()
string getDefList (string $key)
array getDefVS (string $key)
array getDSN (string $key)
array getDSNLog ()
string getgvHidraVersion ()
array getListKeys ( $key)
void getLogStatus ()
void getQueryMode ()
array getVSKeys ()
void setAppVersion (string $appVersion)
void setCustomTitle (string $customTitle)
none setDSN (string $key, string $vdsn)
none setList_ClassSource (string $key, string $class)
none setList_DBSource (string $key, string $query)
void setLogConnection ( $connection)
void setLogStatus (string $status)
void setQueryMode (string $mode)
void setReloadMappings (string $mode)
none setSelectionWindow_ClassSource (string $key, string $class)
none setSelectionWindow_DBSource (string $key, string $query, [array $fields = null])
void setTemplatesCompilationDir (string $dir)
Methods
static method getApplicationName (line 263)

getApplicationName:: Devuelve el nombre de la aplicación actual

  • return: Nombre de la aplicación
  • access: public
static string getApplicationName ()
static method getConfig (line 182)
  • access: public
static void getConfig ()
static method getCustomDirName (line 232)

getCustomDirName:: Devuelve el nombre del subdirectorio de CUSTOM actual

Devuelve el directorio que contiene la información de custom

  • access: public
static void getCustomDirName ()
static method getDateMaskFW (line 939)

getDateMaskFW: devuelve el formato de fechas que utilizará en FW.

Este formato coincidirá con el formato PHP

static string getDateMaskFW ()
static method getDateMaskUser (line 949)

getDateMaskUser: devuelve la mascara de representacion de fechas de pantalla

static string getDateMaskUser ()
static method getNumericSeparatorsFW (line 919)

getNumericSeparatorsFW: devuelve el formato numérico que utilizará en FW.

Este formato coincidirá con el formato PHP

static array getNumericSeparatorsFW ()
static method getNumericSeparatorsUser (line 929)

getNumericSeparatorsUser: devuelve el formato numérico que utilizará el usuario en pantalla.

static array getNumericSeparatorsUser ()
static method getTemporalDir (line 456)

getTemporalDir: Devuelve la ruta del directorio temporal del FW

Devuelve la ruta del directorio temporal del FW. Si no existe la instancia lo coge del xml de aplicacion. No hay metodo setter.

  • access: public
static void getTemporalDir ()
static method getTimeMask (line 960)

getTimeMask: devuelve la mascara de hora usada en todos los sitios (bd, User, FW) Si se cambia, ha de ser valido para todos los sgbd soportados

static string getTimeMask ()
static method getTransformErrors (line 965)
static void getTransformErrors ()
static method setTransformErrors (line 970)
static void setTransformErrors ( $lis)
  • $lis
Destructor __destruct (line 174)
  • access: public
void __destruct ()
getAppVersion (line 307)

getAppVersion:: Devuelve la versión de la aplicación

Devuelve el número de versión de la aplicación. En desarrollo devolverá HEAD.

  • return: Texto con la versión de la aplicación
  • access: public
string getAppVersion ()
getCustomTitle (line 346)

getCustomTitle:: Devuelve la cadena de personalización de la barra superior

En la barra superior se ha designado un pequeño espacio para un texto personalizado. Este método permite accder a dicho valor

  • return: Texto de personalización de la barra superior
  • access: public
string getCustomTitle ()
getDefList (line 778)

getDefList: devuelve la definición de una lista desplegable

Devuelve la definición de una lista desplegable. Concretamente devuelve la sentencia SELECT con la que se obtienen los resultados deseados.

  • access: public
string getDefList (string $key)
  • string $key: clave con la que se identifica la lista en la aplicación
getDefVS (line 852)

getDefVS: devuelve la definición de una ventana de seleccion

Devuelve la definición de una ventana de seleccion.

  • access: public
array getDefVS (string $key)
  • string $key: clave con la que se identifica la lista en la aplicación
getDSN (line 895)

getDSN: devuelve el array de conexion,

Dada un ID devuelve el array de conexion correspondiente

  • access: public
array getDSN (string $key)
  • string $key: clave con la que se identifica el array de conexion
getDSNLog (line 908)

getDSNLog: Devuelve el dsn usado para el Log

  • access: public
array getDSNLog ()
getgvHidraVersion (line 319)

getgvHidraVersion:: Devuelve la versión de gvHidra

Devuelve el número de versión del framework gvHidra.

  • return: Texto con la versión de la aplicación
  • access: public
string getgvHidraVersion ()
getListKeys (line 792)

getListKeys: devuelve las claves de las listas desplegables

  • access: public
array getListKeys ( $key)
  • $key
getLogConnection (line 483)

getLogConnection: Devuelve la conexion que se utiliza en el log.

Devuelve el objeto conexion que se utiliza en el debug/log del FW. Esta conexion será persistente dependiendo del SGBD (solo Postgres lo permite).

  • access: public
void getLogConnection ()
getLogStatus (line 371)

getLogStatus:: Devuelve el estado del log.

Devuelve el estado del log en la aplicación. Los valores posibles son LOG_NONE, LOG_ERRORS, LOG_AUDIT y LOG_ALL.

  • access: public
void getLogStatus ()
getQueryMode (line 402)

getQueryMode:: Devuelve el valor del modo de consulta (ver propiedad para var posibles valores).

Devuelve el valor del modo de consulta para saber de que modo se van a construir las Querys.

  • access: public
void getQueryMode ()
getReloadMappings (line 508)

getReloadMappings: Devuelve el valor del estado de reloadMappings

  • access: public
void getReloadMappings ()
getSmartyCompileCheck (line 534)

getSmartyCompileCheck: Devuelve el valor de smartyCompileCheck

  • access: public
void getSmartyCompileCheck ()
getTemplatesCompilationDir (line 430)

getTemplatesCompilationDir:: Devuelve el directorio de templates_c

Devuelve el directorio de compilacion de las plantillas de smarty.

  • access: public
void getTemplatesCompilationDir ()
getVSKeys (line 866)

getVSKeys: devuelve las claves de las ventanas de seleccion

  • access: public
array getVSKeys ()
setAppVersion (line 332)

setApplicationName: Fija la versión que se esta ejecutando.

Establece la versión de la aplicación que se esta ejecutando.

  • access: public
void setAppVersion (string $appVersion)
  • string $appVersion: Cadena que indica la versión de la aplicación
setCustomTitle (line 359)

setCustomTitle: Fija el texto personalizado de la barra de título

  • access: public
void setCustomTitle (string $customTitle)
  • string $customTitle: Cadena con el breve texto de personalización
setDSN (line 881)

setDSN: almacena un vector de conexion a una BD

Guarda en la configuración una conexión a la BD que posteriormente se utilizará en la aplicacion.

  • access: public
none setDSN (string $key, string $vdsn)
  • string $key: clave con la que se identificará el array de conexion
  • string $vdsn: array de conexion basado en la estructura PEAR
setList_ClassSource (line 750)

setClassList_ClassSource: crea una fuente de datos para una lista con una clase

Asocia una clase a la fuente de datos. Atencion: La clase tiene que implementar la interfaz gvHidraList_Source

  • access: public
none setList_ClassSource (string $key, string $class)
  • string $key: clave con la que se identificará la lista en la aplicación
  • string $class: clase que se instanciará para obtener la lista
setList_DBSource (line 734)

setDBList_DBSource: crea una fuente de datos para una lista mediante consulta SQL

Carga la definición de una lista desplegable en el objeto de configuración para que posteriormente pueda ser utilizada en cualquier parte de la aplicación.

  • access: public
none setList_DBSource (string $key, string $query)
  • string $key: clave con la que se identificará la lista en la aplicación
  • string $query: consulta que se ejecutará al obtener la lista
setLogConnection (line 498)

setLogConnection: Fija la conexion que se utiliza en el log.

Fija el objeto conexion que utilizara el log para trabajar. Esta conexion será persistente dependiendo del SGBD (solo Postgres lo permite).

Uso interno del FW. NO DEBE SER USUADO POR EL PROGRAMADOR

  • access: public
void setLogConnection ( $connection)
  • $connection
setLogStatus (line 385)

setLogStatus: Fija el estado del log.

Establece el estado del log. Los valores posibles son LOG_NONE, LOG_ERRORS, LOG_AUDIT y LOG_ALL.

  • access: public
void setLogStatus (string $status)
  • string $status: contiene el nuevo estado del log.
setQueryMode (line 415)

setQueryMode: Fija el valor del modo de consulta (ver propiedad para var posibles valores)

Fija el valor del modo de consulta para saber de que modo se van a construir las Querys.

  • access: public
void setQueryMode (string $mode)
  • string $mode: contiene el nuevo modo de consulta.
setReloadMappings (line 521)

setReloadMappings: Fija el estado de reloadMappings

  • access: public
void setReloadMappings (string $mode)
  • string $mode: contiene el nuevo estado
setSelectionWindow_ClassSource (line 824)

Crea una fuente de datos para WindowSelection con origen en una clase.

Atencion: La clase tiene que implementar la interfaz gvHidraSelectionWindow_Source

  • access: public
none setSelectionWindow_ClassSource (string $key, string $class)
  • string $key: Clave con la que se identificará la VS en la aplicación
  • string $class: Indica la clase que sera la definición de la VS
setSelectionWindow_DBSource (line 806)

Crea una fuente de datos para WindowSelection con origen en una consulta SQL.

  • access: public
none setSelectionWindow_DBSource (string $key, string $query, [array $fields = null])
  • string $key: Clave con la que se identificará la VS en la aplicación
  • string $query: Expresión (consulta) con la que obtendremos el resultado
  • array $fields: Opcional. Campos de busqueda adicionales a los incluidos en la consulta
setTemplatesCompilationDir (line 444)

setTemplatesCompilationDir: Fija el directorio de templates_c

Establece el directorio de compilacion de las plantillas de smarty.

  • access: public
void setTemplatesCompilationDir (string $dir)
  • string $dir: directorio de compilacion de plantillas

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