cherif/php-algerian-mobile-phone-number-doctrine

Use cherif/algerian-mobile-phone-number with doctrine

0.1.1 2020-09-16 15:40 UTC

Requires

• php: >=7.2.0
• cherif/algerian-mobile-phone-number: ^0.5.0
• doctrine/dbal: ^2.10

Requires (Dev)

• phpspec/prophecy-phpunit: ^2.0
• phpunit/phpunit: ^9.1

MIT

• Cherif BOUCHELAGHEM

README

The cherif/php-algerian-mobile-phone-number-doctrine package allows to use cherif/algerian-mobile-phone-number as a Doctrine field type.

Installtion

The recommended way of installation is by using Packagist and Composer.

The following command should be executed in order to add the package as a requirement to composer.json of a project:

$ composer require cherif/php-algerian-mobile-phone-number-doctrine

Examples:

To configure Doctrine to use cherif/php-algerian-mobile-phone-number-doctrine as a field type, you'll need to set up the following in your bootstrap:

\Doctrine\DBAL\Types\Type::addType('algerian_mobile_phone_number', 'Cherif\AlgerianMobilePhoneNumber\Doctrine\AlgerianMobilePhoneNumberType');

In Symfony:

# config/packages/doctrine.yaml
doctrine:
  dbal:
    types:
      algerian_mobile_phone_number: Cherif\AlgerianMobilePhoneNumber\Doctrine\AlgerianMobilePhoneNumberType

Usage:

Then, in your entities, you may annotate properties by setting the @Column type to algerian_mobile_phone_number:

use Doctrine\ORM\Mapping as ORM;
use Cherif\AlgerianMobilePhoneNumber\AlgerianMobilePhoneNumber;

/**
 * @ORM\Entity
 * @ORM\Table(name="person")
 */
class Person
{
    /**
     * @var Cherif\AlgerianMobilePhoneNumber\AlgerianMobilePhoneNumber
     *
     * @ORM\Id
     * @ORM\Column(type="algerian_mobile_phone_number", unique=true)
     */
    protected $mobilePhoneNumber;

    public function getMobilePhoneNumber(): AlgerianMobilePhoneNumber
    {
        return $this->mobilePhoneNumber;
    }
}

To use XML Mapping instead of PHP annotations.

...

<field name="mobilePhoneNumber" column="mobile_phone_number" type="algerian_mobile_phone_number" unique="true" />

...

Contribution

Contributions are welcome to make this library better.

• Clone the repo:

$ git clone [e-mail]:cherifGsoul/php-algerian-mobile-phone-number-doctrine.git

and enter to the cloned repository directory.

• Install dependencies:

$ composer install

Testing:

Run composer script for testing:

$ ./bin/phpunit

License

MIT License.