You are browsing a version that is no longer maintained.

Miscellaneous

The items listed below are optional and intended to enhance integration between Laminas and Doctrine ORM.

ObjectExists Validator and NoObjectExists Validator

ObjectExists and NoObjectExists are validators similar to Laminas Validators. You can pass a variety of options to determine validity. The most basic use case requires an entity manager, an entity, and a field. You also have the option of specifying a query_builder Closure to use if you want to fine tune the results.

1 <?php
$validator = new \DoctrineModule\Validator\NoObjectExists([
    // object repository to lookup
    'object_repository' => $serviceLocator->get('doctrine.entitymanager.orm_default')   
        ->getRepository('Db\Entity\User'),

    // fields to match
    'fields' => ['username'],
]);

// following works also with simple values if the number of fields to be matched is 1
echo $validator->isValid(['username' => 'test']) ? 'Valid' : 'Invalid. A duplicate was found.';
2
3
4
5
6
7
8
9
10
11
12

Authentication Adapter

The authentication adapter is intended to provide an adapter for Laminas\Authentication. It works much like the DbTable adapter in the core framework. You must provide the entity manager instance, entity name, identity field, and credential field. You can optionally provide a callable method to perform hashing on the password prior to checking for validation.

1 <?php

use DoctrineModule\Authentication\Adapter\DoctrineObject as DoctrineObjectAdapter;

$adapter = DoctrineObjectAdapter(
    $entityManager,
    'Application\Test\Entity',
    'username', // optional, default shown
    'password',  // optional, default shown,
    function($identity, $credential) { // optional callable
        return \Application\Service\User::hashCredential(
            $credential,
            $identity->getSalt(),
            $identity->getAlgorithm()
        );
    }
);

$adapter->setIdentityValue('admin');
$adapter->setCredentialValue('password');
$result = $adapter->authenticate();

echo $result->isValid() ? 'Authenticated' : 'Could not authenticate';
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

Custom DBAL Types

To register custom Doctrine DBAL types add them to the doctrine.configuration.orm_default.types key in you configuration file:

1 <?php
return [
    'doctrine' => [
        'configuration' => [
            'orm_default' => [
                'types' => [
                    // You can override a default type
                    'date' => 'My\DBAL\Types\DateType',

                    // And set new ones
                    'tinyint' => 'My\DBAL\Types\TinyIntType',
                ],
            ],
        ],
    ],
];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

With this configuration you may use them in your ORM entities to define field datatypes:

1 <?php

class User
{
    /**
     * @ORM\Column(type="date")
     */
    protected $birthdate;

    /**
     * @ORM\Column(type="tinyint")
     */
    protected $houses;
}
2
3
4
5
6
7
8
9
10
11
12
13
14

To have Schema-Tool convert the underlying database type of your new "tinyint" directly into an instance of TinyIntType you have to additionally register this mapping with your database platform.

1 <?php
return [
    'doctrine' => [
        'connection' => [
            'orm_default' => [
                'doctrine_type_mappings' => [
                    'tinyint' => 'tinyint',
                ],
            ],
        ],
    ],
];
2
3
4
5
6
7
8
9
10
11
12

Now using Schema-Tool, whenever it finds a column of type "tinyint" it will convert it into a "tinyint" Doctrine Type instance for Schema representation. Keep in mind that you can easily produce clashes this way because each database type can only map to exactly one Doctrine mapping type.

1	<?php $validator = new \DoctrineModule\Validator\NoObjectExists([ // object repository to lookup 'object_repository' => $serviceLocator->get('doctrine.entitymanager.orm_default') ->getRepository('Db\Entity\User'), // fields to match 'fields' => ['username'], ]); // following works also with simple values if the number of fields to be matched is 1 echo $validator->isValid(['username' => 'test']) ? 'Valid' : 'Invalid. A duplicate was found.';
2
3
4
5
6
7
8
9
10
11
12

1	<?php use DoctrineModule\Authentication\Adapter\DoctrineObject as DoctrineObjectAdapter; $adapter = DoctrineObjectAdapter( $entityManager, 'Application\Test\Entity', 'username', // optional, default shown 'password', // optional, default shown, function($identity, $credential) { // optional callable return \Application\Service\User::hashCredential( $credential, $identity->getSalt(), $identity->getAlgorithm() ); } ); $adapter->setIdentityValue('admin'); $adapter->setCredentialValue('password'); $result = $adapter->authenticate(); echo $result->isValid() ? 'Authenticated' : 'Could not authenticate';
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

1	<?php return [ 'doctrine' => [ 'configuration' => [ 'orm_default' => [ 'types' => [ // You can override a default type 'date' => 'My\DBAL\Types\DateType', // And set new ones 'tinyint' => 'My\DBAL\Types\TinyIntType', ], ], ], ], ];
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

1	<?php class User { /** * @ORM\Column(type="date") / protected $birthdate; /* * @ORM\Column(type="tinyint") */ protected $houses; }
2
3
4
5
6
7
8
9
10
11
12
13
14

1	<?php return [ 'doctrine' => [ 'connection' => [ 'orm_default' => [ 'doctrine_type_mappings' => [ 'tinyint' => 'tinyint', ], ], ], ], ];
2
3
4
5
6
7
8
9
10
11
12

Maintained

Unmaintained

Miscellaneous

ObjectExists Validator and NoObjectExists Validator

Authentication Adapter

Custom DBAL Types