Database.php is a simple PHP class for doing standard MySQL actions, such as selecting, inserting, updating and deleting database rows. It also includes some nice functionality, like auto-escaping to protect your database from malicious code and automatic serializing of arrays.
Initiate a database connection using by creating a new Database()
object.
require_once('Database.php');
$db = new Database($database_name, $username, $password, $host); // $host is optional and defaults to 'localhost'
Select rows from a database table
Usage:
$db->select($table, $where, $limit, $order, $where_mode, $select_fields)
Arguments:
- string
$table
- name of the table to select from - array/string
$where
- array or string holding the filters/'WHERE' clause for the query - int/string
$limit
- integer or string holding the 'LIMIT' clause - string
$order
- string holding the 'ORDER BY' clause - string
$where_mode
- whether to add an 'AND' or 'OR' after each item in the$where
array, defaults toAND
- string
$select_fields
- the fields to select (SELECT <$select_fields> FROM ...), defaults to*
Example:
// get the first 10 candy bars that are sweet, and order them by amount
$db->select('candy', array('sweet' => 1, 'spicy' => 0), 10, 'amount DESC');
// get the ids 1, 2,5,9 from products
$db->select('products', array('id' => 'in (1,2,5,9)'), false, false,'OR');
Reading the results can be done with the following functions:
-
$db->count()
returns the number of selected rows, equal tomysql_num_rows()
-
$db->row()
returns the first row that matches the query as an array -
$db->result()
returns all matches rows as an array containing row objects -
$db->result_array()
returns all matches rows as an array containing row arrays -
$db->row_array()
returns the first row that matches the query as an object (stdClass)
Please note that you can call any of these functions also directly after the $db->select()
call, like shown below:
echo $db->select('candy', array('sweet' => 1), 10)->count();
There are a few other methods available for queries that might come in handy:
$db->sql()
returns the sql query that was last executed
Insert data into a database table
Usage:
$db->insert($table, $fields=array())
Example:
$db->insert(
'candy',
array(
'name' => 'Kitkat original',
'sweet' => 1,
'spicey' => 0,
'brand' => 'Kitkat',
'amount_per_pack' => 4
)
);
Tip! You can call $db->id()
immeadiately after a $db->insert()
call to get the ID of the last inserted row.
Update one or more rows of a database table
Usage:
$db->update($table, $fields=array(), $where=array())
If you need to set a value based on a formula, ex. {previousValue} + 1, end the field name with an exclamation mark (!), ex: 'amount!' => 'amount - 100'
Example:
// Move an employee to another department and update their positions count
$db->update(
'employees',
array( // fields to be updated
'department' => 'IT',
'positions!' => 'positions + 1' //Note the exclamation mark (!) at the end
),
array( // 'WHERE' clause
'id' => '815'
)
);
Remove one or more rows from a database table
Usage:
$db->delete($table, $where=array())
Example:
// delete all Kitkat candy
$db->delete(
'candy',
array( // 'WHERE' clause
'brand' => 'Kitkat'
)
);
Access the database instance outside the global scope after initializing it
Usage:
$my_db = Database::instance();
Example:
// Global scope
$db = new Database($database_name, $username, $password, $host);
// Function scope
function something(){
// We could simply use `global $db;`, but using globals is bad. Instead we can do this:
$db = Database::instance();
// And now we have access to $db inside the function
}