atlance/http-doctrine-dbal-filter

dbal dynamic filter from http query

dev-main 2023-10-09 01:06 UTC

Requires

• php: ^8.1
• doctrine/dbal: ^2.7
• psr/simple-cache: ^3.0
• webmozart/assert: ^1.9

Requires (Dev)

• ext-curl: *
• ext-dom: *
• ext-memcached: *
• ext-sqlite3: *
• brianium/paratest: ^7.2
• ergebnis/composer-normalize: ^2.37
• phpstan/extension-installer: ^1.3
• phpstan/phpstan: ^1.10
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• phpstan/phpstan-strict-rules: ^1.5
• rector/rector: ^0.18.5
• symfony/cache: ^6.3
• vimeo/psalm: ^5.15

MIT

• Anton Stepanov

• filter
• doctrine-dbal
• doctrine dbal dynamic filter

README

Analogue of atlance/http-doctrine-orm-filter for DBAL and of course without validation.

Simple example:

<?php # src/Fetcher.php

declare(strict_types=1);

namespace App;

use Atlance\HttpDbalFilter\Filter;
use Atlance\HttpDbalFilter\Query\Configuration;
use Doctrine\DBAL\Connection;
use Doctrine\DBAL\ForwardCompatibility\Result;
use Doctrine\DBAL\Query\QueryBuilder;

final class Fetcher
{
    public function __construct(
        private readonly Connection $connection,
        private readonly Filter $filter
    ) {
    }

    /**
     * @throws \Doctrine\DBAL\Driver\Exception
     * @throws \Doctrine\DBAL\Exception
     */
    public function fetch(Configuration $conditions): mixed
    {
        return $this->executeQuery($this->buildQuery($conditions))->fetchOne();
    }

    private function buildQuery(Configuration $conditions): QueryBuilder
    {
        $qb = $this->connection->createQueryBuilder();
        $qb->select('COUNT(DISTINCT(users.id))')
            ->from('users', 'users')
            ->leftJoin('users', 'users_cards', 'uc', 'uc.user_id = users.id')
            ->leftJoin('uc', 'banking_cards', 'cards', 'uc.card_id = cards.id')
            ->leftJoin('users', 'phones', 'phones', 'phones.user_id = users.id')
            ->leftJoin('users', 'passports', 'passport', 'passport.user_id = users.id');

        $this->filter->apply($qb, $conditions);

        return $qb;
    }

    /**
     * @throws \Doctrine\DBAL\Exception
     */
    private function executeQuery(QueryBuilder $qb): Result
    {
        $stmt = $qb->execute();
        if ($stmt instanceof Result) {
            return $stmt;
        }

        throw new \DomainException('this method works only with the select operator');
    }
}

<?php # src/FetcherFactory.php

declare(strict_types=1);

namespace App;

use Atlance\HttpDbalFilter\Filter;
use Atlance\HttpDbalFilter\Query\Expression\ConditionFactory;
use Doctrine\DBAL\DriverManager;
use Psr\SimpleCache\CacheInterface;

final class FetcherFactory
{
    public static function create(?CacheInterface $cache = null): Fetcher
    {
        return new Fetcher(
            DriverManager::getConnection([
                'driver' => 'pdo_sqlite',
                'path' => \dirname(__DIR__) . '/storage/db.sqlite',
            ]),
            new Filter(new ConditionFactory($cache))
        );
    }
}

<?php # public/index.php

declare(strict_types=1);

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

use Atlance\HttpDbalFilter\Query\Configuration;
use App\FetcherFactory;

// as example, from http query parameter: ?filter[eq][users_id]=1
$result = FetcherFactory::create()->fetch(
    Configuration::fromArray([
        'filter' => [
            'eq' => [
                'users_id' => 1,
            ],
        ],
    ])
);

var_dump($result);

More examples in tests.