rammewerk/database

A simple and handy database utility

1.1.1 2024-05-12 11:12 UTC

Requires

• php: >=8.3
• ext-pdo: *
• rammewerk/hydrator: ^1.0

MIT

• Kristoffer Follestad

• database
• schema
• pdo

README

The Rammewerk Database is a simple, yet effective, database helper library. Its functionality is meant to work with MariaDB or MySQL.

Installation

Install Rammewerk Database via composer:

composer require rammewerk/database

How to use

Create a database connector instance.

$database = new Rammewerk\Component\Database\Database('host','database','user','password','charset');

Or, create some caching of instances

use Rammewerk\Component\Database\Database;
use Rammewerk\Component\Environment;

class DatabaseConnector {

    /** @var Database[] */
    protected array $instances = [];

    public function __construct(protected readonly Environment $environment) {}

    public function instance(string $database): Database {
        if( !isset( $this->instances[$database] ) ) {
            try {
                $this->instances[$database] = new Database(
                    $this->environment->get( 'DB_HOST' ),
                    $database,
                    $this->environment->get( 'DB_USERNAME' ),
                    $this->environment->get( 'DB_PASSWORD' ),
                    $this->environment->get( 'DB_CHARSET' )
                );
            } catch( \PDOException $e ) {
                // Log exception here...
                throw new \RuntimeException( 'Unable to connect database: ' . $database );
            }
        }

        return $this->instances[$database];

    }

}

More details are coming in the future.