Skip to content

Commit 76fe768

Browse files
committed
Añade encabezados de documentación y comentarios mejorados en componentes relacionados con la capa de base de datos (QueryBuilderInterface, Clauses, Excepciones, y helpers generales). Refactoriza descripciones de métodos para mayor claridad y consistencia.
1 parent 22afe08 commit 76fe768

39 files changed

+2357
-571
lines changed

src/Connection/ConnectionInterface.php

Lines changed: 40 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,122 +1,139 @@
11
<?php
22

3+
/**
4+
* # Phobos Framework
5+
*
6+
* Para la información completa acerca del copyright y la licencia,
7+
* por favor vea el archivo LICENSE que se distribuye con este código fuente.
8+
*
9+
* @author Marcel Rojas <[email protected]>
10+
* @copyright Copyright (c) 2012-2025, Marcel Rojas <[email protected]>
11+
*/
12+
313
namespace PhobosFramework\Database\Connection;
414

515
use PDO;
16+
use PDOException;
617
use PDOStatement;
718
use PhobosFramework\Database\Drivers\DriverInterface;
19+
use PhobosFramework\Database\Exceptions\ConnectionException;
820

921
/**
10-
* Interface para manejar conexiones a base de datos
22+
* Interface que define los métodos necesarios para gestionar conexiones a bases de datos.
23+
*
24+
* Esta interfaz proporciona los métodos esenciales para establecer y administrar
25+
* conexiones a bases de datos, ejecutar consultas y gestionar transacciones.
1126
*/
1227
interface ConnectionInterface {
1328
/**
14-
* Conecta a la base de datos
29+
* Establece la conexión con la base de datos.
1530
*
1631
* @return void
32+
* @throws ConnectionException Si la conexión falla
1733
*/
1834
public function connect(): void;
1935

2036
/**
21-
* Desconecta de la base de datos
37+
* Cierra la conexión con la base de datos.
2238
*
2339
* @return void
2440
*/
2541
public function disconnect(): void;
2642

2743
/**
28-
* Verifica si está conectado
44+
* Verifica si hay una conexión activa con la base de datos.
2945
*
3046
* @return bool
3147
*/
3248
public function isConnected(): bool;
3349

3450
/**
35-
* Obtiene la instancia PDO
51+
* Obtiene la instancia PDO de la conexión actual.
3652
*
3753
* @return PDO
3854
*/
3955
public function getPDO(): PDO;
4056

4157
/**
42-
* Ejecuta una query y retorna el statement
58+
* Ejecuta una consulta SQL preparada y retorna el objeto PDOStatement resultante.
4359
*
44-
* @param string $sql SQL a ejecutar
45-
* @param array $params Parámetros para binding
60+
* @param string $sql Consulta SQL a ejecutar
61+
* @param array $params Arreglo de parámetros para la consulta preparada
4662
* @return PDOStatement
63+
* @throws PDOException Si ocurre un error durante la ejecución
4764
*/
4865
public function execute(string $sql, array $params = []): PDOStatement;
4966

5067
/**
51-
* Ejecuta una query y retorna todas las filas
68+
* Ejecuta una consulta SQL y retorna todas las filas del resultado.
5269
*
53-
* @param string $sql SQL a ejecutar
54-
* @param array $params Parámetros para binding
70+
* @param string $sql Consulta SQL a ejecutar
71+
* @param array $params Parámetros para la consulta preparada
5572
* @return array
5673
*/
5774
public function query(string $sql, array $params = []): array;
5875

5976
/**
60-
* Ejecuta una query y retorna la primera fila
77+
* Ejecuta una consulta SQL y retorna la primera fila del resultado.
6178
*
62-
* @param string $sql SQL a ejecutar
63-
* @param array $params Parámetros para binding
79+
* @param string $sql Consulta SQL a ejecutar
80+
* @param array $params Parámetros para la consulta preparada
6481
* @return array|null
6582
*/
6683
public function queryFirst(string $sql, array $params = []): ?array;
6784

6885
/**
69-
* Inicia una transacción
86+
* Inicia una nueva transacción en la base de datos.
7087
*
7188
* @return bool
7289
*/
7390
public function beginTransaction(): bool;
7491

7592
/**
76-
* Commitea una transacción
93+
* Confirma la transacción actual en la base de datos.
7794
*
7895
* @return bool
7996
*/
8097
public function commit(): bool;
8198

8299
/**
83-
* Hace rollback de una transacción
100+
* Revierte la transacción actual en la base de datos.
84101
*
85102
* @return bool
86103
*/
87104
public function rollback(): bool;
88105

89106
/**
90-
* Verifica si está en una transacción
107+
* Verifica si hay una transacción activa en la base de datos.
91108
*
92109
* @return bool
93110
*/
94111
public function inTransaction(): bool;
95112

96113
/**
97-
* Obtiene el último ID insertado
114+
* Retorna el ID del último registro insertado en la base de datos.
98115
*
99-
* @param string|null $sequence Nombre de secuencia (para PostgreSQL)
116+
* @param string|null $sequence Nombre de la secuencia (requerido para PostgreSQL)
100117
* @return string|false
101118
*/
102119
public function lastInsertId(?string $sequence = null): string|false;
103120

104121
/**
105-
* Obtiene el nombre de la conexión
122+
* Retorna el nombre identificador de la conexión actual.
106123
*
107124
* @return string
108125
*/
109126
public function getName(): string;
110127

111128
/**
112-
* Obtiene el driver utilizado
129+
* Retorna el nombre del controlador de base de datos utilizado.
113130
*
114131
* @return string
115132
*/
116133
public function getDriverName(): string;
117134

118135
/**
119-
* Obtiene la instancia del driver
136+
* Retorna la instancia del controlador de base de datos.
120137
*
121138
* @return DriverInterface
122139
*/

0 commit comments

Comments
 (0)