README

PDOLoad

PDOLoad is a small PDO wrapper/abstraction layer to provide read/write endpoints and load balancing capabilities in one line of code. Load balancing is usually include within most major PHP Frameworks however when working with large legacy projects it's hard to come by.

Main Features

• Add multiple read and write endpoints.
• One line implementation. No need to rewrite your PDO queries.
• Transaction aware. Any reads while a transaction is active will be performed on the write connection.

Getting started

• PHP >= 7.0 is required
• Install PDOLoad using composer (recommmended) or manually
• Configure your connections and you're ready to go!

Installing with Composer

composer require gonzie/pdoload

How to use

PDOLoad gives you as much choice as possible with little to no modification required. A normal PDO connection would be set like:

$dbh = new PDO('mysql:host=localhost;dbname=testdb;charset=utf8mb4', 'username', 'password');

(most basic set up)

To use a minimalistic version of PDOLoad you would amend the code as follows:

$dbh = new Gonzie\PDOLoad\PDOLoad('mysql:host=localhost;dbname=testdb;charset=utf8mb4', 'username', 'password');

Alternatively, to use PDOLoad to it's full abilities, and for what it was actually made for, you can set up by passing an array with settings.

<?php
$settings = [
    'driver' => 'mysql',
    'reader' => [
        [
            'host' => 'mysuperduperdbreader_1.com',
            'dbname' =>  'test',
            'user' => 'gonzie',
            'password' => 'password',
            'port' => '3306'
            'charset' => 'utf8mb4',
        ],
        [
            'host' => 'mysuperduperdbreader_2.com',
            'dbname' =>  'test',
            'user' => 'gonzie',
            'password' => 'password',
            'charset' => 'utf8mb4',
        ],
    ],
    'writer' => [
        [
            'host' => 'mysuperduperdbwriter_1.com',
            'dbname' =>  'test',
            'user' => 'gonzie',
            'password' => 'password',
            'charset' => 'utf8mb4',
        ],
    ],
    'balancer' => 'round-robin',
];

$dbh = new Gonzie\PDOLoad\PDOLoad($settings);

Easy right? Here's a breakdown of the settings array:

Connection array

Other options can be added to your liking as long as overwrite_allowed is set to true.

Contributing

Any changes to the Project must abide by PSR Standards (PSR 2 - 12, PSR4 and others where applicable).

Please run phpcs before committing any code.

./vendor/bin/phpcs --standard=psr2 src/