Class IgepConexion

Description

IgepConexion es una clase que corresponde a un manejador de una conexion a una bases de datos determinada. Controla las operaciones correspondientes a la conexión y a las transacciones.

Consta de las siguientes propiedades:

  • $obj_conexion - El objeto de conexión con el que trabaja.
  • $obj_errorConexion - Referencia al objeto de error global

Located in /include/IgepConexion.php (line 54)


	
			
Variable Summary
object obj_conexion $obj_conexion
object obj_errorConexion $obj_errorConexion
array $v_dsn
Method Summary
static mixed transform_BD2User (any $a_parametros, any $a_tipo, mixed $a_dsn, [number $a_decimales = 2])
IgepConexion __construct (array $dsn, [bool $persistent = false])
void __destruct ()
void acabarTransaccion (integer $error)
integer calcularSecuencia (tabla $tabla, campoSecuencia $campoSecuencia, camposDependientes $camposDependientes, [valorInicial $valorInicial = 1])
integer calcularSecuenciaBD (nombreSecuencia $nombreSecuencia)
string combinarWhere (array $v_cadenas)
void construirLimite ( &$str_where, [ $int_limiteConsulta = 100])
void construirWhere ( $v_datos,  $str_where)
void construirWhereBusqueda ( $v_datos,  $undiacritic,  $str_where,  $tipoConsulta)
void construirWhereConLike ( $v_datos,  $str_where,  $tipoConsulta)
object consultar (string $str_select, [array $typeDesc = NULL])
object consultarForUpdate (string $str_select, [ $tipo = NULL])
object getConexion ()
array getDSN ()
object getPEARConnection ()
array isPersistent ()
void normalCondition ($col $col, $val $val, [$tipo $tipo = 1])
object operar ( $str_operar, string $str_select)
string prepararFecha (any $a_fecha)
string prepararNumero (any $a_num)
none prepararOperacion ( &$a_parametros, [any $a_tipo = TIPO_CARACTER], any $a_parametros)
array preparedQuery ( $str_select, array $dml_ddl,  $params, [ $tipo = null], [ &$cur = null], boolean $dml_ddl:)
void preparedQueryForUpdate ( $str_select,  $params, [ $tipo = null], [ &$cur = null])
void transformResultSet ( &$res,  $typeDesc)
void transform_BD2FW ( &$a_parametros, [any $a_tipo = TIPO_CARACTER], any $a_parametros)
void unDiacriticCondition ($col $col, $val $val, [$tipo $tipo = 1], [$prepare $prepare = true])
Variables
object obj_conexion $obj_conexion (line 61)

objeto conexion

object obj_errorConexion $obj_errorConexion (line 68)

variable de error

array $v_dsn (line 75)

variable de que contiene la descripción del dsn al que se conecta

  • var: v_dsn
Methods
static method transform_BD2User (line 813)

Convierte de DB a User Si estamos convirtiendo un numero a decimal podemos indicar el numero de decimales.

  • access: public
static mixed transform_BD2User (any $a_parametros, any $a_tipo, mixed $a_dsn, [number $a_decimales = 2])
  • any $a_parametros
  • any $a_tipo
  • mixed $a_dsn
  • number $a_decimales
Constructor __construct (line 92)

Constructor. Recibe como parámetro un array con la definición del dsn.

  • access: public
IgepConexion __construct (array $dsn, [bool $persistent = false])
  • array $dsn
  • bool $persistent
Destructor __destruct (line 103)
  • access: public
void __destruct ()
acabarTransaccion (line 239)

Finaliza una transacción (COMMIT o ROLLBACK) en la conexión a la que

está apuntando. Recibe un parámetro que indica si el procesado de las diferentes operaciones que se han realizado ha concluido satisfactoriamente

  • no. Dependiendo de ello se realizará el COMMIT o el ROLLBACK. Dicho
parámetro es $error
  • 0. No ha habido ningún error en el proceso. Realizamos COMMIT
  • 1. Ha habido algún error durante el proceso. Realizamos ROLLBACK

  • access: public
void acabarTransaccion (integer $error)
  • integer $error
calcularSecuencia (line 884)

