PHP Classes
elePHPant
Icontem

File: README.md

Recommend this page to a friend!
Stumble It! Stumble It! Bookmark in del.icio.us Bookmark in del.icio.us
  Classes of Unay Santisteban  >  Database PDO Abstract Layer  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Readme
Class: Database PDO Abstract Layer
Run queries with PDO and get results in XML, JSON
Author: By
Last change: Update README.md
Date: 1 year ago
Size: 5,096 bytes
 

Contents

Class file image Download

database-pdo-class

Capa de abstracción de acceso a base de datos (PDO), permite realizar consultas a diferentes sistemas de base de datos usando una misma interfaz.

Los sistemas de Base de Datos soportados son: http://www.php.net/manual/es/pdo.drivers.php

Configuración

Bien, lo primero que debemos hacer para usar la capa de abstracción, es crear una nueva clase a la que llamaremos Config y que contendrá los parámetros de configuración de la BD, así como otros valores de configuración para nuestra aplicación web.

class Config {
    public $driver = 'mysql';
    public $dbhost = 'localhost';
    public $dbuser = 'usuario_basedatos';
    public $dbpass = 'clave_basedatos';
    public $dbname = 'nombre_basedatos';
    public $prefix = 'pr_';
}

Una vez que hemos configurado los datos de acceso, debemos importar la configuración y la capa de abstracción:

require 'configuration.php';
require 'database.pdo.class.php';

Uso

Ahora ya podemos usar la capa con total libertad, por ejemplo si queremos realizar una consulta a una tabla primero debemos obtener una instancia de la capa de abstracción, luego definir la consulta que deseamos realizar y finalmente seleccionar como queremos obtener los datos:

$db = database::getInstance();
$db->query('SELECT * FROM #__users');
$usuarios = $db->loadObjectList();

En el código de arriba vemos que primero obtenemos una instancia, luego ejecutamos la consulta usando como prefijo #__, esto es sustituido por el prefijo configurado en el archivo de configuracion. Finalmente obtenemos los datos en forma de lista de objetos.

Esta clase nos permite obtener los datos de las siguientes maneras:

  • Objeto unico:loadObject();
  • Lista de objetos:loadObjectList();
  • Array asociada:loadAssocRow();
  • Lista de arrays arrociadas:loadAssocList();
  • Array indexado: loadIndexedRow();
  • Lista de arrays indexados: loadIndexedList();
  • Objeto JSON: loadJsonObject();
  • Lista de Objetos JSON: loadJsonObjectList();
  • Documento XML: loadXmlDocument();

Podemos realizar consultas preparadas de forma fácil y sencilla, usando el mismo método query(), al cual le pasaremos la consulta preparada y un array opcional con los parámetros de dicha consulta:

$db = database::getInstance();
$sql = "SELECT * FROM #__users WHERE id = :id";
$params = array(':id' => 2);
$db->query($sql,$params);
$result = $db->loadObject();

Formato JSON

Podemos obterner los datos de la BD en formato JSON con el metodo loadJsonObjectList(), el resultado sera algo asi:

[
    {"id":"1","nombre":"Homer J.","apellido":"Simpson"},
    {"id":"2","nombre":"Walter","apellido":"White"},
    {"id":"3","nombre":"Sheldon","apellido":"Cooper"}
]

Formato XML

Tambien tenemos la posibilidad de obtener los datos en formato XML usando el metodo loadXmlDocument():

<?xml version="1.0" encoding="UTF-8"?>
<usuarios>
    <usuario>
        <id>1</id>
        <nombre>Homer J.</nombre>
        <apellido>Simpson</apellido>
    </usuario>
    <usuario>
        <id>2</id>
        <nombre>Walter</nombre>
        <apellido>White</apellido>
    </usuario>
    <usuario>
        <id>3</id>
        <nombre>Sheldon</nombre>
        <apellido>Cooper</apellido>
    </usuario>
</usuarios>

Opcionalmente podemos exportar nuestro XML generado a un archivo externo pasandole el nombre del archivo a la funcion loadXmlDocument() por ejemplo:

$db->loadXmlDocument('userlist.xml');

Formato CSV

Podemos exportar los datos de nuestra consulta a un documento csv facilmente usando el metodo loadCSVFile() al cual le pasaremos el nombre del archivo .csv donde se exportaran los datos.

$db->loadCSVFile('userlist');

Nos generara "userlist.csv".

1, "Homer J.", Simpson
2, Walter, White
3, Sheldon, Cooper

Transacciones

También podemos realizar transacciones de una manera muy sencilla usando los métodos startTransaction() y endTransaction() tal y como vemos en el ejemplo:

$db = database::getInstance();
$db->startTransaction();
$db->query("INSERT INTO #__users VALUES (NULL, 'Tyrande', 'Whisperwind')");
$db->query("INSERT INTO #__users VALUES (NULL, 'Vincent', 'Vega')");
$db->endTransaction();

El método startTransaction() inicia la transacción y activa la escucha de errores para que cuando se ejecute el método endTransaction() se ejecute commit() si todo a ido bien o rollback() a ocurrido algún fallo en las consultas.

Errores

Esta clase también nos permite obtener los posibles errores de cada consulta usando el método getError(), que nos devolverá un array asociativo con el código de error y la descripción de dicho error:

$db = database::getInstance();
$db->query('SELECT * FROM #__sers');
$error = $db->getError();
var_dump($error);

Al imprimir la variable error veremos:

array (size=2)
  'code' => int 1146
  'desc' => string "Table 'test.pr_sers' doesn't exist" (length=34)