DEV Community

David Carr
David Carr

Posted on • Originally published at dcblog.dev on

V1 PDO Wrapper released

V1 PDO Wrapper released

I've updated and pushed a new release to my PDO Wrapper package.

This PDO wrapper, is a collection of crud methods for working with a database this includes selecting, inserting, updating and deleting records.

Install

Using composer include the repository by typing the following into a terminal

composer require daveismyname/pdo-wrapper

Enter fullscreen mode Exit fullscreen mode

Set the db credentials. Finally create an instance of the classes by calling it's get method.

This wrapper makes use of a single database connection further connections attempts will reuse the already open connections, if not already connected.

use Daveismyname\PdoWrapper\Database;

// make a connection to mysql here
$db = Database::get($username, $password, $database, $host = 'localhost', $type = 'mysql');
Enter fullscreen mode Exit fullscreen mode

Usage examples

Select:

$db->select("column FROM table");
Enter fullscreen mode Exit fullscreen mode

To select data based on user data instead of passing the data to the query directly use a prepared statement, this is safer and stops any attempt at sql injections.

$db->select("username FROM members WHERE memberID = :id and email = :email", array(':id' => 1, ':email' => 'someone@domain.com'));
Enter fullscreen mode Exit fullscreen mode

The above query will return the username from the member's table where the memberID and email match. The memberID and email are passed separately in an array.

Instead of passing in an id and email to the query directly, a placeholder is used :id and :email then an array is passed the keys in the array matches the placeholder and is bound, so the database will get both the query and the bound data.

Data returned from the query will be returns as an object this can be changed by passing a third param to the select containing PDO::FETCH_ASSOC.

To use the object loop through it, a typical example:

$rows = $db->select("firstName, lastName FROM members ORDER BY firstName, lastName");
foreach ($rows as $row) {
    echo "<p>$row->firstName $row->lastName</p>";
}
Enter fullscreen mode Exit fullscreen mode

Select Single Record:

Using find() will return only a single result. Like select it accepts params being passed in an array as a second argument.

$db->find("column FROM table where id=:id", [':id' => 23]);
Enter fullscreen mode Exit fullscreen mode

Raw

A raw query is a query that is not ran through a prepared statement and will execute the query passed directly. Useful when creating a table.

$db->raw("CREATE TABLE IF NOT EXISTS members (
  memberID INT(11) NOT NULL AUTO_INCREMENT,
  firstName VARCHAR(255) NOT NULL,
  lastnName VARCHAR(255) NOT NULL,
  email VARCHAR(255) NOT NULL,
  PRIMARY KEY (memberID))"
);
Enter fullscreen mode Exit fullscreen mode

Insert

Data is inserted by calling the insert method it expects the table name followed by an array of key and values to insert in to the database.

$data = array(
    'firstName' => 'Joe',
    'lastnName' => 'Smith',
    'email' => 'someone@domain.com'
);
$db->insert('members', $data);
Enter fullscreen mode Exit fullscreen mode

The insert automatically returns the last inserted id by returning 'lastInsertId' to collect the id:

$id = $db->insert('members', $data);
Enter fullscreen mode Exit fullscreen mode

Updating

To update an existing record the update method is called. This method expects the table, array of data to update and a second array containing the where condition.

$data = array(
    'firstName' => 'Joe',
    'lastnName' => 'Smith',
    'email' => 'someone@domain.com'
);
$where = array('memberID' => 2);
$db->update('members', $data, $where);
Enter fullscreen mode Exit fullscreen mode

Or:

$update = array( 
    'data'=>array(
        'firstName' => 'Joe',
        'lastnName' => 'Smith',
        'email' => 'someone@domain.com'
        ),
    'where'=> array('memberID' => 2)
    );

$db->update('members', $update['data'], $update['where']);
Enter fullscreen mode Exit fullscreen mode

Delete

To delete records call the delete method. This method expects the table name and an array of the where condition.

$where = array('memberID' => 2);
$db->delete('members', $where);
Enter fullscreen mode Exit fullscreen mode

This will delete a single record to set the limit pass a third parameters containing the number to limit to, or to remove the limit pass null as a third param.

$db->delete('members', $where, 10); //delete 10 records matcing the where
$db->delete('members', $where, null); //delete all records matching the where
Enter fullscreen mode Exit fullscreen mode

Delete multiple IN

To delete multiple records where ids are in a specific column, this uses WHERE id IN (4,5,6)

$db->deleteByIds('users', 'id', '4,5,6');
Enter fullscreen mode Exit fullscreen mode

Truncate

To empty a table of all contents call the truncate method. Passing only the table name.

$db->truncate('members');
Enter fullscreen mode Exit fullscreen mode

Count

To count records call the count method. This method expects the table name and column name (optional).

$db->count('members');
Enter fullscreen mode Exit fullscreen mode

If table has no column id

$db->count('members', 'member_id');
Enter fullscreen mode Exit fullscreen mode

See https://github.com/daveismyname/pdo-wrapper

Top comments (0)