sumpygump/qi-db

Basic database adapter

1.2.1 2013-10-08 14:16 UTC

README

Qi Db provides PHP library classes for running SQL on databases.

Installation with Composer

Use composer to include the Qi_Db library in a project.

Add the following composer.json file to your project directory:

{
    "require": {
        "sumpygump/qi-db": "dev-master"
    }
}

Then run composer install to fetch.

$ composer.phar install

If you don't have composer already installed, this is my recommendation for installing it. See getcomposer.org installation instructions.

$ curl -sS https://getcomposer.org/installer | php
$ sudo mv composer.phar /usr/local/bin/composer

Once the files have been composed with the composer install command, you can use any of the Qi_Db_ classes after composer's autoloader is included.

require 'vendor/autoload.php';

$db = new Qi_Db_PdoMysql();
// ...

Manual Installation

You can also download the files and place them in a library folder. If you do this, be sure to update your autoloader to handle the Qi_Db_* classes or else manually include the files of the classes you'll need.

Basic Usage

This is some example code that illustrates connecting to a Mysql database:

$dbConfig = array(
    'host' => 'localhost',
    'db'   => 'databasename',
    'user' => 'username',
    'pass' => 'mypassword',
);
$db = new Qi_Db_PdoMysql($dbConfig);

This is some example code that illustrates using the insert() and getRow() methods of the PdoMysql class.

// This will insert a new record into a `users` table
$newRow = array(
    'email' => 'test@example.com',
    'first_name' => 'Joe',
    'last_name' => 'Schmoe',
);
$db->insert('users', $newRow);

// This will fetch a user by email address
$user = $db->getRow("SELECT * FROM `users` WHERE `email`=?", array('test@example.com'));

Please check the class source code for the full list of other methods that can be used.