Doctrine.md

Doctrine Parser

What is it?

• FL\QBJSParser\Doctrine\AbstractDoctrineParser parses FL\QBJSParser\Model\RuleGroup into a FL\QBJSParser\Parsed\Doctrine\ParsedRuleGroup.
• A ParsedRuleGroup has three properties accessible via getters: $queryString, $parameters, and $className.
• Use the ParsedRuleGroup to create a Doctrine Query with Doctrine\ORM\EntityManager::createQuery($dql) and Doctrine\ORM\Query::setParameters($parameters)

Usage

• When you are parsing a $jsonString for a particular Doctrine Entity, create an instance of DoctrineParser.
• Don't forget to construct this instance with the $classname of the Doctrine Entity, the $queryBuilderFieldsToEntityProperties, and $queryBuilderFieldPrefixesToAssociationClasses.

Example

Suppose you have a Doctrine entity, such as this one,

<?php

namespace YourNamespace\YourApp\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class Product
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer", nullable=false)
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\Column(type="string", nullable=false)
     * @var string
     */
    private $name;

    /**
     * @ORM\Column(type="decimal", nullable=true, scale=2, precision=10)
     * @var string|null
     */
    private $price;
    
    /**
     * @ORM\ManyToMany(targetEntity="Label")
     * @var string|null
     */
    private $labels;

    //...
}

And its $labels association, looks like this

<?php

namespace YourNamespace\YourApp\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Entity()
 */
class Label
{
    /**
     * @ORM\Id
     * @ORM\Column(type="integer", nullable=false)
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * @ORM\Column(type="string", nullable=false)
     * @var string
     */
    private $name;

    //...
}

Assuming you have an $entityManager, and a valid $jsonString created by jQuery QueryBuilder, you are ready to create a Doctrine query, and get results!

<?php

namespace YourNamespace\YourApp\Controller;

use Doctrine\ORM\EntityManagerInterface;
use FL\QBJSParser\Serializer\JsonDeserializer;
use FL\QBJSParser\Parser\Doctrine\DoctrineParser;
use YourNamespace\YourApp\Entity\Product;
use YourNamespace\YourApp\Entity\Label;

//...
    $jsonDeserializer = new JsonDeserializer();
    $productParser = new DoctrineParser(Product::class, 
        [
            'id'=>'id',
            'name'=>'name',
            'price'=>'price',
            'labels.id' => 'labels.id',
            'labels.name' => 'labels.name',
        ],
        [
            'labels'=>Label::class,
        ]
    );
    
    $deserializedRuleGroup = $jsonDeserializer->deserialize($jsonString);
    $parsedRuleGroup = $productParser->parse($deserializedRuleGroup);
    
    /** @var EntityManagerInterface $entityManager */
    $query = $entityManager->createQuery($parsedRuleGroup->getQueryString());
    $query->setParameters($parsedRuleGroup->getParameters());
    $results = $query->execute();
//... 

Now supporting Doctrine embeddables. For example:

<?php

//...
    $productParser = new DoctrineParser(
            // $className
            Entity::class,
            // $fieldsToProperties
            [
                'id' => 'id',
                'price' => 'price',
                'name' => 'name',
                'date' => 'date',
                'associationEntity.id' => 'associationEntity.id',
            ],
            // $fieldPrefixesToClasses
            [
                'associationEntity' => AssociationEntity::class,
            ],
            // $embeddableFieldsToProperties
            [
                'embeddable.startDate' => 'embeddable.startDate',
                'embeddable.endDate' => 'embeddable.endDate',
                'associationEntity.embeddable.startDate' => 'associationEntity.embeddable.startDate',
                'associationEntity.embeddable.endDate' => 'associationEntity.embeddable.endDate',
                'associationEntity.associationEntity.embeddable.startDate' => 'associationEntity.associationEntity.embeddable.startDate',
            ],
            // $embeddableInsideEmbeddableFieldsToProperties
            [
                'embeddable.embeddableInsideEmbeddable.code' => 'embeddable.embeddableInsideEmbeddable.code',
                'associationEntity.embeddable.embeddableInsideEmbeddable.code' => 'associationEntity.embeddable.embeddableInsideEmbeddable.code'
            ],
            // $embeddableFieldPrefixesToClasses
            [
                'associationEntity' => AssociationEntity::class,
                'associationEntity.associationEntity' => AssociationEntity::class,
            ],
            // $embeddableFieldPrefixesToEmbeddableClasses
            [
                'embeddable' => Embeddable::class,
                'associationEntity.embeddable' => Embeddable::class,
                'associationEntity.associationEntity.embeddable' => Embeddable::class,
                'embeddable.embeddableInsideEmbeddable' => EmbeddableInsideEmbeddable::class,
                'associationEntity.embeddable.embeddableInsideEmbeddable' => EmbeddableInsideEmbeddable::class,
            ]
        );
//...