jpi/database

Simple extension to PDO

v2.0.0 2024-04-15 22:24 UTC

Requires

• php: ^7.1 || ^8.0
• ext-pdo: *

Requires (Dev)

• jpi/codestyles: ^1.0

GPL-3.0-only

• Jahidul Pabel Islam

• database
• db
• mysql
• pdo

README

Simple extension to PDO with some extra convenient methods.

Installation

Use Composer

$ composer require jpi/database 

Usage

Extra Methods:

• prep(string, array): PDOStatement: when you want to bind some parameters to a query
• run(string, array): PDOStatement: when you bind some parameters to a query and want to execute it
• selectAll(string, array): array: for a SELECT query, returns a multidimensional array of all the rows found
• selectFirst(string, array): array: for a SELECT query that has LIMIT 1, returns an associative array of the first row found (if any)
• getLastInsertedId: int|null: helpful after a INSERT query, returns the ID of the newly inserted row

Overridden Methods:

• exec(string, array): int: for INSERT, UPDATE and DELETE queries, returns the number of rows affected

All methods except getLastInsertedId take the query as the first parameter (required), and an array of params to bind to the query (optional).

Examples:

(Assuming instance has been created and set to a variable named $connection)

selectAll:

$rows = $connection->selectAll("SELECT * FROM users;");

/**
$rows = [
    [
        "id" => 1,
        "first_name" => "Jahidul",
        "last_name" => "Islam",
        "email" => "[e-mail]",
        "password" => "password123",
        ...
    ],
    [
        "id" => 2,
        "first_name" => "Test",
        "last_name" => "Example",
        "email" => "[e-mail]",
        "password" => "password123",
        ...
    ],
    ...
];
*/

selectFirst:

$row = $connection->selectFirst("SELECT * FROM users LIMIT 1;");

/**
$row = [
    "id" => 1,
    "first_name" => "Jahidul",
    "last_name" => "Islam",
    "email" => "[e-mail]",
    "password" => "password",
    ...
];
*/

exec:

// INSERT
$numberOfRowsAffected = $connection->exec(
    "INSERT INTO users (first_name, last_name, email, password) VALUES (:first_name, :last_name, :email, :password);",
    [
        "first_name" => "Jahidul",
        "last_name" => "Islam",
        "email" => "[e-mail]",
        "password" => "password",
    ]
);

// UPDATE
$numberOfRowsAffected = $connection->exec(
    "UPDATE users SET first_name = :first_name WHERE id = :id;",
    [
        "id" => 1,
        "first_name" => "Pabel",
    ]
);

// DELETE
$numberOfRowsAffected = $connection->exec("DELETE FROM users WHERE id = :id;", ["id" => 1]);

Support

If you found this library interesting or useful please do spread the word of this library: share on your social's, star on GitHub, etc.

If you find any issues or have any feature requests, you can open a issue or can email me @ jahidulpabelislam.com 😏.

Authors

• Jahidul Pabel Islam [e-mail]

Licence

This module is licenced under the General Public Licence - see the licence file for details.