![]() |
Documentación GVHIDRA 3.1.5
|
Definición en la línea 41 del archivo ConfigFramework.php.
__construct | ( | ) | [private] |
Definición en la línea 160 del archivo ConfigFramework.php.
{ $this->logStatus=LOG_NONE; $this->queryMode=2; $this->defList = array(); $this->defVS = array(); $this->vDSN = array(); $this->templatesCompilationDir = 'templates_c/'; $this->temporalDir = null; $this->reloadMappings = null; $this->smartyCompileCheck = null; $this->logDSN = 'gvh_dsn_log'; }
__destruct | ( | ) |
Definición en la línea 174 del archivo ConfigFramework.php.
{ //Almacenamos la configuracin en la SESSION siempre que exista la aplicacin (Cuando se cierra la aplicacin no la guardamos) if(IgepSession::existeAplicacion($this->applicationName)) $_SESSION[$this->applicationName]['configuration'] = serialize(self::$_instance); }
_loadConfigFile | ( | $ | fichero | ) | [private] |
_loadConfigFile: Carga un fichero de configuracin XML
Carga el fichero de configuracin XML indicado por parmetro y asigna los valores ledos en el mismo en la instancia.del objeto private
string | $fichero |
Definición en la línea 552 del archivo ConfigFramework.php.
{ try { if (file_exists($fichero)) { $sXML = simplexml_load_file($fichero); if ($sXML->applicationName) $this->applicationName = (string) $sXML->applicationName; if ($sXML->templatesCompilationDir) $this->templatesCompilationDir = (string) $sXML->templatesCompilationDir; if ($sXML->temporalDir) $this->temporalDir = (string) $sXML->temporalDir; if ($sXML->reloadMappings) $this->reloadMappings = (boolean)(strtolower((string) $sXML->reloadMappings)=='true'); if ($sXML->smartyCompileCheck) $this->smartyCompileCheck = (boolean)(strtolower((string) $sXML->smartyCompileCheck)=='true'); if ($sXML->appVersion) $this->applicationVersion = (string) $sXML->appVersion; if ($sXML->gvHidraVersion) $this->gvHidraVersion = (string) $sXML->gvHidraVersion; if ($sXML->customTitle) $this->customTitle = utf8_decode((string) $sXML->customTitle); if ($sXML->customDirName) $this->customDirName = (string) $sXML->customDirName; //logSettings if ($sXML->logSettings) { $vAtributos = $sXML->logSettings->attributes(); $estadoLog = (string) $vAtributos['status']; switch ($estadoLog) { case 'LOG_ERRORS': $this->logStatus = LOG_ERRORS; break; case 'LOG_AUDIT': $this->logStatus = LOG_AUDIT; break; case 'LOG_ALL': $this->logStatus = LOG_ALL; break; default: $this->logStatus = LOG_NONE; }//Fin switch $dsnRef = (string) $vAtributos['dsnRef']; if (!empty($dsnRef)) $this->logDSN = $dsnRef; }//Fin if logSettings //queryMode if ($sXML->queryMode) { $vAtributos = $sXML->queryMode->attributes(); $queryMode = (string) $vAtributos['status']; switch (trim($queryMode)) { case '0': $this->queryMode = 0; break; case '1': $this->queryMode = 1; break; case '2': $this->queryMode = 2; break; default: $this->queryMode = 2; } }//Fin if queryMode //DSNZone if ($sXML->DSNZone) { foreach ($sXML->DSNZone->dbDSN as $db) { $vAtributosDB = $db->attributes(); $idDSN = (string) $vAtributosDB['id']; $dbType = (string) $vAtributosDB['sgbd']; $dbHost= (string) $db->dbHost; $dbPort= (string) $db->dbPort; $dbDataBase= (string) $db->dbDatabase; $dbUser =(string) $db->dbUser; $dbPassword =(string) $db->dbPassword; $parse_DBType = $this->_parseDBType($dbType); if ($dbType=='thin' or $dbType=='oracle-thin') $this->vDSN[$idDSN] = array ( 'phptype' => $parse_DBType, 'username' => $dbUser, 'password' => $dbPassword, 'hostspec' => "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=$dbHost)(PORT=$dbPort))(CONNECT_DATA=(SID=$dbDataBase)))", ); else $this->vDSN[$idDSN] = array ( 'phptype' => $parse_DBType, 'username' => $dbUser, 'password' => $dbPassword, 'hostspec' => $dbHost, 'port' => $dbPort, 'database' => $dbDataBase, ); }//Fin foreach DB foreach ($sXML->DSNZone->wsDSN as $ws) { $vAtributosWS = $ws->attributes(); $idWS = (string) $vAtributosWS['id']; $uriWSDL = (string) $ws->uriWSDL;; $wsUser =(string) $ws->wsUser; $wsPassword =(string) $ws->wsPassword; $this->vDSN[$idWS] = array ( 'uriWSDL' => $uriWSDL, 'username' => $wsUser, 'password' => $wsPassword, ); }//Fin foreach WS }//Fin if DSNZone } else //REVIEW tratamiento de Excepciones { die('_loadConfigFile::MUERE AL LEER EL FICHERO CONFIG'); } } catch (Exception $e) { die('_loadConfigFile::Error en carga de fichero: '.$e); } }//Fin _loadConfigFile
_parseDBType | ( | $ | sgbdType | ) | [private] |
_parseDBType: Dada una cadena con el nombre del SGBD devuelve el nombre cannico
private
string | $sgbdType | El SGBD (oracle, oci, oci8, thin, postgres, pgsql, mysql, mysqli... |
Definición en la línea 698 del archivo ConfigFramework.php.
{ $retorno =''; switch (strtolower(trim($sgbdType))) { case 'postgres': case 'pgsql': $retorno = 'pgsql'; break; case 'oci8': case 'oci': case 'oracle': case 'thin': case 'oracle-thin': $retorno = 'oci8'; break; case 'mysqli': case 'mysql': $retorno = 'mysqli'; break; default: throw new Exception('El tipo de dsn no est soportado: '.$sgbdType); } return($retorno); }
static getApplicationName | ( | ) | [static] |
getApplicationName:: Devuelve el nombre de la aplicacin actual
Definición en la línea 263 del archivo ConfigFramework.php.
{ if(empty(self::$_instance)) { $fichero = './gvHidraConfig.inc.xml'; if (file_exists($fichero)) { $sXML = simplexml_load_file($fichero); $nombreApp = (string) $sXML->applicationName; unset($sXML);//Liberamos el recurso if (!empty($nombreApp)) return($nombreApp); } else { throw new Exception('getApplicationName: no existe el fichero '.$fichero); } throw new Exception('getApplicationName: no est definido el codigo de la aplicacin'); } return self::$_instance->applicationName; }
getAppVersion | ( | ) |
getAppVersion:: Devuelve la versin de la aplicacin
Devuelve el nmero de versin de la aplicacin. En desarrollo devolver HEAD.
Definición en la línea 307 del archivo ConfigFramework.php.
{
return($this->applicationVersion);
}
static getConfig | ( | ) | [static] |
Definición en la línea 182 del archivo ConfigFramework.php.
{ //Cargamos el fichero de configuracin del Framework try { //Comprobar que existe el fichero y cargarlo if (empty(self::$_instance))//Review: David y Toni: Clase Pear:Config para cargar fichero { $g_aplicacion = ConfigFramework::getApplicationName(); if(!isset($_SESSION[$g_aplicacion]['configuration'])) { $instance = new ConfigFramework(); //Leemos el fichero de configuracin del Framework $fichero = './igep/gvHidraConfig.inc.xml'; $instance->_loadConfigFile($fichero); //Leemos el fichero de configuracin del CUSTOM $customDirName =$instance->getCustomDirName(); $fichero = './igep/custom/'.$customDirName.'/gvHidraConfig.inc.xml'; $instance->_loadConfigFile($fichero); //Leemos el fichero de configuracin de la APLICACIN $fichero = './gvHidraConfig.inc.xml'; $instance->_loadConfigFile($fichero); self::$_instance = $instance; $_SESSION[$g_aplicacion]['configuration'] = serialize($instance); } else { self::$_instance = unserialize($_SESSION[$g_aplicacion]['configuration']); } } return self::$_instance; } catch (Exception $e) { throw new Exception('ConfigFramework::getConfig() EXCEPCION: errores en la lectura de los ficheros: '.$e->getMessage()); } }//Fin getConfig (constructor singleton)
static getCustomDirName | ( | ) | [static] |
getCustomDirName:: Devuelve el nombre del subdirectorio de CUSTOM actual
Devuelve el directorio que contiene la informacin de custom
public
Definición en la línea 232 del archivo ConfigFramework.php.
{ if(empty(self::$_instance)) { // buscar el custom en aplicacion o en FW foreach (array('./gvHidraConfig.inc.xml', './igep/gvHidraConfig.inc.xml',) as $fichero) { if (file_exists($fichero)) { $sXML = simplexml_load_file($fichero); $nombreCustom = (string) $sXML->customDirName; unset($sXML);//Liberamos el recurso if (!empty($nombreCustom)) return($nombreCustom); } else { throw new Exception('getCustomDirName: no existe el fichero '.$fichero); } } throw new Exception('getCustomDirName: no est definido el custom a usar'); } return self::$_instance->customDirName; }
getCustomTitle | ( | ) |
getCustomTitle:: Devuelve la cadena de personalizacin de la barra superior
En la barra superior se ha designado un pequeo espacio para un texto personalizado. Este mtodo permite accder a dicho valor
Definición en la línea 346 del archivo ConfigFramework.php.
{
return($this->customTitle);
}
static getDateMaskFW | ( | ) | [static] |
getDateMaskFW: devuelve el formato de fechas que utilizar en FW. Este formato coincidir con el formato PHP public
Definición en la línea 939 del archivo ConfigFramework.php.
{ return 'Y-n-j'; }
static getDateMaskUser | ( | ) | [static] |
getDateMaskUser: devuelve la mascara de representacion de fechas de pantalla
public
Definición en la línea 949 del archivo ConfigFramework.php.
{ return 'd/m/Y'; }
getDefList | ( | $ | key | ) |
getDefList: devuelve la definicin de una lista desplegable
Devuelve la definicin de una lista desplegable. Concretamente devuelve la sentencia SELECT con la que se obtienen los resultados deseados. public
string | $key | clave con la que se identifica la lista en la aplicacin |
Definición en la línea 778 del archivo ConfigFramework.php.
{ if(isset($this->defList[$key])) return $this->defList[$key]; return -1; }
getDefVS | ( | $ | key | ) |
getDefVS: devuelve la definicin de una ventana de seleccion
Devuelve la definicin de una ventana de seleccion. public
string | $key | clave con la que se identifica la lista en la aplicacin |
Definición en la línea 852 del archivo ConfigFramework.php.
{ if(isset($this->defVS[$key])) return $this->defVS[$key]; return -1; }
getDSN | ( | $ | key | ) |
getDSN: devuelve el array de conexion,
Dada un ID devuelve el array de conexion correspondiente public
string | $key | clave con la que se identifica el array de conexion |
Definición en la línea 895 del archivo ConfigFramework.php.
{ if(isset($this->vDSN[$key])) return $this->vDSN[$key]; return null; }
getDSNLog | ( | ) |
getDSNLog: Devuelve el dsn usado para el Log
public
Definición en la línea 908 del archivo ConfigFramework.php.
{
return $this->vDSN[$this->logDSN];
}
getgvHidraVersion | ( | ) |
getgvHidraVersion:: Devuelve la versin de gvHidra
Devuelve el nmero de versin del framework gvHidra.
Definición en la línea 319 del archivo ConfigFramework.php.
{
return($this->gvHidraVersion);
}
getListKeys | ( | $ | key | ) |
getListKeys: devuelve las claves de las listas desplegables
public
Definición en la línea 792 del archivo ConfigFramework.php.
{
return array_keys($this->defList);
}
getLogConnection | ( | ) |
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). public
Definición en la línea 483 del archivo ConfigFramework.php.
{
return $this->logConnection;
}
getLogStatus | ( | ) |
getLogStatus:: Devuelve el estado del log.
Devuelve el estado del log en la aplicacin. Los valores posibles son LOG_NONE, LOG_ERRORS, LOG_AUDIT y LOG_ALL. public
Definición en la línea 371 del archivo ConfigFramework.php.
{
return($this->logStatus);
}
static getNumericSeparatorsFW | ( | ) | [static] |
getNumericSeparatorsFW: devuelve el formato numrico que utilizar en FW. Este formato coincidir con el formato PHP public
Definición en la línea 919 del archivo ConfigFramework.php.
{ return array('DECIMAL'=>'.','GROUP'=>''); }
static getNumericSeparatorsUser | ( | ) | [static] |
getNumericSeparatorsUser: devuelve el formato numrico que utilizar el usuario en pantalla.
public
Definición en la línea 929 del archivo ConfigFramework.php.
{ return array('DECIMAL'=>',','GROUP'=>'.'); }
getQueryMode | ( | ) |
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. public
Definición en la línea 402 del archivo ConfigFramework.php.
{
return($this->queryMode);
}
getReloadMappings | ( | ) |
getReloadMappings: Devuelve el valor del estado de reloadMappings
public
Definición en la línea 508 del archivo ConfigFramework.php.
{
return($this->reloadMappings);
}
getSmartyCompileCheck | ( | ) |
getSmartyCompileCheck: Devuelve el valor de smartyCompileCheck
public
Definición en la línea 534 del archivo ConfigFramework.php.
{
return($this->smartyCompileCheck);
}
getTemplatesCompilationDir | ( | ) |
getTemplatesCompilationDir:: Devuelve el directorio de templates_c
Devuelve el directorio de compilacion de las plantillas de smarty. public
Definición en la línea 430 del archivo ConfigFramework.php.
{
return($this->templatesCompilationDir);
}
static getTemporalDir | ( | ) | [static] |
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. public
Definición en la línea 456 del archivo ConfigFramework.php.
{ if(empty(self::$_instance)) { $fichero = './gvHidraConfig.inc.xml'; if (file_exists($fichero)) { $sXML = simplexml_load_file($fichero); $tmp = (string) $sXML->temporalDir; unset($sXML);//Liberamos el recurso return($tmp); } else { throw new gvHidraException("getTemporalDir:: no existe el fichero $fichero"); } } return self::$_instance->temporalDir; }
static getTimeMask | ( | ) | [static] |
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
public
Definición en la línea 960 del archivo ConfigFramework.php.
{ return 'H:i:s'; }
static getTransformErrors | ( | ) | [static] |
Definición en la línea 965 del archivo ConfigFramework.php.
{ return self::$transformErrors; }
getVSKeys | ( | ) |
getVSKeys: devuelve las claves de las ventanas de seleccion
public
Definición en la línea 866 del archivo ConfigFramework.php.
{
return array_keys($this->defVS);
}
setApplicationName | ( | $ | appName | ) | [private] |
setApplicationName: Establece el nombre de aplicacin
Establece el nombre de aplicacin actual private
string | $appName | Cadena que indica el nombre de la aplicacion |
Definición en la línea 294 del archivo ConfigFramework.php.
{ $this->applicationName = $appName; }
setAppVersion | ( | $ | appVersion | ) |
setApplicationName: Fija la versin que se esta ejecutando.
Establece la versin de la aplicacin que se esta ejecutando. public
string | $appVersion | Cadena que indica la versin de la aplicacin |
Definición en la línea 332 del archivo ConfigFramework.php.
{ $this->applicationVersion = $appVersion; }
setCustomTitle | ( | $ | customTitle | ) |
setCustomTitle: Fija el texto personalizado de la barra de ttulo
public
string | $customTitle | Cadena con el breve texto de personalizacin |
Definición en la línea 359 del archivo ConfigFramework.php.
{ $this->customTitle = $customTitle; }
setDSN | ( | $ | key, |
$ | vdsn | ||
) |
setDSN: almacena un vector de conexion a una BD
Guarda en la configuracin una conexin a la BD que posteriormente se utilizar en la aplicacion. public
string | $key | clave con la que se identificar el array de conexion |
string | $vdsn | array de conexion basado en la estructura PEAR |
Definición en la línea 881 del archivo ConfigFramework.php.
{ $this->vDSN[$key] = $vdsn; }
setList_ClassSource | ( | $ | key, |
$ | class | ||
) |
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
public
string | $key | clave con la que se identificar la lista en la aplicacin |
string | $class | clase que se instanciar para obtener la lista |
Definición en la línea 750 del archivo ConfigFramework.php.
{ //Comprobamos que la clase existe if(!class_exists($class)){ IgepDebug::setDebug(ERROR,"Se ha intentado crear una ClassSource para una List con una clase que no existe. Compruebe que la clase $class esta incluida en el fichero include de la aplicacion"); return -1; } //Comprobamos que la clase implementa la interfaz if(!in_array('gvHidraList_Source',class_implements($class))){ IgepDebug::setDebug(ERROR,"La clase $class no puede ser fuente de una lista ya que no implementa la interfaz gvHidraListSource"); return -1; } $this->defList[$key]['class'] = $class; return 0; }
setList_DBSource | ( | $ | key, |
$ | query | ||
) |
setDBList_DBSource: crea una fuente de datos para una lista mediante consulta SQL
Carga la definicin de una lista desplegable en el objeto de configuracin para que posteriormente pueda ser utilizada en cualquier parte de la aplicacin. public
string | $key | clave con la que se identificar la lista en la aplicacin |
string | $query | consulta que se ejecutar al obtener la lista |
Definición en la línea 734 del archivo ConfigFramework.php.
{ $this->defList[$key]['query'] = $query; return 0; }
setLogConnection | ( | $ | connection | ) |
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
public
Definición en la línea 498 del archivo ConfigFramework.php.
{ $this->logConnection = $connection; }
setLogStatus | ( | $ | status | ) |
setLogStatus: Fija el estado del log.
Establece el estado del log. Los valores posibles son LOG_NONE, LOG_ERRORS, LOG_AUDIT y LOG_ALL. public
string | $status | contiene el nuevo estado del log. |
Definición en la línea 385 del archivo ConfigFramework.php.
setQueryMode | ( | $ | mode | ) |
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. public
string | $mode | contiene el nuevo modo de consulta. |
Definición en la línea 415 del archivo ConfigFramework.php.
{ if ($mode>=0 && $mode<=2) $this->queryMode=$mode; else throw new Exception('setQueryMode: Error al fijar queryMode.'); }
setReloadMappings | ( | $ | mode | ) |
setReloadMappings: Fija el estado de reloadMappings
public
string | $mode | contiene el nuevo estado |
Definición en la línea 521 del archivo ConfigFramework.php.
{ if (is_bool($mode)) $this->reloadMappings=$mode; else throw new Exception('setReloadMappings: Error al fijar reloadMappings.'); }
setSelectionWindow_ClassSource | ( | $ | key, |
$ | class | ||
) |
Crea una fuente de datos para WindowSelection con origen en una clase.
Atencion: La clase tiene que implementar la interfaz gvHidraSelectionWindow_Source
public
string | $key | Clave con la que se identificar la VS en la aplicacin |
string | $class | Indica la clase que sera la definicin de la VS |
Definición en la línea 824 del archivo ConfigFramework.php.
{ //Comprobamos que la clase existe if(!class_exists($class)){ IgepDebug::setDebug(ERROR,"Se ha intentado crear una ClassSource para una WindowSelection con una clase que no existe. Compruebe que la clase $class esta incluida en el fichero include de la aplicacion"); return -1; } //Comprobamos que la clase implementa la interfaz if(!in_array('gvHidraSelectionWindow_Source',class_implements($class))){ IgepDebug::setDebug(ERROR,"La clase $class no puede ser fuente de una SelectionWindow ya que no implementa la interfaz gvHidraSelectionWindow_Source"); return -1; } $this->defVS[$key]['class'] = $class; return 0; }
setSelectionWindow_DBSource | ( | $ | key, |
$ | query, | ||
$ | fields = null |
||
) |
Crea una fuente de datos para WindowSelection con origen en una consulta SQL. public
string | $key | Clave con la que se identificar la VS en la aplicacin |
string | $query | Expresin (consulta) con la que obtendremos el resultado |
array | $fields | Opcional. Campos de busqueda adicionales a los incluidos en la consulta |
Definición en la línea 806 del archivo ConfigFramework.php.
{ $this->defVS[$key]['consulta'] = $query; if(!empty($fields)) $this->defVS[$key]['camposBusqueda'] = $fields; return 0; }
setTemplatesCompilationDir | ( | $ | dir | ) |
setTemplatesCompilationDir: Fija el directorio de templates_c
Establece el directorio de compilacion de las plantillas de smarty. public
string | $dir | directorio de compilacion de plantillas |
Definición en la línea 444 del archivo ConfigFramework.php.
{ $this->templatesCompilationDir = $dir; }
static setTransformErrors | ( | $ | lis | ) | [static] |
Definición en la línea 970 del archivo ConfigFramework.php.
{ self::$transformErrors = $lis; if (!empty($lis)) IgepDebug::setDebug(DEBUG_IGEP,'La transformacin ha detectado errores en la entrada del usuario: '.var_export($lis,true)); }
$_instance [static, private] |
Definición en la línea 70 del archivo ConfigFramework.php.
$applicationName [private] |
Definición en la línea 56 del archivo ConfigFramework.php.
$customDirName [private] |
Definición en la línea 49 del archivo ConfigFramework.php.
$customTitle [private] |
Definición en la línea 63 del archivo ConfigFramework.php.
$defList [private] |
Definición en la línea 137 del archivo ConfigFramework.php.
$defVS [private] |
Definición en la línea 144 del archivo ConfigFramework.php.
$logConnection [private] |
Definición en la línea 151 del archivo ConfigFramework.php.
$logDSN [private] |
Definición en la línea 84 del archivo ConfigFramework.php.
$logStatus [private] |
Definición en la línea 77 del archivo ConfigFramework.php.
$queryMode [private] |
Definición en la línea 95 del archivo ConfigFramework.php.
$reloadMappings [private] |
Definición en la línea 116 del archivo ConfigFramework.php.
$smartyCompileCheck [private] |
Definición en la línea 123 del archivo ConfigFramework.php.
$templatesCompilationDir [private] |
Definición en la línea 102 del archivo ConfigFramework.php.
$temporalDir [private] |
Definición en la línea 109 del archivo ConfigFramework.php.
$transformErrors = array() [static, private] |
Definición en la línea 158 del archivo ConfigFramework.php.
$vDSN [private] |
Definición en la línea 130 del archivo ConfigFramework.php.