README

DB Kit

Vanilla PHP functions to handle database connection and CRUD operations with PDO.

Installation

Easy install with composer:

composer require jyoungblood/dbkit

use VPHP\db;
require __DIR__ . '/vendor/autoload.php';

Usage

db::init($settings)

Initializes the database connection. The output from this function should be assigned to a global 'database' variable.

$GLOBALS['database'] = db::init([
  'host' => 'localhost',
  'name' => 'database_name',
  'user' => 'username',
  'password' => 'password',
  'driver' => 'mysql', // optional, defaults to 'mysql'
  'port' => '3306', // optional, defaults to '3306'
  'charset' => 'utf8mb4', // optional, defaults to 'utf8mb4'
]);

db::insert($table, $input)

Sanitizes parameters and inserts an array of data into a specific table.
Returns the id field of the record created.

$new_id = db::insert("celestial_bodies", [
  'name' => 'Luna',
  'classification' => 'moon',
  'comment' => 'Earth\'s moon, also commonly referred to as "the moon"'
]);

echo $new_id;

db::find($table, $criteria, $options)

Sanitizes parameters and retrieves a specific record(/s) from a specific table, building a query with SELECT *.
Returns an array with the the data and total number of records.

$planets = db::find("celestial_bodies", "classification = 'planet' ORDER BY title ASC LIMIT 8");

foreach ($planets['data'] as $p){
  echo $p['title'];
  echo $p['classification'];
  // etc, etc
}

echo $planets['total'];  // 8

db::get() and db::fetch() are also available as aliases to db::find(), and behave the exact same way.

Raw Queries

Raw SQL queries can be used by sending a raw parameter like this:

$space_objects = db::find("", "SELECT title, classification FROM celestial_bodies WHERE id IS NOT NULL", [
  'raw' => true
]);

db::update($table, $input, $criteria)

Sanitizes parameters and updates an array of data for a specific record(/s).

db::update("celestial_bodies", [
  'name' => 'Mars',
  'comment' => 'Research "The Phobos Incident" -- we are not alone'
], "name='Marz'");

db::delete($table, $criteria)

Sanitizes parameters and deletes a specific record(/s).

db::delete("celestial_bodies", "name='venice'");

db::create_placeholders($criteria)

Creates placeholders and sanitizes data for query building. This function is used to sanitize parameters for all functions.

It returns an array with a string of generated placeholders (where), and an array of the actual data to be used in the query (data).

An example of how it is used to prepare and execute a db::find() query:

$wd = db::create_placeholders($where);
try {
  $query = "SELECT * FROM $table WHERE " . $wd['where'];
  $a = $GLOBALS['database']->prepare($query);
  $a->execute($wd['data']);
  $a->setFetchMode(PDO::FETCH_ASSOC);
}
catch(PDOException $e) {
  echo $e->getMessage();
}

Using PDO methods

The $GLOBALS['database'] variable is just an initialized PDO object, so it's possible to use any native PDO methods if needed.

For example:

$GLOBALS['database']->exec('CREATE TABLE users (
			id INT(255) NOT NULL AUTO_INCREMENT,
			password VARCHAR(255) NULL DEFAULT NULL,
			email VARCHAR(255) NULL DEFAULT NULL,
			PRIMARY KEY (id)
			) ENGINE=InnoDB CHARACTER SET utf8;');

$GLOBALS['database']->query('DESCRIBE users')->fetchAll(PDO::FETCH_ASSOC)