|
1 | 1 | <?php |
2 | 2 |
|
| 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 | + |
3 | 13 | namespace PhobosFramework\Database\Connection; |
4 | 14 |
|
5 | 15 | use PDO; |
| 16 | +use PDOException; |
6 | 17 | use PDOStatement; |
7 | 18 | use PhobosFramework\Database\Drivers\DriverInterface; |
| 19 | +use PhobosFramework\Database\Exceptions\ConnectionException; |
8 | 20 |
|
9 | 21 | /** |
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. |
11 | 26 | */ |
12 | 27 | interface ConnectionInterface { |
13 | 28 | /** |
14 | | - * Conecta a la base de datos |
| 29 | + * Establece la conexión con la base de datos. |
15 | 30 | * |
16 | 31 | * @return void |
| 32 | + * @throws ConnectionException Si la conexión falla |
17 | 33 | */ |
18 | 34 | public function connect(): void; |
19 | 35 |
|
20 | 36 | /** |
21 | | - * Desconecta de la base de datos |
| 37 | + * Cierra la conexión con la base de datos. |
22 | 38 | * |
23 | 39 | * @return void |
24 | 40 | */ |
25 | 41 | public function disconnect(): void; |
26 | 42 |
|
27 | 43 | /** |
28 | | - * Verifica si está conectado |
| 44 | + * Verifica si hay una conexión activa con la base de datos. |
29 | 45 | * |
30 | 46 | * @return bool |
31 | 47 | */ |
32 | 48 | public function isConnected(): bool; |
33 | 49 |
|
34 | 50 | /** |
35 | | - * Obtiene la instancia PDO |
| 51 | + * Obtiene la instancia PDO de la conexión actual. |
36 | 52 | * |
37 | 53 | * @return PDO |
38 | 54 | */ |
39 | 55 | public function getPDO(): PDO; |
40 | 56 |
|
41 | 57 | /** |
42 | | - * Ejecuta una query y retorna el statement |
| 58 | + * Ejecuta una consulta SQL preparada y retorna el objeto PDOStatement resultante. |
43 | 59 | * |
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 |
46 | 62 | * @return PDOStatement |
| 63 | + * @throws PDOException Si ocurre un error durante la ejecución |
47 | 64 | */ |
48 | 65 | public function execute(string $sql, array $params = []): PDOStatement; |
49 | 66 |
|
50 | 67 | /** |
51 | | - * Ejecuta una query y retorna todas las filas |
| 68 | + * Ejecuta una consulta SQL y retorna todas las filas del resultado. |
52 | 69 | * |
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 |
55 | 72 | * @return array |
56 | 73 | */ |
57 | 74 | public function query(string $sql, array $params = []): array; |
58 | 75 |
|
59 | 76 | /** |
60 | | - * Ejecuta una query y retorna la primera fila |
| 77 | + * Ejecuta una consulta SQL y retorna la primera fila del resultado. |
61 | 78 | * |
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 |
64 | 81 | * @return array|null |
65 | 82 | */ |
66 | 83 | public function queryFirst(string $sql, array $params = []): ?array; |
67 | 84 |
|
68 | 85 | /** |
69 | | - * Inicia una transacción |
| 86 | + * Inicia una nueva transacción en la base de datos. |
70 | 87 | * |
71 | 88 | * @return bool |
72 | 89 | */ |
73 | 90 | public function beginTransaction(): bool; |
74 | 91 |
|
75 | 92 | /** |
76 | | - * Commitea una transacción |
| 93 | + * Confirma la transacción actual en la base de datos. |
77 | 94 | * |
78 | 95 | * @return bool |
79 | 96 | */ |
80 | 97 | public function commit(): bool; |
81 | 98 |
|
82 | 99 | /** |
83 | | - * Hace rollback de una transacción |
| 100 | + * Revierte la transacción actual en la base de datos. |
84 | 101 | * |
85 | 102 | * @return bool |
86 | 103 | */ |
87 | 104 | public function rollback(): bool; |
88 | 105 |
|
89 | 106 | /** |
90 | | - * Verifica si está en una transacción |
| 107 | + * Verifica si hay una transacción activa en la base de datos. |
91 | 108 | * |
92 | 109 | * @return bool |
93 | 110 | */ |
94 | 111 | public function inTransaction(): bool; |
95 | 112 |
|
96 | 113 | /** |
97 | | - * Obtiene el último ID insertado |
| 114 | + * Retorna el ID del último registro insertado en la base de datos. |
98 | 115 | * |
99 | | - * @param string|null $sequence Nombre de secuencia (para PostgreSQL) |
| 116 | + * @param string|null $sequence Nombre de la secuencia (requerido para PostgreSQL) |
100 | 117 | * @return string|false |
101 | 118 | */ |
102 | 119 | public function lastInsertId(?string $sequence = null): string|false; |
103 | 120 |
|
104 | 121 | /** |
105 | | - * Obtiene el nombre de la conexión |
| 122 | + * Retorna el nombre identificador de la conexión actual. |
106 | 123 | * |
107 | 124 | * @return string |
108 | 125 | */ |
109 | 126 | public function getName(): string; |
110 | 127 |
|
111 | 128 | /** |
112 | | - * Obtiene el driver utilizado |
| 129 | + * Retorna el nombre del controlador de base de datos utilizado. |
113 | 130 | * |
114 | 131 | * @return string |
115 | 132 | */ |
116 | 133 | public function getDriverName(): string; |
117 | 134 |
|
118 | 135 | /** |
119 | | - * Obtiene la instancia del driver |
| 136 | + * Retorna la instancia del controlador de base de datos. |
120 | 137 | * |
121 | 138 | * @return DriverInterface |
122 | 139 | */ |
|
0 commit comments