Docs For Class toba

Métodos Propios

toba_db	__construct()
void	abortar_transaccion()	Ejecuta un ROLLBACK en la conexión
void	abrir_transaccion()	Ejecuta un BEGIN TRANSACTION en la conexión
void	activar_registro_consulta()	Activa/desactiva el resgistro de los comandos de consulta.
void	activar_registro_ejecucion()	Activa/desactiva el resgistro de los comandos de ejecución.
void	cerrar_transaccion()	Ejecuta un COMMIT en la conexión
void	conectar()	Crea una conexion a la base
array	consultar()	Ejecuta una consulta sql
array	consultar_fila()	Ejecuta una consulta sql y retorna la primer fila del resultado.
void	cortar_sql()
void	crear_lenguaje_procedural()	Crea el lenguaje plpgsql unicamente si el mismo aun no existe para la base de datos.
void	destruir()	Libera la conexión a la base
void	ejecutar()	Ejecuta un comando sql o un conjunto de ellos
void	ejecutar_archivo()	Ejecuta los comandos disponibles en un archivo
void	ejecutar_transaccion()	Ejecuta un conjunto de comandos dentro de una transacción
void	es_campo_candidato_descripcion()	Determina si la definición de un campo de una tabla es un campo descripción
void	exportar_registro()	Exporta el registro de los comandos de ejecución y consulta a archivos.
void	get_definicion_columnas()
string	get_dsn()	Retorna el dsn necesario para conectar con PDO
void	get_error_toba()	Mapea el error de la base al modulo de mensajes del toba
void	get_info_debug()	Retorna un arreglo con informacion de las distintas consultas/comandos ejecutados
object	get_manejador_auditoria()	Devuelve una instancia del manejador de auditoria para este motor de base de datos
void	get_opciones_sql_campo_externo()	Determina la sql,clave y desc de un campo externo de una tabla
array	get_parametros()	Retorna los parámetros con los que fue construida la conexión
PDO	get_pdo()	Retorna una referencia al objeto PDO interno
mixed	get_semantica_valor_defecto()	Devuelve el valor que es considerado por el motor para asignar el valor Default en la base.
array(sql,	get_sql_carga_descripciones()	Dada una tabla retorna la SQL que relaciona las claves con las descripciones
array(sql,	get_sql_carga_tabla()	Dada una tabla retorna la SQL de carga de la tabla y sus campos cosméticos remontando referencias usando joins
void	get_tipo_datos_generico()	Mapea un tipo de datos especifico de un motor a uno generico de toba
boolean	hay_datos()	Ejecuta una consulta sql y retorna true si existen datos Es útil cuando solo se quiere saber si una condicion se cumple o no en la base
void	quote()	Convierte un string a una representación segura para el motor. Evita
string	recuperar_secuencia()	Retorna el valor de un campo SERIAL
void	retrazar_constraints()	Fuerza a que los chequeos de CONSTRAINTS de la transacción en curso se hagan al finalizar la misma
void	sentencia()	Crea una PDO_STATEMENT y lo ejecuta.
void	sentencia_agregar_binarios()	Agrega datos binarios a una sentencia SQL preparada con 'preparar_sentencia'
integer	sentencia_cantidad_afectados()	Retorna las filas afectadas por una sentencia
array	sentencia_consultar()	Ejecuta una sentencia SQL preparada con 'preparar_sentencia'.
array	sentencia_consultar_fila()	Ejecuta una sentencia SQL preparada con 'preparar_sentencia' y retorna la primer fila del resultado
array	sentencia_datos()	Retorna un formato recordset a partir de una sentencia ejecutada
integer	sentencia_ejecutar()	Ejecuta una sentencia SQL preparada con 'preparar_sentencia'.
void	sentencia_eliminar()	Quita una SQL del arreglo de sentencias.
integer	sentencia_preparar()	Prepara una sentencia para su ejecucion posterior.
void	set_modo_debug()	Cuando la conexión esta en modo debug se imprime cada consulta/comando realizado
void	set_parser_errores()
mixed	ultimo_insert_id()	Devuelve el id del último insert en la base. Si el motor es postgres

Constructor __construct [línea 49]

toba_db __construct(
string
$profile, string
$usuario, string
$clave, string
$base, [string
$puerto = null] 
)

Parámetros:

string	$profile:	Host donde se localiza el servidor
string	$usuario:	Nombre del usuario utilizado para conectar
string	$clave:
string	$base:	Nombre de la base a conectar
string	$puerto:	(opcional) número de puerto al que se conecta

Redefinido en subclases como:

abortar_transaccion [línea 692]

void abortar_transaccion(
)

Ejecuta un ROLLBACK en la conexión

Redefinido en subclases como:

toba_db_informix::abortar_transaccion() : Ejecuta un ROLLBACK WORK en la conexión
toba_db_postgres7::abortar_transaccion()

abrir_transaccion [línea 683]

void abrir_transaccion(
)

Ejecuta un BEGIN TRANSACTION en la conexión

Redefinido en subclases como:

toba_db_informix::abrir_transaccion() : Ejecuta un BEGIN WORK en la conexión
toba_db_postgres7::abrir_transaccion()

activar_registro_consulta [línea 175]

void activar_registro_consulta(
[boolean
$desactivar_consulta = false], [boolean
$activar = true] 
)

Activa/desactiva el resgistro de los comandos de consulta.

Parámetros:

boolean	$desactivar_consulta:	Indica si se ejecuta el comando y se registra(FALSE) o si solamente se registra(TRUE). Por defecto FALSE
boolean	$activar:	TRUE activa el resgistro, FALSE desactiva el registro. Por defecto TRUE

activar_registro_ejecucion [línea 164]

void activar_registro_ejecucion(
[boolean
$desactivar_ejecucion = false], [boolean
$activar = true] 
)

Activa/desactiva el resgistro de los comandos de ejecución.

Parámetros:

boolean	$desactivar_ejecucion:	Indica si se ejecuta el comando y se registra(FALSE) o si solamente se registra(TRUE). Por defecto FALSE
boolean	$activar:	TRUE activa el resgistro, FALSE desactiva el registro. Por defecto TRUE

cerrar_transaccion [línea 701]

void cerrar_transaccion(
)

Ejecuta un COMMIT en la conexión

Redefinido en subclases como:

toba_db_informix::cerrar_transaccion() : Ejecuta un COMMIT WORK en la conexión
toba_db_postgres7::cerrar_transaccion()

conectar [línea 76]

void conectar(
)

Crea una conexion a la base

Information Tags:

Throws:

toba_error_db en caso de error

consultar [línea 358]

array consultar(
string
$sql, [string
$tipo_fetch = toba_db_fetch_asoc] 
)

Ejecuta una consulta sql

Parámetros:

string	$sql:	Consulta
string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc

Return:

Resultado de la consulta en formato recordset (filas x columnas), un arreglo vacio en caso que la consulta no retorne datos, usar if (empty($resultado)) para chequearlo

Information Tags:

Throws:

toba_error_db en caso de error

consultar_fila [línea 395]

array consultar_fila(
string
$sql, [string
$tipo_fetch = toba_db_fetch_asoc], [
$lanzar_excepcion = true] 
)

Ejecuta una consulta sql y retorna la primer fila del resultado.

Es útil cuando se sabe de antemano que el resultado es una única fila

Parámetros:

string	$sql:	Consulta SQL
string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc
	$lanzar_excepcion:

Return:

Arreglo asociativo columna=>valor, falso en caso de resultado vacio

Information Tags:

Throws:

toba_error_db en caso de error

cortar_sql [línea 1032]

void cortar_sql(

$sql 
)

Parámetros:

$sql:

Access:

protected

crear_lenguaje_procedural [línea 275]

void crear_lenguaje_procedural(
)

Crea el lenguaje plpgsql unicamente si el mismo aun no existe para la base de datos.

redefinido en los hijos

Redefinido en subclases como:

toba_db_postgres7::crear_lenguaje_procedural() : Crea el lenguaje plpgsql unicamente si el mismo aun no existe para la base de datos.

destruir [línea 67]

void destruir(
)

Libera la conexión a la base

ejecutar [línea 284]

void ejecutar(
mixed
$sql 
)

Ejecuta un comando sql o un conjunto de ellos

Parámetros:

mixed

$sql:

Comando o arreglo de comandos

Information Tags:

Throws:

toba_error_db en caso de que algun comando falle

ejecutar_archivo [línea 445]

void ejecutar_archivo(
string
$archivo 
)

Ejecuta los comandos disponibles en un archivo

Parámetros:

string

$archivo:

Path absoluto del archivo

ejecutar_transaccion [línea 712]

void ejecutar_transaccion(

$sentencias_sql, array
$sentencias 
)

Ejecuta un conjunto de comandos dentro de una transacción

En caso de error en algún comando la aborta

Parámetros:

array	$sentencias:	Conjunto de comandos sql
	$sentencias_sql:

es_campo_candidato_descripcion [línea 1004]

void es_campo_candidato_descripcion(
array
$campo 
)

Determina si la definición de un campo de una tabla es un campo descripción

Parámetros:

array

$campo:

Definicion de un campo

Access:

protected

exportar_registro [línea 186]

void exportar_registro(
[string
$archivo_ejecucion = ''], [string
$archivo_consulta = ''] 
)

Exporta el registro de los comandos de ejecución y consulta a archivos.

Parámetros:

string	$archivo_ejecucion:	Archivo al que se desea exportar el contenido del registro de ejecución.
string	$archivo_consulta:	Archivo al que se desea exportar el contenido del registro de consulta.

get_definicion_columnas [línea 758]

void get_definicion_columnas(

$tabla 
)

Parámetros:

$tabla:

Redefinido en subclases como:

toba_db_postgres7::get_definicion_columnas() : Busca la definicion de un TABLA. Cachea los resultados por un pedido de pagina

get_dsn [línea 731]

string get_dsn(
)

Retorna el dsn necesario para conectar con PDO

Redefinido en subclases como:

get_error_toba [línea 1050]

void get_error_toba(

$codigo, 
$descripcion 
)

Mapea el error de la base al modulo de mensajes del toba

Parámetros:

	$codigo:
	$descripcion:

get_info_debug [línea 150]

void get_info_debug(
)

Retorna un arreglo con informacion de las distintas consultas/comandos ejecutados

Requiere haber activado el modo debug con set_modo_debug

get_manejador_auditoria [línea 1067]

object get_manejador_auditoria(
[string
$schema_modelo = 'public'], [string
$schema_auditoria = 'public_auditoria'], [string
$schema_toba = null] 
)

Devuelve una instancia del manejador de auditoria para este motor de base de datos

ventana de extension en los hijos

Parámetros:

string	$schema_modelo:
string	$schema_auditoria:
string	$schema_toba:

Redefinido en subclases como:

toba_db_postgres7::get_manejador_auditoria() : Devuelve una instancia del manejador de auditoria para este motor de base de datos

get_opciones_sql_campo_externo [línea 968]

void get_opciones_sql_campo_externo(

$campo 
)

Determina la sql,clave y desc de un campo externo de una tabla

Remonta N-niveles de indireccion de FKs

Parámetros:

$campo:

get_parametros [línea 106]

array get_parametros(
)

Retorna los parámetros con los que fue construida la conexión

Redefinido en subclases como:

toba_db_postgres7::get_parametros()

get_pdo [línea 97]

PDO get_pdo(
)

Retorna una referencia al objeto PDO interno

get_semantica_valor_defecto [línea 247]

mixed get_semantica_valor_defecto(
)

Devuelve el valor que es considerado por el motor para asignar el valor Default en la base.

Redefinido en subclases como:

toba_db_postgres7::get_semantica_valor_defecto()

get_sql_carga_descripciones [línea 945]

array(sql, get_sql_carga_descripciones(
string
$tabla 
)

Dada una tabla retorna la SQL que relaciona las claves con las descripciones

Parámetros:

string

$tabla:

Return:

campo_clave, campo_descripcion)

get_sql_carga_tabla [línea 872]

array(sql, get_sql_carga_tabla(
string
$tabla 
)

Dada una tabla retorna la SQL de carga de la tabla y sus campos cosméticos remontando referencias usando joins

Parámetros:

string

$tabla:

Return:

campo_clave, campo_descripcion)

get_tipo_datos_generico [línea 767]

void get_tipo_datos_generico(

$tipo 
)

Mapea un tipo de datos especifico de un motor a uno generico de toba

Adaptado de ADOdb

Parámetros:

$tipo:

hay_datos [línea 435]

boolean hay_datos(
string
$sql 
)

Ejecuta una consulta sql y retorna true si existen datos Es útil cuando solo se quiere saber si una condicion se cumple o no en la base

Parámetros:

string

$sql:

Consulta SQL

Return:

Verdadero si la consulta retorna al menos una registro

Information Tags:

Throws:

toba_error_db en caso de error

quote [línea 257]

void quote(
mixed
$dato 
)

Convierte un string a una representación segura para el motor. Evita

la inyección de código malicioso dentro de la sentencia SQL

Parámetros:

mixed

$dato:

Puede ser un string o un arreglo

recuperar_secuencia [línea 740]

string recuperar_secuencia(

$secuencia 
)

Retorna el valor de un campo SERIAL

Parámetros:

$secuencia:

Redefinido en subclases como:

toba_db_postgres7::recuperar_secuencia() : Recupera el valor actual de una secuencia

retrazar_constraints [línea 749]

void retrazar_constraints(
)

Fuerza a que los chequeos de CONSTRAINTS de la transacción en curso se hagan al finalizar la misma

Redefinido en subclases como:

toba_db_postgres7::retrazar_constraints()

sentencia [línea 333]

void sentencia(
string
$sql, [mixed
$parametros = null] 
)

Crea una PDO_STATEMENT y lo ejecuta.

Parámetros:

string	$sql:	Consulta
mixed	$parametros:	Arreglo de parametros para el statement. Si el SQL poseia marcadores de tipo '?', hay que pasar un array posicional, si poseia marcadores de tipo 'nombre:', hay que pasar un array asociativo.

Information Tags:

Throws:

toba_error_db en caso de que algun comando falle

sentencia_agregar_binarios [línea 501]

void sentencia_agregar_binarios(
integer
$id, [array
$binarios = array()] 
)

Agrega datos binarios a una sentencia SQL preparada con 'preparar_sentencia'

Parámetros:

integer	$id:	ID de la sentencia
array	$binarios:	Arreglo con los resource apuntando a los binarios

Information Tags:

Throws:

toba_error en caso de que alguno de los parametros no se pueda agregar

sentencia_cantidad_afectados [línea 668]

integer sentencia_cantidad_afectados(
integer
$id 
)

Retorna las filas afectadas por una sentencia

Parámetros:

integer

$id:

ID de la sentencia

Return:

Cantidad de registros afectados

sentencia_consultar [línea 576]

array sentencia_consultar(
integer
$id, [array
$parametros = null], [string
$tipo_fetch = toba_db_fetch_asoc] 
)

Ejecuta una sentencia SQL preparada con 'preparar_sentencia'.

Parámetros:

string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc
integer	$id:	ID de la sentencia
array	$parametros:	Arreglo con parametros de la sentencia

Return:

Resultado de la consulta en formato recordset (filas x columnas), un arreglo vacio en caso que la consulta no retorne datos, usar if (empty($resultado)) para chequearlo

Information Tags:

Throws:

toba_error_db en caso de error

sentencia_consultar_fila [línea 615]

array sentencia_consultar_fila(
integer
$id, [array
$parametros = null], [string
$tipo_fetch = toba_db_fetch_asoc], [
$lanzar_excepcion = true] 
)

Ejecuta una sentencia SQL preparada con 'preparar_sentencia' y retorna la primer fila del resultado

Parámetros:

string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc
integer	$id:	ID de la sentencia
array	$parametros:	Arreglo con parametros de la sentencia
	$lanzar_excepcion:

Return:

Resultado de la consulta en formato recordset (filas x columnas), un arreglo vacio en caso que la consulta no retorne datos, usar if (empty($resultado)) para chequearlo

Information Tags:

Throws:

toba_error_db en caso de error

sentencia_datos [línea 651]

array sentencia_datos(
integer
$id, [string
$tipo_fetch = toba_db_fetch_asoc] 
)

Retorna un formato recordset a partir de una sentencia ejecutada

Parámetros:

string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc
integer	$id:	ID de la sentencia

Return:

Resultado de la consulta en formato recordset (filas x columnas)

sentencia_ejecutar [línea 537]

integer sentencia_ejecutar(
integer
$id, [array
$parametros = null], string
$tipo_fetch 
)

Ejecuta una sentencia SQL preparada con 'preparar_sentencia'.

Parámetros:

string	$tipo_fetch:	Modo Fetch de ADO, por defecto toba_db_fetch_asoc
integer	$id:	ID de la sentencia
array	$parametros:	Arreglo con parametros de la sentencia

Return:

Cantidad de registros afectados

Information Tags:

Throws:

toba_error_db en caso de error

sentencia_eliminar [línea 523]

void sentencia_eliminar(
integer
$id 
)

Quita una SQL del arreglo de sentencias.

Se usa para liberar el resource de un blob y poder seguir operando con el archivo.

Parámetros:

integer

$id:

Identificador de la sentencia.

sentencia_preparar [línea 479]

integer sentencia_preparar(
string
$sql, [array
$opciones = array()] 
)

Prepara una sentencia para su ejecucion posterior.

Parámetros:

string	$sql:	Consulta SQL
array	$opciones:	Arreglo con parametros del driver

Return:

ID de la sentencia, necesario para ejecutarla posteriormente con 'ejecutar_sentencia($id)'

Information Tags:

Throws:

toba_error_db en caso de error

set_modo_debug [línea 120]

void set_modo_debug(
[
$debug = true], [boolean
$loguear = true] 
)

Cuando la conexión esta en modo debug se imprime cada consulta/comando realizado

Parámetros:

boolean	$loguear:	No deja las querys en el logger, solo se mantienen durante el pedido de página
	$debug:

set_parser_errores [línea 59]

void set_parser_errores(
toba_parser_error_db
$parser 
)

Parámetros:

toba_parser_error_db

$parser:

ultimo_insert_id [línea 462]

mixed ultimo_insert_id(
[string
$secuencia = null] 
)

Devuelve el id del último insert en la base. Si el motor es postgres

se debe indicar la secuencia correspondiente para tener resultados significativos

Parámetros:

string

$secuencia:

Nombre de la secuencia que tiene asociada el id

	Centrales \| Componentes \| Debug \| Fuentes \| SalidaGrafica \| Seguridad \| Varios

[ árbol de herencia: Fuentes ] [ índice: Fuentes ] [ índice general ]