A continuación, se muestra un listado de las 12 constantes disponibles en el método inicializar() de la clase Configuracion para inicializar la configuración del ORM PIPE.
Constante | Descripción |
---|---|
BD_CONTROLADOR | Establece el controlador de la conexión. Soporta mysql, pgsql, sqlite y sqlsrv. |
BD_HOST | Establece la IP o DNS del servidor de bases de datos. |
BD_PUERTO | Establece el puerto donde se ejecuta el servicio. |
BD_USUARIO | Establece el usuario de la base de datos. |
BD_CONTRASENA | Establece la contraseña de la base de datos. |
BD_BASEDATOS | Establece el nombre de la base de datos que será utilizada. |
IDIOMA | Establece el idioma para mostrar errores SQL y mensajes del ORM PIPE. Soporta es, en. |
RUTA_MODELOS | Establece la ruta donde se encuentran los modelos. Ejemplo: C:\xampp\htdocs\mi-proyecto\modelos. |
ZONA_HORARIA | Establece la zona horaria para registrar la marca de tiempo. Ejemplo: America/Bogota. El valor por defecto es UTC. |
COMANDO_INICIAL | Establece la sentencia SQL que será ejecutada una vez se establezca la conexión. |
TIPO_RETORNO | Establece el tipo de retorno de datos por defecto. Se pueden utilizar las constantes CLASE, OBJETO, ARREGLO, JSON y SQL de la clase Configuracion. |
OPCIONES | Establece opciones de conexión específicas del controlador por medio de un arreglo, según las especificaciones de PDO. |
PIPE es muy sencillo de configurar.
Si hemos instalado PIPE por medio de composer, debemos incluir el archivo vendor/autoload.php en nuestro código de programación para poder utilizar el ORM PIPE.
Si por el contrario, hemos instalado PIPE manualmente, debemos incluir el archivo src/PIPE/inicializador.php que se encuentra en la raíz del código fuente descargado.
Para configurar el ORM PIPE, inicializamos la configuración de la siguiente manera.
<?php
require_once __DIR__.'/vendor/autoload.php';
use PIPE\Clases\PIPE;
use PIPE\Clases\Configuracion;
Configuracion::inicializar(
[
'BD_CONTROLADOR' => 'mysql',
'BD_HOST' => 'localhost',
'BD_PUERTO' => '3306',
'BD_USUARIO' => 'root',
'BD_CONTRASENA' => 'contrasena',
'BD_BASEDATOS' => 'pipe',
'IDIOMA' => 'es',
'RUTA_MODELOS' => 'ruta/completa/a/mis/modelos',
'ZONA_HORARIA' => 'America/Bogota',
'COMANDO_INICIAL' => 'set names utf8mb4 collate utf8mb4_unicode_ci',
'TIPO_RETORNO' => Configuracion::CLASE,
'OPCIONES' => [PDO::MYSQL_ATTR_LOCAL_INFILE => 1]
]
);
/**
* Finalmente, verificamos que hemos inicializado la configuración correctamente
* imprimiendo la versión del ORM PIPE.
*/
echo PIPE::VERSION;
PIPE permite configurar múltiples conexiones de la siguiente manera.
<?php
require_once __DIR__.'/vendor/autoload.php';
use PIPE\Clases\PIPE;
use PIPE\Clases\Configuracion;
$conexiones = [
'mysql' => [
'BD_CONTROLADOR' => 'mysql',
'BD_HOST' => 'localhost',
'BD_PUERTO' => '3306',
'BD_USUARIO' => 'root',
'BD_CONTRASENA' => 'contrasena',
'BD_BASEDATOS' => 'pipe',
'IDIOMA' => 'es',
'RUTA_MODELOS' => 'ruta/completa/a/mis/modelos',
'ZONA_HORARIA' => 'America/Bogota',
'COMANDO_INICIAL' => 'set names utf8mb4 collate utf8mb4_unicode_ci',
'TIPO_RETORNO' => Configuracion::CLASE,
'OPCIONES' => [PDO::MYSQL_ATTR_LOCAL_INFILE => 1]
],
'pgsql' => [
'BD_CONTROLADOR' => 'pgsql',
'BD_HOST' => 'localhost',
'BD_PUERTO' => '5432',
'BD_USUARIO' => 'root',
'BD_CONTRASENA' => 'contrasena',
'BD_BASEDATOS' => 'pipe',
'IDIOMA' => 'es',
'RUTA_MODELOS' => 'ruta/completa/a/mis/modelos',
'ZONA_HORARIA' => 'America/Bogota',
'TIPO_RETORNO' => Configuracion::CLASE
]
];
// El segundo parámetro indica la conexión por defecto que será utilizada.
Configuracion::inicializar($conexiones, 'mysql');
/**
* Finalmente, verificamos que hemos inicializado la configuración correctamente
* imprimiendo la versión del ORM PIPE.
*/
echo PIPE::VERSION;