Skip to content

Latest commit

 

History

History
186 lines (125 loc) · 6.48 KB

README.md

File metadata and controls

186 lines (125 loc) · 6.48 KB
Raw

PowerLite PDO

Static Badge GPLv3 License GitHub Release

PowerLite PDO is a lightweight, powerful PHP library that provides a simple and efficient way to interact with databases using PHP Data Objects (PDO). It supports multiple database drivers and includes features like easy connection management, query execution, result handling and pagination.

PowerLite PDO

Table of Contents

Features

  • Containerized Connections: The containers are used to connect your database and handle the configuration and dependencies seamlessly.
  • Db & QueryBuilder Methods: Execute SQL queries and retrieve results using Db methods or the fluent QueryBuilder.
  • Efficient Result Handling: Fetch single row, all rows, or specific column's value with dedicated methods.
  • Comprehensive Database Operations: Provides a wide range of methods for diverse database interactions.
  • Pagination Support: Handle paginated results effortlessly with the Pagination class.
  • Error Management: User-friendly handling of database errors and exceptions.
  • Debug Mode: Provides detailed information about the requests for debugging purposes.
  • Prepared Statements: Support for prepared statements to prevent SQL injection attacks.
  • Transaction Control: Manage database transactions with methods to start, commit, and rollback.
  • High Code Quality Standards: The code follows best practices and coding standards.

Requirements

PHP ^7.4, PHP 8.x

Documentation

The documentation for PowerLite PDO is available on the PowerLite PDO website.

In addition to the documentation, a PHPDoc is also available here for more detailed information about the classes, methods, and their parameters.

Installation

Clone / download or install with Composer

composer require migliori/power-lite-pdo

Configuration

Open src/connection.php in your code editor and replace the constant's values with your database connection settings (DB_HOST, DB_NAME, DB_USER, DB_PASS, DB_PORT, DB_CHARSET).

Security concerns

For enhanced safety, store the file outside of your web server's document root (the directory that is served to the internet) and change the path accordingly in the configuration file (src/config.php). This prevents the file from being directly accessible via a URL.

Usage/Examples

Select records using the main Db class

  1. Include the bootstrap file and get the Db instance from the container:

    use Migliori\PowerLitePdo\Db;

// Build the container and connect to the database
$container = require_once __DIR__ . '/vendor/migliori/power-lite-pdo/src/bootstrap.php';
$db = $container->get(Db::class);

  2. Use the select method from the Db class to select some records:

    $from = 'users'; // The table name
$fields = ['id', 'username', 'email']; // The columns you want to select
$where = ['status' => 'active']; // The conditions for the WHERE clause

$db->select($from, $fields, $where);

  3. Fetch the selected records one by one:

    while ($record = $db->fetch()) {
    echo $record->id . ', ' . $record->username . ', ' . $record->email . "\n";
}

Select records using the fluent QueryBuilder

  1. Include the bootstrap file and get the QueryBuilder instance from the container:

    use Migliori\PowerLitePdo\Query\QueryBuilder;

// Build the container and connect to the database
$container = require_once __DIR__ . '/vendor/migliori/power-lite-pdo/src/bootstrap.php';
$queryBuilder = $container->get(QueryBuilder::class);

  2. Use the QueryBuilder to select some records:

    $queryBuilder->select(['id', 'username', 'email'])->from('users')->where(['status' => 'active'])->execute();

  3. Fetch the selected records one by one:

    while ($record = $queryBuilder->fetch()) {
    echo $record->id . ', ' . $record->username . ', ' . $record->email . "\n";
}

Select records with Pagination

  1. Include the bootstrap file and get the Pagination instance from the container:

    use Migliori\PowerLitePdo\Pagination;

// Build the container and connect to the database
$container = require_once __DIR__ . '/vendor/migliori/power-lite-pdo/src/bootstrap.php';
$pagination = $container->get(Pagination::class);

  2. Select some records:

    $from = 'users'; // The table name
$fields = ['id', 'username', 'email']; // The columns you want to select
$where = ['status' => 'active']; // The conditions for the WHERE clause

$pagination->select($from, $fields, $where);

  3. Fetch the selected records one by one:

    while ($record = $pagination->fetch()) {
    echo $record->id . ', ' . $record->username . ', ' . $record->email . "\n";
}

  4. Display the pagination:

    $url = '/users'; // The URL for the pagination links
echo $pagination->pagine($url);

Running Tests

To run tests, run the following command

php ./vendor/bin/phpunit test

Dependencies

  • Composer: A dependency management tool for PHP.
  • PHP-DI: A dependency injection container for PHP.
  • PDO: The PHP Data Objects extension for accessing databases.
  • Database Drivers: The specific drivers for the databases you want to connect to (e.g., MySQL, PostgreSQL, Oracle, Firebird, ...).

Dev Dependencies

  • PHPUnit: A testing framework for unit testing PHP code.
  • PHPStan: A static analysis tool that helps find bugs in PHP code.
  • PHP CodeSniffer: A set of rules to ensure that PHP code follows coding standards.

Contributing

Contributions are always welcome!

Please contact us for any improvement suggestions or send your pull requests

License

GNU General Public License v3.0