drjele/doctrine-utility

Doctrine utility library

v5.3.5 2024-03-11 16:30 UTC

Requires

• php: >=8.2
• ext-pdo: *
• doctrine/orm: 2.*|3.*|4.*

Requires (Dev)

• drjele/symfony-phpunit: 5.*
• friendsofphp/php-cs-fixer: 3.*
• phpstan/phpstan: 1.*
• squizlabs/php_codesniffer: 3.*

MIT

• Adrian Jeledintan

• repository
• doctrine

README

Doctrine custom types and functions.

You may fork and modify it as you wish.

Any suggestions are welcomed.

Usage for \Drjele\Doctrine\Utility\Repository\AbstractRepository and \Drjele\Doctrine\Utility\Repository\DoctrineRepository

The purposes for this classes are:

• Easier constructor injection for the "repositories". The quotes are because these repositories are actual read services (in CRUD methodology).
• Code reuse by using custom filters and join "filters".
• Better find usages for methods because you are forced to implement only what you need.

Product.php

namespace Acme\Domain\Product\Entity;

use Doctrine\ORM\Mapping as ORM;
use Drjele\Doctrine\Utility\Entity\CreatedTrait;
use Drjele\Doctrine\Utility\Entity\ModifiedTrait;
use Drjele\Doctrine\Utility\Repository\DoctrineRepository;

/**
 * @ORM\Entity(repositoryClass=DoctrineRepository::class)
 * @ORM\ChangeTrackingPolicy("DEFERRED_EXPLICIT")
 * @ORM\Table(options={"collate":"utf8mb4_general_ci"})
 * )
 */
class Product
{
    use CreatedTrait;
    use ModifiedTrait;

    /**
     * @ORM\Id
     * @ORM\Column(type="integer", options={"unsigned"=true})
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private ?int $id;

    /**
     * @ORM\Column(type="string", length=64, nullable=false, unique=true)
     */
    private string $barcode;

    /**
     * @ORM\ManyToOne(targetEntity=ProductType::class, fetch="EXTRA_LAZY")
     * @ORM\JoinColumn(nullable=false, onDelete="RESTRICT")
     */
    private ProductType $productType;
}

ProductRepository.php

namespace Acme\Domain\Product\Repository;

use Acme\Domain\Product\Entity\Product;
use Acme\Domain\Product\Exception\Exception;
use Acme\Domain\Product\Exception\NotFoundException;
use Acme\Domain\Product\Repository\ProductTypeRepository;
use Doctrine\ORM\Query\Expr\Join;
use Doctrine\ORM\QueryBuilder;
use Drjele\Doctrine\Utility\Join\JoinCollection;
use Drjele\Doctrine\Utility\Repository\AbstractRepository;

class ProductRepository extends AbstractRepository
{
    public const JOIN_PRODUCT_TYPE = 'joinProductType';

    public static function getEntityClass(): string
    {
        return Product::class;
    }

    public function find(int $productId): Product
    {
        /** @var Product $product */
        $product = $this->getDoctrineRepository()->find($productId);

        if (!$product) {
            throw new NotFoundException('The product was not found');
        }

        return $product;
    }

    protected function attachCustomFilters(QueryBuilder $qb, array $filters): JoinCollection
    {
        $joins = new JoinCollection();

        foreach ($filters as $key => $value) {
            switch ($key) {
                case 'barcodeLike':
                    $baseKey = \substr($key, 0, -4);

                    $qb->andWhere(static::getAlias() . ".{$baseKey} LIKE :{$key}")
                        ->setParameter($key, $value);
                    break;
                case static::JOIN_PRODUCT_TYPE:
                    $joins->addJoin(
                        new Join(
                            $value,
                            static::getAlias() . '.productType',
                            ProductTypeRepository::getAlias()
                        )
                    );
                default:
                    throw new Exception(\sprintf('Invalid filter `%s` for `%s::%s`', $key, static::class, __FUNCTION__));
            }
        }

        return $joins;
    }
}

Todo

• Unit tests.

Dev

git clone [e-mail]:drjele-doctrine/utility.git
cd utility

rm -rf .git/hooks && ln -s ../dev/git-hooks .git/hooks

./dc build && ./dc up -d