Validator

Simple usage

You can directly instantiate a validator the following way:

1
$validator = new \DoctrineModule\Validator\ObjectExists([
    'object_repository' => $objectManager->getRepository('Application\Entity\User'),
    'fields' => ['email'],
]);

var_dump($validator->isValid('[email protected]')); // dumps 'true' if an entity matches
var_dump($validator->isValid(['email' => '[email protected]'])); // dumps 'true' if an entity matches
2
3
4
5
6
7

Use together with Laminas forms

Of course, validators are especially useful when paired with forms. To add a NoObjectExists validator to a Laminas form element:

1
namespace Application\Form;

use DoctrineModule\Validator\NoObjectExists as NoObjectExistsValidator;
use Laminas\Form\Form;
use Laminas\ServiceManager\ServiceManager;
use Application\Entity;

class User extends Form
{
    public function __construct(ServiceManager $serviceManager)
    {
        parent::__construct('my-form');

        // Add an element
        $this->add([
            'type'    => 'Laminas\Form\Element\Email',
            'name'    => 'email',
            'options' => [
                'label' => 'Email',
            ],
            'attributes' => [
                'required' => 'required',
            ],
        ]);

        // add other elements (submit, CSRF…)

        // Fetch any valid object manager from the Service manager
        $entityManager = $serviceManager->get('doctrine.entitymanager.orm_default');

        // Now get the input filter of the form, and add the validator to the email input
        $emailInput = $this->getInputFilter()->get('email');

        $noObjectExistsValidator = new NoObjectExistsValidator([
            'object_repository' => $entityManager->getRepository(Entity\User::class),
            'fields'            => 'email',
        ]);

        $emailInput
            ->getValidatorChain()
            ->attach($noObjectExistsValidator);
    }
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

If you are using fieldsets you can directly add the validator using the array notation. For instance in the getInputFilterSpecification function, as shown here:

1
namespace Application\Form;

use Laminas\Form\Fieldset;
use Laminas\InputFilter\InputFilterProviderInterface;
use Laminas\ServiceManager\ServiceManager;
use Application\Entity;

class UserFieldset extends Fieldset implements InputFilterProviderInterface
{
    protected $serviceManager;

    public function __construct(ServiceManager $serviceManager)
    {
        $this->serviceManager = $serviceManager;

        parent::__construct('my-fieldset');

        // Add an element
        $this->add([
            'type'    => 'Laminas\Form\Element\Email',
            'name'    => 'email',
            'options' => [
                'label' => 'Email',
            ],
            'attributes' => [
                'required' => 'required',
            ],
        ]);
    }

    public function getInputFilterSpecification()
    {
        $entityManager = $this->serviceManager->get('doctrine.entitymanager.orm_default');

        return [
            'email' => [
                'validators' => [
                    [
                        'name' => 'DoctrineModule\Validator\NoObjectExists',
                        'options' => [
                            'object_repository' => $entityManager->getRepository(Entity\User::class),
                            'fields' => 'email',
                        ],
                    ],
                ],
            ],
        ];
    }
}
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49

You can change the default message of the validators like this:

1
// For NoObjectExists validator (using array notation) :
'validators' => [
    [
        'name' => 'DoctrineModule\Validator\NoObjectExists',
        'options' => [
            'object_repository' => $this->getEntityManager()->getRepository('Application\Entity\User'),
            'fields' => 'email',
            'messages' => [
                'objectFound' => 'A user with this email already exists.',
            ],
        ],
    ],
],

// For ObjectExists validator (using object notation) :
$objectExistsValidator = new \DoctrineModule\Validator\ObjectExists([
    'object_repository' => $entityManager->getRepository('Application\Entity\User'),
    'fields'            => 'email',
]);

**$objectExistsValidator->setMessage('noObjectFound', 'Email was not found.');**
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

UniqueObject

There are two things you have to think about when using DoctrineModule\Validator\UniqueObject; As mentioned above you have to pass an ObjectManager as object_manager option and second you have to pass a value for every identifier your entity has.

• If you leave out the use_context option or set it to false you have to pass an array containing the fields- and identifier-values into isValid(). When using Laminas\Form this behaviour is needed if you’re using fieldsets.
• If you set the use_context option to true you have to pass the fields-values as first argument and an array containing the identifier-values as second argument into isValid(). When using Laminas\Form without fieldsets, this behaviour would be needed.

Important: Whatever you choose, please ensure that the identifier-values are named by the field-names, not by the database-column.