Skip to content
This repository was archived by the owner on Oct 10, 2023. It is now read-only.

phpdoc datos bd

Gabriel edited this page Jun 12, 2021 · 2 revisions

\datos\bd

Interfaz para las clases del origen de datos.

Métodos

__construct([$conectar,$servidor,$usuario,$contrasena,$nombre,$prefijo,$puerto])

Constructor. Los parámetros omitidos o nulos serán recuperados desde \configuracion.

Parámetro Tipo Descripción Opcional Predeterminado
$conectar bool Conectar inmediatamente. Si false
$servidor string Dirección del servidor. Si null
$usuario string Nombre de usuario. Si null
$contrasena string Contraseña. Si null
$nombre string Nombre de la base de datos. Si null
$prefijo string Prefijo de las tablas (el prefijo #__ en los nombres de tablas será reemplazado automáticamente por este valor). Si null
$puerto int Puerto del servidor. Si 3306

__destruct()

Destructor.

fabricarConstructor()

Fabrica y devuelve una instancia del constructor de consultas.
Devuelve: \datos\constructor

obtenerId()

Devuelve el último ID insertado.
Devuelve: int

obtenerNumeroFilas()

Devuelve el número de filas afectadas por la última consulta, ya sea una selección (cantidad de filas seleccionadas) como una actualización (cantidad de filas afectadas.)
Devuelve: int

obtenerError()

Devuelve la descripción del último error.
Devuelve: string

obtenerNumeroError()

Devuelve el número o código del último error.
Devuelve: int

establecerCredenciales([$servidor,$usuario,$contrasena,$nombre,$prefijo,$puerto])

Establece las credenciales. Los parámetros omitidos o nulos serán recuperados desde \configuracion. No afectará la conexión actualmente establecida.

Parámetro Tipo Descripción Opcional Predeterminado
$servidor string Dirección del servidor. Si null
$usuario string Nombre de usuario. Si null
$contrasena string Contraseña. Si null
$nombre string Nombre de la base de datos. Si null
$prefijo string Prefijo de las tablas (el prefijo #__ en los nombres de tablas será reemplazado automáticamente por este valor). Si null
$puerto int Puerto del servidor. Si 3306

Devuelve: \datos\bd

conectar()

Abre la conexión a la base de datos.
Devuelve: \datos\bd

desconectar()

Cierra la conexión a la base de datos.
Devuelve: \datos\bd

reemplazarPrefijo($q)

Reemplaza el prefijo #__ antes de los nombres de tabla por el prefijo real de las mismas.

Parámetro Tipo Descripción Opcional Predeterminado
$q string Consulta.

Devuelve: string

comenzarTransaccion($modo)

Abre una transacción.

Parámetro Tipo Descripción Opcional Predeterminado
$modo

Devuelve: \datos\bd

finalizarTransaccion()

Finaliza la transacción.
Devuelve: \datos\bd

descartarTransaccion()

Revierte y descarta la transacción.
Devuelve: \datos\bd

bloquear($modo,$tablas[,$alias])

Bloquea las tablas.

Parámetro Tipo Descripción Opcional Predeterminado
$modo string Modo: 'bd::soloLectura' o 'bd::lecturaEscritura'.
$tablas array Tablas a bloquear. Cada elemento puede ser una cadena (nombre de la tabla) o un arreglo [tabla,alias].
$alias null No aplica. Si null

Devuelve: \datos\bd

Sobrecarga 2: bloquear($modo,$tablas[,$alias])

Bloquea las tablas.

Parámetro Tipo Descripción Opcional Predeterminado
$modo string Modo: 'bd::soloLectura' o 'bd::lecturaEscritura'.
$tablas string Nombre de la tabla a bloquear (solo una).
$alias string Alias (solo uno). Si null

Devuelve: \datos\bd

desbloquear()

Desbloquea las tablas.
Devuelve: \datos\bd

consulta($q[,$parametros,$tipos])

Ejecuta una consulta MySQL y devuelve una instancia de resultado. Pueden utilizarse parámetros con nombre precedidos por @ y la cadena #__ previo a un nombre de tabla representando el prefijo.

Parámetro Tipo Descripción Opcional Predeterminado
$q
$parametros Si null
$tipos Si null

Devuelve: \datos\resultado

preparar($q[,$parametros,$tipos])

Comienza una consulta preparada. Pueden utilizarse parámetros con nombre precedidos por @ y la cadena #__ previo a un nombre de tabla representando el prefijo.

Parámetro Tipo Descripción Opcional Predeterminado
$q
$parametros Si null
$tipos Si null

Devuelve: \datos\bd

actualizarParametros($parametros)

Actualiza los valores de los parámetros para volver a ejecutar la consulta preparada.

Parámetro Tipo Descripción Opcional Predeterminado
$parametros

Devuelve: \datos\bd

establecer($resultado)

Establece el resultado de una consulta anterior para continuar con su ejecución (ej. tras utilizar una consulta preparada).

Parámetro Tipo Descripción Opcional Predeterminado
$resultado \datos\resultado Resultado.

Devuelve: \datos\bd

ejecutar()

Ejecuta una sentencia preparada y devuelve una instancia de resultado.
Devuelve: \datos\resultado

asignar($parametros[,$tipos])

Asigna nuevos parámetros a una sentencia preparada.

Parámetro Tipo Descripción Opcional Predeterminado
$parametros array Array de parámetros ordenados.
$tipos string Cadena de tipos (i, d, s, b). Opcional, si se omite, se autodetectarán los tipos. Si null

Devuelve: \datos\bd

liberar()

Destruye la sentencia preparada.
Devuelve: \datos\bd

escapar($cadena)

Escapa los caracteres especiales de una cadena para usarla en una sentencia SQL, tomando en cuenta el conjunto de caracteres actual de la conexión.

Parámetro Tipo Descripción Opcional Predeterminado
$cadena string

Devuelve: string

Clone this wiki locally