README

Installation

Using Composer:

composer require zenbox/doctrine

What is contained in the package?

Doctrine components

QueryBuilderCollection

Lazy load query builder collection

$qb = $this->createQueryBuilder('a');
$qb->orderBy('a.date','DESC');
$collection = new QueryBuilderCollection($qb);

$collection->count(); // returns the total number of records
$collection->slice(0, 10); // request limited 10 records from the database

DataProvider

Can be used for pagination. 20 records per page by default

use Doctrine\Common\Collections\ArrayCollection;

$dataProvider = new DataProvider(new ArrayCollection([...]));

// iterable
foreach ($dataProvider as $object) {
    // do something
}

$array = $dataProvider->toArray(); // returns 20 records

Extract data from objects

use ZenBox\Doctrine\Extractor\ExtractorInterface;

// implement extractor
class UserExtractor implements ExtractorInterface
{
    public function extract(object $object) : array
    {
        // TODO: Implement extract() method.
    }
}
// fetch collection from repository
$collection = $repository->findAll();
$dataProvider = new DataProvider($collection, new UserExtractor());

// iterable
foreach ($dataProvider as $row) {
    // do something
}

$array = $dataProvider->extract(); // returns 20 rows

Console commands

You need to create a file ./bin/doctrine in your project for use console commands

#!/usr/bin/env php
<?php

require __DIR__ . ' /../vendor/autoload.php';

use Doctrine\ORM\EntityManagerInterface;
use Psr\Container\ContainerInterface;
use ZenBox\Doctrine\Console\DoctrineConsoleRunner;

/** @var ContainerInterface $container */
$container = require __DIR__ . '/../config/container.php';
$entityManager = $container->get(EntityManagerInterface::class);
$config = [
    'migrations' => [
        'table_storage' => [
            'table_name' => 'doctrine_migration_versions',
            'version_column_name' => 'version',
            'version_column_length' => 1024,
            'executed_at_column_name' => 'executed_at',
            'execution_time_column_name' => 'execution_time',
        ],

        'migrations_paths' => [
            'MyProject\Migrations' => __DIR__ . '/../data/migrations/MyProject/Migrations',
            'MyProject\Component\Migrations' => __DIR__ . '/../data/migrations/Component/MyProject/Migrations',
        ],

        'all_or_nothing' => true,
        'check_database_platform' => true,
    ],
    'fixtures_path' => __DIR__ . '/../data/fixtures',
];

DoctrineConsoleRunner::run($entityManager, $config);

Container configuration

<?php

declare(strict_types=1);

use Doctrine\ORM\EntityManager;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\Tools\Setup;
use ZenBox\Doctrine\DefinitionFactory;
use ZenBox\Doctrine\Iterator\DirectoryPathIterator;
use App\Identity\Domain\Model\User;
use App\Identity\Domain\Repository\UserRepositoryInterface;

return [
    'dependencies' => [
        'factories'  => [
            EntityManagerInterface::class => function() {

                return EntityManager::create(
                    [
                        'dbname' => getenv('MYSQL_DATABASE'),
                        'user' => getenv('MYSQL_USER'),
                        'password' => getenv('MYSQL_PASSWORD'),
                        'host' => getenv('MYSQL_HOST'),
                        'driver' => 'pdo_mysql',
                    ],
                    Setup::createYAMLMetadataConfiguration(
                        // iterate through all folders to find metadata configuration
                        (new DirectoryPathIterator(realpath(__DIR__) . '/../config/doctrine'))->toArray(),
                        getenv('APP_DEV_MODE')
                    )
                );
            },
            // you can use definition factory
            UserRepositoryInterface::class => DefinitionFactory::create(User::class),
            // instead
            UserRepositoryInterface::class => function (ContainerInterface $container) {
               return $container->get(EntityManagerInterface::class)->getRepository(User::class);
            }
        ],
    ],
];

zenbox / doctrine

Maintainers

Details