This bundle integrates Google's libphonenumber into your Symfony2 application through the giggsey/libphonenumber-for-php port.

• Chris Wilkinson chris.wilkinson@admin.cam.ac.uk

1. Add the PhoneNumberBundle to your dependencies:

   // composer.json { // ... "require": { // ... "misd/phone-number-bundle": "~1.0" } } 

2. Use Composer to download and install the PhoneNumberBundle:

   $ php composer.phar update misd/phone-number-bundle 

3. Register the bundle in your application:

   // app/AppKernel.php public function registerBundles() { $bundles = array( // ... new Misd\PhoneNumberBundle\MisdPhoneNumberBundle() ); } 

The libphonenumber\PhoneNumberUtil class is available as the libphonenumber.phone_number_util service:

$phoneNumber = $container->get('libphonenumber.phone_number_util')->parse($string); 

Requires doctrine/doctrine-bundle.

To persist libphonenumber\PhoneNumber objects, add the Misd\PhoneNumberBundle\Doctrine\DBAL\Types\PhoneNumberType mapping to your application's config:

// app/config.yml doctrine: dbal: types: phone_number: Misd\PhoneNumberBundle\Doctrine\DBAL\Types\PhoneNumberType 

You can then use the phone_number mapping:

/** * @ORM\Column(type="phone_number") */ private $phoneNumber; 

This creates a varchar(35) column with a Doctrine mapping comment.

The phone_number_format function takes two arguments: a libphonenumber\PhoneNumber object and an optional libphonenumber\PhoneNumberFormat constant name.

For example, to format an object called myPhoneNumber in the libphonenumber\PhoneNumberFormat::NATIONAL format:

{{ phone_number_format(myPhoneNumber, 'NATIONAL') }} 

By default phone numbers are formatted in the libphonenumber\PhoneNumberFormat::INTERNATIONAL format.

The format() method in the phone_number_format helper takes two arguments: a libphonenumber\PhoneNumber object and an optional libphonenumber\PhoneNumberFormat constant name or value.

For example, to format $myPhoneNumber in the libphonenumber\PhoneNumberFormat::NATIONAL format, either use:

<?php echo $view['phone_number_format']->format($myPhoneNumber, 'NATIONAL') ?> 

or:

<?php echo $view['phone_number_format']->format($myPhoneNumber, \libphonenumber\PhoneNumberFormat::NATIONAL) ?> 

By default phone numbers are formatted in the libphonenumber\PhoneNumberFormat::INTERNATIONAL format.

Requires jms/serializer-bundle.

Instances of libphonenumber\PhoneNumber are automatically serialized in the E.164 format.

Phone numbers can be deserialized from an international format by setting the type to libphonenumber\PhoneNumber. For example:

use JMS\Serializer\Annotation\Type; /** * @Type("libphonenumber\PhoneNumber") */ private $phoneNumber; 

You can use the tel form type to create phone number fields. For example:

use libphonenumber\PhoneNumberFormat; use Symfony\Component\Form\FormBuilderInterface; public function buildForm(FormBuilderInterface $builder, array $options) { $builder->add('phone_number', 'tel', array('default_region' => 'GB', 'format' => PhoneNumberFormat::NATIONAL)); } 

By default the default_region and format options are PhoneNumberUtil::UNKNOWN_REGION and PhoneNumberFormat::INTERNATIONAL respectively.

You can use the Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber constraint to make sure that either a libphonenumber\PhoneNumber object or a plain string is a valid phone number. For example:

use Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber as AssertPhoneNumber; /** * @AssertPhoneNumber */ private $phoneNumber; 

You can set the default region through the defaultRegion property:

use Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber as AssertPhoneNumber; /** * @AssertPhoneNumber(defaultRegion="GB") */ private $phoneNumber; 

By default any valid phone number will be accepted. You can restrict the type through the type property, recognised values are mobile and fixed_line. (Note the libphonenumber cannot always distinguish between mobile and fixed-line numbers (eg in the USA), in which case it will be accepted.)

/** * @AssertPhoneNumber(type="mobile") */ private $mobilePhoneNumber;