canteen/database

Abstract mysqli library for use with the Canteen Framework.

Canteen Database

Abstract mysqli library for use with the Canteen Framework. For documentation of the codebase, please see Canteen Database docs., _(*1)

Installation

Install is available using Composer., _(*2)

composer require canteen/database dev-master

Including using the Composer autoloader in your index., _(*3)

require 'vendor/autoload.php';

Setup

use Canteen\Database;
$db = new Database(
    'localhost',    // MySQL host
    'root',         // MySQL username
    '12341234',     // MySQL user's password
    'my_database'   // Database name
);

Sample Usage

Create SQL queries with a simple, intuitive, object-oriented API., _(*4)

// Create a select query of a properties
// on a user's table of all active users
$users = $db->select('user_id', 'first_name', 'last_name')
    ->from('users')
    ->where('active=1')
    ->results();

Rebuild Documentation

This library is auto-documented using YUIDoc. To install YUIDoc, run sudo npm install yuidocjs. Also, this requires the project CanteenTheme be checked-out along-side this repository. To rebuild the docs, run the ant task from the command-line., _(*5)

ant docs

License

Copyright (c) 2013 Matt Karl, _(*6)

Released under the MIT License., _(*7)