bentools/simple-dbal

v0.6 2019-01-04 14:16 UTC

Requires

• php: >=7.1
• guzzlehttp/promises: ^1.3

Requires (Dev)

• bentools/iterable-functions: ^1.1
• incenteev/composer-parameter-handler: ^2.1
• phpunit/phpunit: ^6.0
• satooshi/php-coveralls: ^1.0
• squizlabs/php_codesniffer: ~2.0
• symfony/var-dumper: ^3.2
• symfony/yaml: ^3.2

MIT

• Beno!t POLASZEK

README

SimpleDBAL

A modern wrapper on top of PDO and Mysqli, written in PHP7.1. It aims at exposing the same API regardless of the one your project uses.

Introduction

PHP offers 2 different APIs to connect to a SQL database: PDO and mysqli (we won't talk about mysql_* functions since they're deprecated). Both do more or less the same thing, but:

• Their API are completely different (different method names and signatures)
• They both have their own pros and cons.
• Some features of one are missing in the other.

This library exposes an API that can be used by any of them, transparently, in a more modern approach (OOP, iterators, return types, etc).

This also means you can switch from PDO to mysqli and vice-versa without having to rewrite your whole code.

From my personnal experience, I was used to PDO and was forced to deal with mysqli in another project and it was really messy.

Overview

use BenTools\SimpleDBAL\Model\Credentials;
use BenTools\SimpleDBAL\Model\SimpleDBAL;

$credentials = new Credentials('localhost', 'user', 'password', 'database');
$cnx         = SimpleDBAL::factory($credentials, SimpleDBAL::PDO);
$query       = "SELECT `id`, `name` FROM guys WHERE created_at > ?";
foreach ($cnx->execute($query, [new DateTime('-1 month')]) as $item) {
    var_dump($item['name']);
}

Additionnal features

• On-the-fly parameter binding for prepared statements (simply pass an array of arguments after the query)
• DateTimeInterface objects automatic binding (formats to YYYY-MM-DD HH:ii:ss)
• Asynchronous queries (Promises)
• Parallel queries
• Support for named parameters in prepared statements for mysqli (polyfill with regexps - experimental feature)
• Can silently reconnect after a lost connection

The Result object

Every query sent to the adapter will return a BenTools\SimpleDBAL\Contract\ResultInterface object.

For SELECT queries, use the following methods:

• $result->asArray() to fetch an array containing the whole resultset
• $result->asRow() to fetch the 1st row of the resultset, as an associative array
• $result->asList() to fetch the 1st column of the resultset, as a sequential array
• $result->asValue() to fetch a single value (i.e the 1st column of the 1st row)
• foreach ($result as $row) to iterate over the resultset (uses lazy-loading)
• count($result) to return the number of rows of the resultset.

For INSERT / UPDATE / DELETE queries, use the following methods:

• count($result) to return the number of affected rows
• $result->getLastInsertId() to get the id of the last inserted row or sequence value.

Installation

composer require bentools/simple-dbal

Tests

./vendor/bin/phpunit

Documentation

Getting started

Configuring auto-reconnect

Asynchronous and parallel queries

Connection pools

Known Issues