Este método calcula una secuencia compuesta por varios campos de la misma tabla.

  • access: public
integer calcularSecuencia (tabla $tabla, campoSecuencia $campoSecuencia, camposDependientes $camposDependientes, [valorInicial $valorInicial = 1])
  • tabla $tabla: string nombre de la tabla de la BD
  • campoSecuencia $campoSecuencia: string campo del que se quiere obtener la secuencia
  • camposDependientes $camposDependientes: array contiene el nombre de los campos de los cuales va a depender la secuencia y sus valores. Estructura [nombreBD] = valor
  • valorInicial $valorInicial: integer Fija el valor inicial que devuelve calcularSecuencia en el caso de que no exístan tuplas en la tabla el valor por defecto es 1
calcularSecuenciaBD (line 859)

Este método devuelve el valor de una secuencia programada en la base de datos para la conexion actual

  • access: public
integer calcularSecuenciaBD (nombreSecuencia $nombreSecuencia)
  • nombreSecuencia $nombreSecuencia: string nombre de la secuencia en la BD
combinarWhere (line 473)

Método encargado de, dadas una serie de cadenas, componerlas para crear una única cadena para la where de una SQL.

  • access: public
string combinarWhere (array $v_cadenas)
  • array $v_cadenas: Array que contiene las diferentes cadenas que componen la WHERE
construirLimite (line 493)

Método encargado de construir el limit para las consultas

  • access: public
void construirLimite ( &$str_where, [ $int_limiteConsulta = 100])
  • &$str_where
  • $int_limiteConsulta
construirWhere (line 256)

Método encargado de construir las WHERE de las consultas.

  • access: public
void construirWhere ( $v_datos,  $str_where)
  • $v_datos
  • $str_where
construirWhereBusqueda (line 438)

Método encargado de construir las WHERE de las consultas incluyendo las condiciones de busqueda que ha seleccionado el programador a partir del parámetro tipoConsulta.

Este es un metodo alternativo a construirWhereConLike, donde siempre se descartan caracteres especiales y mayusculas Llamado desde gvHidraForm_DB->prepareDataSource

Dependiendo del valor de la variable realiza una construcción de la Where u otra. Los tipos son:

  • 0. Se contruye igualando los campos a los valores.
  • 1. Se construye con like y comodines para cada campo.
  • 2. Por defecto, se contruye con like sólo si el usuario ha especificado comodines.

  • access: public
void construirWhereBusqueda ( $v_datos,  $undiacritic,  $str_where,  $tipoConsulta)
  • $v_datos
  • $undiacritic
  • $str_where
  • $tipoConsulta
construirWhereConLike (line 303)

Método encargado de construir las WHERE de las consultas incluyendo las condiciones de busqueda que ha seleccionado el programador a partir del parámetro tipoConsulta.

Este es un metodo alternativo a construirWhereBusqueda, donde solo se descartan caracteres especiales y mayusculas en tipo 3 Llamado desde gvHidraForm_DB->prepareDataSource (actualmente no se usa)

Dependiendo del valor de la variable realiza una construcción de la Where u otra. Los tipos son:

  • 0. Se contruye igualando los campos a los valores.
  • 1. Se construye con like y comodines para cada campo.
  • 2. Por defecto, se contruye con like sólo si el usuario ha especificado comodines.
  • 3. Se construye con like, sin distinguir mayúsculas ni caracteres especiales

void construirWhereConLike ( $v_datos,  $str_where,  $tipoConsulta)
  • $v_datos
  • $str_where
  • $tipoConsulta
consultar (line 511)

Dada una una consulta realiza la SELECT correspondiente.

Si se indica el parametro typeDesc cambiará los datos de origen al formato FW

  • access: public
object consultar (string $str_select, [array $typeDesc = NULL])
  • string $str_select: str_select cadena con la query SQL
  • array $typeDesc: typeDesc descripcion de los campos para posibles transformaciones
consultarForUpdate (line 536)

Dada una consulta realiza la SELECT correspondiente pero bloqueando las filas para modificacion

  • access: public
object consultarForUpdate (string $str_select, [ $tipo = NULL])
  • string $str_select
  • $tipo
