kristos80/pdo-factory

1.0.0 2023-12-16 16:07 UTC

Requires

• php: >=8.0
• ext-pdo: *

Requires (Dev)

• marcocesarato/php-conventional-changelog: ^1.17
• phpunit/phpunit: ^10
• vlucas/phpdotenv: ^5

MIT

README

Factory utility that creates a PDO object from environment configuration.

Work in Progress (WIP) — Do not use in production yet:

• It has not undergone extensive testing.
• Primarily intended for internal projects, subject to potential breaking changes without prior notice.
• There are likely many missing features.

The following environmental variables can be used:

• PDO_FACTORY_ADAPTER specifies which adapter will be used and how the rest of the environmental variables are going to be collected. Default 'mysql'
• ${PDO_FACTORY_ADAPTER}_HOSTNAME default 'localhost'
• ${PDO_FACTORY_ADAPTER}_PORT default NULL, fallbacks to the default port of each adapter
• ${PDO_FACTORY_ADAPTER}_USERNAME default NULL
• ${PDO_FACTORY_ADAPTER}_PASSWORD default NULL
• ${PDO_FACTORY_ADAPTER}_DATABASE default NULL
• ${PDO_FACTORY_ADAPTER}_CHARSET default NULL

MySQL specific

• MYSQL_UNIX_SOCKET default NULL. If it exists MYSQL_HOSTNAME and MYSQL_PORT are ommited

Postgres specific

• POSTGRES_SSL_MODE default NULL. See more

Example usage

.env

PDO_FACTORY_ADAPTER=mysql
MYSQL_HOSTNAME=127.0.0.1
MYSQL_PORT=23306
MYSQL_USERNAME=root
MYSQL_PASSWORD=mysql
MYSQL_DATABASE=slim

db.php

<?php
declare(strict_types=1);

use Dotenv\Dotenv;
use Kristos80\PdoFactory\PdoFactory;

require_once __DIR__ . "/../../vendor/autoload.php";

# Load .env somehow
# `Dotenv\Dotenv` is not part of this library
$dotEnv = Dotenv::createImmutable(__DIR__);
$dotEnv->load();

$mysqlPdo = PdoFactory::createFromEnv();