nepada/phone-number-doctrine

Phone number type for Doctrine.

v2.3.0 2024-04-06 10:31 UTC

Requires

• php: >=8.1.0 <8.4
• brick/phonenumber: ^0.2@dev || ^0.3@dev || ^0.4@dev || ^0.5@dev || ^0.6@dev
• doctrine/dbal: ^3.4@dev || ^4.0@dev

Requires (Dev)

• giggsey/libphonenumber-for-php: >=8.12.34
• 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-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
• Value Object
• phone number

README

Installation

Via Composer:

$ composer require nepada/phone-number-doctrine

Register the type in your bootstrap:

\Doctrine\DBAL\Types\Type::addType(
    \Brick\PhoneNumber\PhoneNumber::class,
    \Nepada\PhoneNumberDoctrine\PhoneNumberType::class
);

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

dbal:
    connection:
        types:
            Brick\PhoneNumber\PhoneNumber: Nepada\PhoneNumberDoctrine\PhoneNumberType

Usage

PhoneNumberType maps database value to phone number value object (see brick/phonenumber for further details) and back. The phone number is stored using E164 format, i.e. a '+' sign followed by a series of digits comprising the country code and national number.

Example usage in the entity:

use Doctrine\ORM\Mapping\Column;
use Doctrine\ORM\Mapping\Entity;
use Brick\PhoneNumber\PhoneNumber;

#[Entity]
class Contact
{

    #[Column(type: PhoneNumber::class, nullable: false)]
    private PhoneNumber $phoneNumber;

    public function getPhoneNumber(): PhoneNumber
    {
        return $this->phoneNumber;
    }

}

Example usage in query builder:

$result = $repository->createQueryBuilder('foo')
    ->select('foo')
    ->where('foo.phoneNumber = :phoneNumber')
     // the parameter value is automatically normalized to [phone]
    ->setParameter('phoneNumber', '[phone]', \Brick\PhoneNumber\PhoneNumber::class)
    ->getQuery()
    ->getResult();