phpbook/database

PHP Database Extension For DOCTRINE

1.1.9 2023-10-07 14:29 UTC

Requires

• php: >=7.1.0
• doctrine/dbal: *
• doctrine/migrations: *
• doctrine/orm: *

MIT

• PHPBook

• database
• php
• lightweight
• fast

README

• About Database
• Composer Install
• Declare Configurations
• Use Database
• Helpers

About Database

• A lightweight DATABASE PHP extension for DOCTRINE.

Composer Install

composer require phpbook/database

Declare Configurations

/********************************************
 * 
 *  Declare Configurations
 * 
 * ******************************************/

//Connections
\PHPBook\Database\Configuration\Database::setConnection('main',
	(new \PHPBook\Database\Configuration\Connection)
		->setName('Main')
        ->setDriver([
            'driver' => 'pdo_sqlite',
            'path' => __DIR__ . '/db.sqlite'
        ])
        ->setEntitiesPathRoot('entities/root/path')
        ->setProxiesPathRoot('entities/root/path')
        ->setProxiesNamespace('App\Proxy')
        ->setMetadataCache(new \Doctrine\Common\Cache\ArrayCache)
        ->setMigratorVersion(PHPBook\Database\Configuration\MigratorVersion::$V3)
        ->setMigrationPathRoot('migration/root/path')
        ->setMigrationTable('migrations')
        ->setMigrationTableColumnVersion('version')
        ->setMigrationNamespace('\App\Migration')
        ->setEventManager($eventManager) // \Doctrine\Common\EventManager
);

\PHPBook\Database\Configuration\Database::setConnection('other',
	(new \PHPBook\Database\Configuration\Connection)
		->setName('Other')
		->setDriver([
            'driver' => 'pdo_sqlite',
            'path' => __DIR__ . '/db.sqlite'
        ])
        ->setEntitiesPathRoot('entities/root/path')
        ->setProxiesPathRoot('entities/root/path')
        ->setProxiesNamespace('App\Proxy')
        ->setMetadataCache(new \Symfony\Component\Cache\Adapter\PhpFilesAdapter('doctrine-metadata'))
        ->setQueryCache(new \Symfony\Component\Cache\Adapter\PhpFilesAdapter('doctrine-query'))
        ->setMigratorVersion(PHPBook\Database\Configuration\MigratorVersion::$V3)
        ->setMigrationPathRoot('migration/root/path')
        ->setMigrationTable('migrations')
        ->setMigrationTableColumnVersion('version')
        ->setMigrationNamespace('\App\Migration')
);

//Set default connection by connection code

\PHPBook\Database\Configuration\Database::setDefault('main');

//Getting connections

$connections = \PHPBook\Database\Configuration\Database::getConnections();

foreach($connections as $code => $connection) {

	$connection->getName(); 

	$connection->getMeta();

};

?>

Use Database

		
	//Get a Singleton Doctrine Entity Manager of a Connection or Null
    \PHPBook\Database\EntityManager::get('main');

    //Get a Singleton Default Doctrine Entity Manager or Null 
    \PHPBook\Database\EntityManager::get();

    //Execute Doctrine Migration of a Connection. Updates to the better version available.
    \PHPBook\Database\Migration::execute('main');

    //Execute Doctrine Migration in Default Connection. Updates to the better version available.
    \PHPBook\Database\Migration::execute();

    //Execute Doctrine Migration of a Connection. Updates or Downgrades to the version 201010101010.
    \PHPBook\Database\Migration::execute('main', '201010101010');

    //Execute Doctrine Migration in Default Connection. Updates or Downgrades to the version 201010101010.
    \PHPBook\Database\Migration::execute(Null, '201010101010');

    //Generate Doctrine Proxies of Entities in Default Connection. 
    //The Directory will be cleared recursively before generate, so you should have a unique folder to this proxies.
    \PHPBook\Database\Proxy::generate();

    //Generate Doctrine Proxy of Entities in a Connection.
    //The Directory will be cleared recursively before generate, so you should have a unique folder to this proxies.
    \PHPBook\Database\Proxy::generate('main');
		

Helpers

        
    //Generate an UUID version 1
    \PHPBook\Database\UUID::generate('prefix-string', 'node-alias');
    \PHPBook\Database\UUID::generate('prefix-string', '');
    \PHPBook\Database\UUID::generate('', 'node-alias');
    \PHPBook\Database\UUID::generate();

You can check the doctrine documentation to use the entity manager, migrations and other resources.