Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hectororm/connection
Hector Connection is the PDO connection module of Hector ORM. Can be used independently of ORM.
https://github.com/hectororm/connection
connection orm pdo php php8 sql
Last synced: 3 months ago
JSON representation
Hector Connection is the PDO connection module of Hector ORM. Can be used independently of ORM.
- Host: GitHub
- URL: https://github.com/hectororm/connection
- Owner: hectororm
- License: mit
- Created: 2021-01-26T21:02:03.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-09-25T15:01:52.000Z (4 months ago)
- Last Synced: 2024-10-16T01:22:00.679Z (3 months ago)
- Topics: connection, orm, pdo, php, php8, sql
- Language: PHP
- Homepage: https://gethectororm.com
- Size: 61.5 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Hector Connection
[](https://github.com/hectororm/connection/releases)
[](https://github.com/hectororm/connection/blob/main/LICENSE)
[](https://github.com/hectororm/connection/actions/workflows/tests.yml?query=branch%3Amain)
[](https://app.codacy.com/gh/hectororm/connection)
[](https://packagist.org/packages/hectororm/connection)
**Hector Connection** is the PDO connection module of Hector ORM. Can be used independently of ORM.
## Installation
### Composer
You can install **Hector Connection** with [Composer](https://getcomposer.org/), it's the recommended installation.
```bash
$ composer require hectororm/connection
```
### Dependencies
* **PHP** ^8.0
* PHP extensions:
* **PDO**
## Usage
### Create a connection
The connection information must be pass to DSN format, with password inside.
To create a simple connection:
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
```
You can create a complex connection with read/write ways:
```php
use Hector\Connection\Connection;
$connection = new Connection(dsn: 'mysql:host:...', readDsn: 'mysql:host:...');
```
### Query
#### Execute
Execute a statement and get the number of affected rows.
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
$nbAffectedRows = $connection->execute('UPDATE `table` SET `foo` = ? WHERE `id` = ?', ['bar', 1]);
```
The method execute queries on write DSN.
#### Fetch
Three methods are available to fetch results. When multiple results, methods returns a `Generator`.
You can pass parameters for statement to the second argument of methods.
All fetch methods are done on read DSN.
##### Fetch one
Fetch one result from statement.
`NULL` returned if no result.
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
$row = $connection->fetchOne('SELECT * FROM `table` WHERE `id` = ?', [1]);
```
##### Fetch all
Fetch all result from statement.
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
$rows = $connection->fetchAll('SELECT * FROM `table` WHERE `column` = :bar', ['bar' => 'foo']);
foreach($rows as $row) {
// ...
}
```
##### Fetch column
Fetch only one column of all result from statement.
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
$columns = $connection->fetchColumn('SELECT * FROM `table` WHERE `column` = :bar', ['bar' => 'foo'], 2);
foreach($columns as $column) {
// ...
}
```
#### Last insert ID
You can retrieve the last insert ID with method `getLastInsertId()`.
```php
use Hector\Connection\Connection;
$connection = new Connection('mysql:host:...');
$nbAffectedRows = $connection->execute('INSERT INTO `table` ...');
$lastInsertId = $connection->getLastInsertId();
```
#### Transactions
`Connection` class has 4 methods to play with transactions:
- `Connection::beginTransaction(): void`
- `Connection::commit(): void`
- `Connection::rollBack(): void`
- `Connection::inTransaction(): bool`
If you begin a new transaction even though a transaction has already started, the new transaction will be ignored, and
it needed to call even times the `commit` or `rollBack` methods.
### Connection set
You can create a set of `Connection` objects with `ConnectionSet` class.
It needed to name different connections, the default name is store in constant `Connection::DEFAULT_NAME`.
```php
use Hector\Connection\Connection;
use Hector\Connection\ConnectionSet;
$connectionSet = new ConnectionSet();
$connectionSet->addConnection(new Connection('mysql:host:...'));
$connectionSet->addConnection(new Connection('mysql:host:...', name: 'foo'));
$connectionSet->hasConnection(); // TRUE
$connectionSet->hasConnection(Connection::DEFAULT_NAME); // TRUE
$connectionSet->hasConnection('foo'); // TRUE
$connectionSet->hasConnection('bar'); // FALSE
$connectionSet->getConnection(); // FIRST CONNECTION
$connectionSet->getConnection(Connection::DEFAULT_NAME); // FIRST CONNECTION
$connectionSet->getConnection('foo'); // SECOND CONNECTION
$connectionSet->getConnection('bar'); // THROW NotFoundException EXCEPTION
```
### Logger
A logger is available to log queries.
```php
use Hector\Connection\Connection;
use Hector\Connection\Log\LogEntry;
use Hector\Connection\Log\Logger;
$logger = new Logger();
$connection = new Connection('mysql:host:...', logger: $logger);
/** @var LogEntry[] $logEntries */
$logEntries = $logger->getLogs();
```