The WebAbility® Network Developers - Documentation
WebAbility Site
\dominion\DB_Base Reference

I. Structure:


Class tree:
  • WAObject
  • DB_Base

Known subclases:
none

II. Using the class:


This class is used to create an instance for each database connection you need.
You may connect to one of the following databases supported by Dominion:

Oracle, Postgres, Microsoft SQL Server, MySQL, Informix, Interbase, Sybase or SQLite.

A database connector is defined with 4 parameters:
- A database brand.
- A database name.
- A username.
_ A password.

Once the connector is defined you may execute any order to the database with it and manage transactions (commit/rollback) if the database engine support it.


III. Reference:


3.1. Constants:


3.1.1. Database brands constants


ORACLE Used to identify an Oracle database through OCI driver
POSTGRES Used to identify a PostgreSQL database
MSSQL Used to identify a Microsoft SQL Server database
MYSQL Used to identify a MySQL old version driver database
MYSQLi Used to identify a MySQL database with new object driver
INFORMIX Used to identify an Informix database
INTERBASE Used to identify an Interbase database
SYBASE Used to identify a Sybase database
DB2 Used to identify an IBM DB2 database
SQLITE Used to identify a SQLite database


3.1.2. Connector properties constants


IFODBC Used to connect through an ODBC object
IFPERSISTENT Used to determine if the connector will be persistent in time
IFPDO Used to connect through a PDO object

The properties are combinable with an OR operator


3.2. Methods:


void __construct($type, $flags)

Crea el conector para utilizar uno de los tipos de Base de Datos soportados por Dominion.

* $type: identificador para el tipo del DBMS a utilizar. Por definición se emplea ~MySQL.
* $flags: opciones que puede necesitar el conector. ||

|| void | __destruct()

Método encargado de dar de baja al conector, desconectándolo del DBMS. ||

|| String | __toString()

Devuelve el identificador de la Base de Datos a utilizar.||

|| Boolean | beginTransaction()

Alista al objeto para iniciar una nueva transacción, esto se da en caso de que el conector soporte la instrucción ~RollBack. Devuelve un valor True cuando el conector se encuentra listo. ||

|| String | checkLogon()

Verifica que la conexión sea válida, en caso contrario se establece la conexión con los últimos parámetros introducidos y devuelve el objeto recurso identificador de la Base de Datos. ||

|| Boolean | doCommit()

Confirma las transacciones pendientes, esto se da en caso de que el conector soporte la instrucción "~RollBack". Devuelve un valor "True" en caso de éxito. ||

|| String | doLogon($UN, $PW, $DB, $Extra)

Establece la conexión con la Base de Datos y devuelve el objeto recurso para el tipo de Base de Datos.

* $UN: nombre de usuario para la conexión a la Base de Datos.
* $PW: contraseña del usuario.
* $DB: nombre de la Base de Datos a utilizar.
* $Extra: opciones especiales de conexión en caso de que sean necesarias. ||

|| Boolean | doRollBack()

Restablece todas las transacciones sin confirmar en caso de que el conector soporte la instrucción "~RollBack". Devuelve un valor "True" en caso de éxito. ||

|| String | getDataBaseName()

Devuelve el nombre de la Base de Datos que se utiliza para el objeto.||

|| String | getId()

Devuelve un ID para cada objeto creado por la clase DB_Base que se utilice en el sistema. ||

|| Boolean | getODBC()

Devuelve un valor True si el conector utiliza ODBC. ||

|| Boolean| getPersistent()

Devuelve un valor True si existe persistencia con la Base de Datos. ||

|| Integer | getType()

Devuelve un valor numérico para identificar el tipo de DBMS que utiliza el conector. ||

|| String | getUserName()

Devuelve el nombre de usuario con el cual se realiza la conexión con la Base de Datos. ||

|| Boolean | logOff($destructing)

Cierra la conexión con la Base de Datos sólo si esta es del tipo No persistente.

* $destructing: bandera que indica si es llamado por el destructor. Por definición tiene el valor False .||

|| void | selectDB()

Selecciona la Base de Datos indicada desde setLogon o doLogon. ||

|| void | setLogon($UN, $PW, $DB, $Extra)

Establece los parámetros de conexión para la Base de Datos a utilizar.

* $UN: nombre de usuario para la conexión a la Base de Datos.
* $PW: contraseña del usuario.
* $DB: nombre de la Base de Datos a utilizar.
* $Extra: opciones especiales de conexión en caso de que sean necesarias. ||

|| String | useID($id, $flags)

Intercambia la conexión con otra Base de Datos establecida en el objeto recurso de conexión devolviendo el mismo identificador.

* $id: identificador para el objeto recurso de conexión para la Base de Datos.
* $flags: opciones para el conector. ||
|#


 

=Ejemplo:

=

El siguiente ejemplo muestra cómo se construye un conector a una Base de Datos de ~MySQL.

%%
<#








<?php

Se incluyen las librerias a necesitar por medio de la clase autoload.lib
include_once $BASEDIR."/include/common/
autoload.lib";

Se crea el conector a MySQL
$BD = new DB_Base(DB_Base::MYSQL);

Se inicia la sesion con usuario=usuario1, password=password1, BD=dominion1,
$BD->doLogon('usuario1', 'password1', 'dominion1');

...

print "Nombre de la BD: ".$BD->getDataBaseName();
print "<br />";
print "Numero identificador de conexion a la BD: ".$BD->getId();
print "<br />";
print "Tipo de conector con la BD: ".$BD->getType();
print "<br />";
print "Nombre del usuario que realiza la conexion: ".$BD->getUserName();
print "<br />";

?>



#>%%


%%Para el caso de otros DBMS, el procedimiento es casi el mismo, dependiendo del tipo de DBMS, algunos solicitan opciones especiales de conexión.%%