empezarTransaccion (line 217)

Empieza una transacción (BEGIN) en la conexión a la que está apuntando.

  • access: public
void empezarTransaccion ()
getConexion (line 180)

Devuelve el objeto conexión al que se está conectado.

  • deprecated: 3.2 - 21/01/2010
  • access: public
object getConexion ()
getDSN (line 194)

Devuelve el dsn de la conexión.

  • access: public
array getDSN ()
getPEARConnection (line 168)

Devuelve el objeto conexión al que se está conectado.

  • access: public
object getPEARConnection ()
isPersistent (line 205)

Indica si una conexion se ha establecido con el atributo persistente(reusable)

  • access: public
array isPersistent ()
normalCondition (line 398)

Para formar condiciones de busqueda con tipos de datos diferentes a string

  • access: public
void normalCondition ($col $col, $val $val, [$tipo $tipo = 1])
  • $col $col: nombre columna
  • $val $val: valor a filtrar en la columna
  • $tipo $tipo: 0..2, igual que el queryMode
operar (line 663)

Dada una una consulta realiza la SELECT correspondiente.

  • access: public
object operar ( $str_operar, string $str_select)
  • string $str_select
  • $str_operar
prepararFecha (line 796)

Transforma una fecha de capa negocio a capa datos

  • access: public
string prepararFecha (any $a_fecha)
  • any $a_fecha
prepararNumero (line 782)

Transforma un numero de capa negocio a capa datos

  • access: public
string prepararNumero (any $a_num)
  • any $a_num
prepararOperacion (line 688)

Convierte de FW a DB Este método debe ser invocado por el usuario antes de realizar cualquier consulta/operacion a la BD para garantizar la portabilidad.

  • access: public
none prepararOperacion ( &$a_parametros, [any $a_tipo = TIPO_CARACTER], any $a_parametros)
  • any $a_parametros
  • any $a_tipo
  • &$a_parametros
preparedQuery (line 572)

Ejecución de consulta preparada Si se usan placeholders con nombre, en los parametros pasaremos array asociativo.

  • return: varios: si dml_ddl, devuelve numero de registros afectados sino devuelve vector excepciones: 1: error en prepare 2: error en execute 3: error en fetchAll
  • access: public
array preparedQuery ( $str_select, array $dml_ddl,  $params, [ $tipo = null], [ &$cur = null], boolean $dml_ddl:)
  • boolean $dml_ddl:: false para select, true para el resto
  • array $dml_ddl: tipo: tipos para usar en transformaciones
  • $str_select
  • $params
  • $tipo
  • &$cur
preparedQueryForUpdate (line 614)

Dada una consulta realiza la SELECT correspondiente pero bloqueando las filas para modificacion

y usando sentencias preparadas Devuelve vector excepciones: 4: hay bloqueo resto: las propias de preparedQuery

  • access: public
void preparedQueryForUpdate ( $str_select,  $params, [ $tipo = null], [ &$cur = null])
  • $str_select
  • $params
  • $tipo
  • &$cur
transformResultSet (line 637)

Transforma los datos obtenidos por consultar y preparedQuery

void transformResultSet ( &$res,  $typeDesc)
  • &$res
  • $typeDesc
transform_BD2FW (line 741)

Convierte datos de DB a FW No valida los datos en origen, por lo que de momento si en origen tenemos una fecha con hora, en el destino estaría sin hora.

  • access: public
void transform_BD2FW ( &$a_parametros, [any $a_tipo = TIPO_CARACTER], any $a_parametros)
  • any $a_parametros
  • any $a_tipo
  • &$a_parametros
unDiacriticCondition (line 359)

Para formar condiciones de busqueda.

Actua como en las ventanas de selección (donde no se tienen en cuenta mayusculas ni caracteres especiales)

  • access: public
void unDiacriticCondition ($col $col, $val $val, [$tipo $tipo = 1], [$prepare $prepare = true])
  • $col $col: nombre columna
  • $val $val: valor a filtrar en la columna
  • $tipo $tipo: 0..2, igual que el queryMode
  • $prepare $prepare: boolean: si hay que transformar el valor a bd

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