Documentación GVHIDRA 3.1.5
Referencia de la Clase IgepDB

Métodos públicos

 backSlashScape ($p_dsn)

Métodos públicos estáticos

static preConexion ($p_dsn)
static postConexion ($p_dsn, $p_conexion)
static caracteresNumericos ($p_dsn)
static mascaraFechas ($p_dsn)
static supportedDBMS ()
 empezarTransaccion ($p_dsn, $p_conexion)
 acabarTransaccion ($p_dsn, $p_conexion, $p_error)
static obtenerDBMS ($p_dsn)
static creaDBMS ($p_dsn)
static obtenerLimit (&$str_where, $p_dsn, $int_limit)
static obtenerSecuenciaBD ($p_dsn, $sequence)
static unDiacritic ($p_dsn, $param)
static toTextForVS ($p_dsn, $param)
static concat ($p_dsn, $p1, $p2)
static obtenerBloqueo ($p_dsn)
 isLocked ($p_dsn, $result)

Descripción detallada

Definición en la línea 12 del archivo IgepDB.php.


Documentación de las funciones miembro

acabarTransaccion ( p_dsn,
p_conexion,
p_error 
) [static]

Acaba la transaccin en funcin del parmetro

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
conexionrecibe una conexin establecida
booleanindica si hay que confirmar o deshacer
Devuelve:
mixed devuelve el resultado

Definición en la línea 101 del archivo IgepDB.php.

                                                           {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->acabarTransaccion($p_conexion, $p_error);
  }             
backSlashScape ( p_dsn)

Devuelve la cadena que se debe utilizar para escapar la contrabarra

En Oracle no utilizamos dicha cadena, en Postgres y MySql si

public

Devuelve:
string

Definición en la línea 258 del archivo IgepDB.php.

                                              {
                $obj = IgepDB::creaDBMS($p_dsn);
                return $obj->backSlashScape();          
        }
static caracteresNumericos ( p_dsn) [static]

Indica los carcteres usados para esta conexin (separador decimal y de miles)

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
Devuelve:
mixed array asociativo con entrada 'DECIMAL' y 'GROUP'

Definición en la línea 48 del archivo IgepDB.php.

                                             {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->caracteresNumericos($p_dsn);
  }
static concat ( p_dsn,
p1,
p2 
) [static]

Devuelve la cadena para concatenar dos campos Si alguno es nulo lo reemplaza por cadena vacia

public

Devuelve:
string

Definición en la línea 220 del archivo IgepDB.php.

                                                {
                $obj = IgepDB::creaDBMS($p_dsn);
                return $obj->concat($p1, $p2);
        }
static creaDBMS ( p_dsn) [static]

Crea una instancia del tipo IgepDBMS_* que corresponde a $p_dsn

private

Parámetros:
mixeddsn usado en pear::db
Devuelve:
IgepDBMS instancia de IgepDBMS_*

Definición en la línea 132 del archivo IgepDB.php.

                                  {
    $tipo = IgepDB::obtenerDBMS($p_dsn);
    $nombreclase = 'IgepDBMS_'.$tipo;
        //TODO: por algun motivo hay una llamada con getcwd() a '/' y da un warning en el include
        if (!class_exists($nombreclase))
                include_once("igep/include/igep_bd/${nombreclase}.php");
    if (!class_exists($nombreclase)) {
        throw new Exception('No existe la clase '.$nombreclase);
    }
    @$obj = new $nombreclase;
    if (!isset($obj)) {
        throw new Exception('No se ha podido instanciar la clase '.$nombreclase);
    }
        return $obj;
  }
empezarTransaccion ( p_dsn,
p_conexion 
) [static]

Inicia la transaccin.

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
conexionrecibe una conexin establecida
Devuelve:
mixed devuelve el resultado

Definición en la línea 86 del archivo IgepDB.php.

                                                 {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->empezarTransaccion($p_conexion);
  }             
isLocked ( p_dsn,
result 
) [static]

Devuelve si el objeto de error es debido a que la(s) fila(s) no se puede(n) bloquear

public

Parámetros:
resultobjeto error de IgepError
Devuelve:
boolean

Definición en la línea 245 del archivo IgepDB.php.

                                          {
                $obj = IgepDB::creaDBMS($p_dsn);
                return $obj->isLocked($result);
        }
static mascaraFechas ( p_dsn) [static]

