Important

We are updating the images for OroCommerce version 6.1 to align with the latest changes in the back-office design. During this transition, some images may still show older versions. Thank you for your patience as we work to update all visuals to reflect these changes.

How to Use the Draft Filter

To restrict access to draft entities on pages, use a query modification mechanism that is implemented in Doctrine Filters.

Follow the instructions provided in the Doctrine Filters topic for more details.

The system already has the DraftableFilterManager auxiliary manager that can be used to turn on/off the draft filter.

This example describes how to disable the draft filter. The following validator checks both unique and draft entities.

namespace Acme\Bundle\DemoBundle\Validator\Constraints;

use Acme\Bundle\DemoBundle\Entity\Block;
use Doctrine\Persistence\ManagerRegistry;
use Oro\Bundle\DraftBundle\Manager\DraftableFilterManager;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\ConstraintValidator;
use Symfony\Component\Validator\Exception\UnexpectedTypeException;

/**
 * Validates whether at least one record exists (includes draft entities).
 */
class UniqueTitleDraftValidator extends ConstraintValidator
{
    private ManagerRegistry $doctrine;
    private DraftableFilterManager $filterManager;

    public function __construct(
        ManagerRegistry $doctrine,
        DraftableFilterManager $filterManager
    ) {
        $this->doctrine = $doctrine;
        $this->filterManager = $filterManager;
    }

    #[\Override]
    public function validate($value, Constraint $constraint): void
    {
        if (!$constraint instanceof UniqueTitleDraft) {
            throw new UnexpectedTypeException($constraint, UniqueTitleDraft::class);
        }

        $this->filterManager->disable(Block::class);
        try {
            $result = $this->doctrine->getRepository(Block::class)->findBy(['title' => $value]);
        } finally {
            $this->filterManager->enable(Block::class);
        }

        $countResult = count($result);
        if (0 === $countResult || (1 === $countResult && $this->context->getObject() === current($result))) {
            return;
        }

        $this->context->addViolation($constraint->message);
    }
}