nepada/email-address-doctrine

Email address type for Doctrine.

v1.8.0 2024-04-06 09:14 UTC

Requires

• php: >=8.1.0 <8.4
• doctrine/dbal: ^3.0@dev || ^4.0@dev
• nepada/email-address: ^2.3@dev || ^3.0@dev

Requires (Dev)

• mockery/mockery: 1.6.11
• nepada/coding-standard: 7.14.0
• nepada/phpstan-nette-tester: 1.1.0
• nette/tester: 2.5.2
• php-parallel-lint/php-parallel-lint: 1.4.0
• phpstan/phpstan: 1.10.66
• phpstan/phpstan-mockery: 1.1.2
• phpstan/phpstan-nette: 1.2.9
• phpstan/phpstan-strict-rules: 1.5.2
• shipmonk/phpstan-rules: 2.11.3
• spaze/phpstan-disallowed-calls: 3.1.2

BSD-3-Clause

• Petr Morávek

• doctrine
• nette
• Value Object
• email address

README

Installation

Via Composer:

$ composer require nepada/email-address-doctrine

Register the types in your bootstrap:

\Doctrine\DBAL\Types\Type::addType(
    \Nepada\EmailAddress\RfcEmailAddress::class,
    \Nepada\EmailAddressDoctrine\RfcEmailAddressType::class
);
\Doctrine\DBAL\Types\Type::addType(
    \Nepada\EmailAddress\CaseInsensitiveEmailAddress::class,
    \Nepada\EmailAddressDoctrine\CaseInsensitiveEmailAddressType::class
);

In Nette with nettrine/dbal integration, you can register the types in your configuration:

dbal:
    connection:
        types:
            Nepada\EmailAddress\RfcEmailAddress: Nepada\EmailAddressDoctrine\RfcEmailAddressType
            Nepada\EmailAddress\CaseInsensitiveEmailAddress: Nepada\EmailAddressDoctrine\CaseInsensitiveEmailAddressType

Usage

This package provides two Doctrine types:

1. RfcEmailAddressType for storing emails represented by RfcEmailAddress.
2. CaseInsensitiveEmailAddressType for storing emails represented by CaseInsensitiveEmailAddress.

Both types normalize the domain part of the email address before storing it in database, but they differ in handling of the local part of the address. See nepada/email-address for further details.

Example usage in the entity:

use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
use Nepada\EmailAddress\CaseInsensitiveEmailAddress;

#[Entity]
class Contact
{

    #[Column(type: CaseInsensitiveEmailAddress::class, nullable: false)]
    private CaseInsensitiveEmailAddress $email;

    public function getEmailAddress(): CaseInsensitiveEmailAddress
    {
        return $this->emailAddress;
    }

}

Example usage in query builder:

$result = $repository->createQueryBuilder('foo')
    ->select('foo')
    ->where('foo.email = :emailAddress')
     // the parameter value is automatically normalized to [e-mail]
    ->setParameter('emailAddress', '[e-mail]', CaseInsensitiveEmailAddress::class)
    ->getQuery()
    ->getResult();