Indica la mscara de fechas utilizada para esta conexin

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
Devuelve:
mixed array asociativo con entrada 'DECIMAL' y 'GROUP'

Definición en la línea 61 del archivo IgepDB.php.

                                       {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->mascaraFechas($p_dsn);
  }
static obtenerBloqueo ( p_dsn) [static]

Devuelve la cadena usada en una consulta para bloqueo exclusivo de registros

public

Devuelve:
string

Definición en la línea 232 del archivo IgepDB.php.

                                              {
                $obj = IgepDB::creaDBMS($p_dsn);
                return $obj->obtenerBloqueo();
        }
static obtenerDBMS ( p_dsn) [static]

Obtiene el tipo de dbms usado en una conexin

private

Parámetros:
mixeddsn usado en pear::db
Devuelve:
string dbms

Definición en la línea 114 del archivo IgepDB.php.

                                     {
        $resul = $p_dsn['phptype'];
        if ($resul=='mysqli')
                $resul = 'mysql';
        if (!in_array($resul, self::supportedDBMS())) {
                throw new Exception("El tipo de dsn no est soportado: '$resul'");
        }
        return $resul;
  }
static obtenerLimit ( &$  str_where,
p_dsn,
int_limit 
) [static]

Crea la cadena del LIMIT adecuada al tipo de DBMS.

private

Parámetros:
stringstr_where cadena que contiene la where. Se utiliza en el caso de Oracle, ya que limitamos con el ROWNUM
arrayp_dsn DSN de conexion a la BD.
integerint_limit lmite que se le quiere incorporar a la consulta
Devuelve:
string cadena resultado del lmite

Definición en la línea 158 del archivo IgepDB.php.

                                                               {  
    switch($p_dsn['phptype']){
      case 'pgsql':
      case 'mysql':
      case 'mysqli':
        $limite = ' LIMIT '.$int_limit;
        break;
      case 'oci8':
        if($str_where!='')
          $str_where.= ' AND';
        else
          $str_where.= ' WHERE';
        $str_where.= ' ROWNUM <= '.$int_limit;
        $limite = '';
        break;
      default:
        $limite ='';
    }
    return $limite;
  }
static obtenerSecuenciaBD ( p_dsn,
sequence 
) [static]

Definición en la línea 179 del archivo IgepDB.php.

                                                      {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->obtenerSecuenciaBD($sequence);
  }
static postConexion ( p_dsn,
p_conexion 
) [static]

Modifica, si procede, la conexin establecida.

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
conexionrecibe una conexin establecida

Definición en la línea 35 del archivo IgepDB.php.

                                                  {
    $obj = IgepDB::creaDBMS($p_dsn);
    $obj->postConexion($p_conexion);
  }             
static preConexion ( p_dsn) [static]

Modifica, si procede, los parmetros de la conexin.

public

Parámetros:
mixeddsn que utiliza pear:db para la conexin
Devuelve:
mixed devuelve el dsn modificado

Definición en la línea 22 del archivo IgepDB.php.

                                     {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->preConexion($p_dsn);
  }             
static supportedDBMS ( ) [static]

Devuelve los tipos de drives soportados. Las cadenas contienen el valor soportado por los DSN de pear:mdb2 en campo 'phptype'

public

Devuelve:
mixed devuelve el resultado

Definición en la línea 73 del archivo IgepDB.php.

                                 {
    return array('pgsql','oci8','mysql');
  }
static toTextForVS ( p_dsn,
param 
) [static]

Devuelve la cadena para pasar a texto un campo usado en las ventanas de seleccin. Solo hace falta definirlo cuando salgan problemas de conversiones en ventanas de seleccion y filtros que usan like

public

Devuelve:
string

Definición en la línea 207 del archivo IgepDB.php.

                                                   {
                $obj = IgepDB::creaDBMS($p_dsn);
                return $obj->toTextForVS($param);
        }
static unDiacritic ( p_dsn,
param 
) [static]

Devuelve la cadena sin acentos teniendo en cuenta el tipo de DBMS. (En MySQL se debe utilizar la funcin de translate anidada).

public

Parámetros:
stringcadena que a la que se le quiere quitar los acentos.
Devuelve:
string

Definición en la línea 193 del archivo IgepDB.php.

                                             {
    $obj = IgepDB::creaDBMS($p_dsn);
    return $obj->unDiacritic($param);
  }

La documentación para esta clase fue generada a partir del siguiente fichero: