royallthefourth / smooth-pdo

Drop-in PDO wrapper that provides smooth and pleasant method chaining

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

smooth-pdo

A drop-in PDO wrapper that provides smooth and pleasant method chaining.

Rationale

PDO is a perfectly fine way to access a database, but it would be a little more pleasant to work with if all the methods could be chained together. Unfortunately, you can't do that with PDO since it uses boolean return values to indicate errors. This just overrides the methods that use return values to indicate errors so they throw exceptions instead.

Installation

composer require royallthefourth/smooth-pdo

Now create a SmoothPdo\DataObject from a \PDO and you're all set:

new RoyallTheFourth\SmoothPdo\DataObject(\PDO $db)

Example

A typical example from the PDO documentation looks like this:

$calories = 150;
$colour = 'red';

$sth = $dbh->prepare('SELECT name, colour, calories
    FROM fruit
    WHERE calories < :calories AND colour = :colour');
$sth->bindParam(':calories', $calories, PDO::PARAM_INT);
$sth->bindParam(':colour', $colour, PDO::PARAM_STR, 12);
$sth->execute();

Here's how it looks with SmoothPdo\DataObject:

<?php
$calories = 150;
$colour = 'red';

$dbh->prepare('SELECT name, colour, calories
    FROM fruit
    WHERE calories < :calories AND colour = :colour')
    ->bindParam(':calories', $calories, PDO::PARAM_INT)
    ->bindParam(':colour', $colour, PDO::PARAM_STR, 12)
    ->execute();

Differences from PDO

This library works almost exactly like PDO. Just beware that these methods now throw exceptions instead of returning false:

  • PDO::beginTransaction
  • PDO::commit
  • PDO::rollback
  • PDO::setAttribute
  • PDOStatement::bindColumn
  • PDOStatement::bindParam
  • PDOStatement::bindValue
  • PDOStatement::closeCursor
  • PDOStatement::execute

Problems

If you encounter any problems or notice any other divergence from PDO, please don't hesitate file an issue.

About

Drop-in PDO wrapper that provides smooth and pleasant method chaining

License:MIT License


Languages

Language:PHP 100.0%