odolbeau / phone-number-bundle
Integrates libphonenumber into your Symfony application
Installs: 6 450 324
Dependents: 10
Suggesters: 2
Security: 0
Stars: 215
Watchers: 10
Forks: 144
Open Issues: 8
Type:symfony-bundle
Requires
- php: >=8.1
- giggsey/libphonenumber-for-php: ^8.9
- symfony/framework-bundle: ^5.4 || ^6.3 || ^7.0
- symfony/intl: ^5.4 || ^6.3 || ^7.0
- symfony/polyfill-mbstring: ^1.28
Requires (Dev)
- doctrine/doctrine-bundle: ^1.12|^2.0
- phpspec/prophecy-phpunit: ^2.0
- phpunit/phpunit: ^9.6.11
- symfony/form: ^5.4 || ^6.3 || ^7.0
- symfony/phpunit-bridge: ^7.0
- symfony/property-access: ^5.4 || ^6.3 || ^7.0
- symfony/serializer: ^5.4 || ^6.3 || ^7.0
- symfony/twig-bundle: ^5.4 || ^6.3 || ^7.0
- symfony/validator: ^5.4 || ^6.3 || ^7.0
Suggests
- doctrine/doctrine-bundle: Add a DBAL mapping type
- symfony/form: Add a data transformer
- symfony/property-access: Choose a path in the validation constraint
- symfony/serializer: Serialize/deserialize phone numbers using Symfony library
- symfony/twig-bundle: Format phone numbers in Twig templates
- symfony/validator: Add a validation constraint
Replaces
- misd/phone-number-bundle: v4.0.1
- v4.0.1
- v4.0.0
- dev-master / 3.10.x-dev
- v3.10.0
- v3.9.3
- v3.9.2
- v3.9.1
- v3.9.0
- v3.8.0
- v3.7.0
- v3.6.3
- v3.6.2
- v3.6.1
- v3.6.0
- v3.5.0
- v3.4.2
- v3.4.1
- v3.4.0
- v3.3.3
- v3.3.2
- v3.3.1
- v3.3.0
- v3.2.1
- v3.2.0
- v3.1.1
- v3.1.0
- v3.0.0
- v2.0.2
- v2.0.1
- v2.0.0
- 1.3.x-dev
- v1.3.2
- v1.3.1
- v1.3.0
- 1.2.x-dev
- v1.2.0
- v1.1.3
- v1.1.2
- v1.1.1
- v1.1.0
- 1.0.x-dev
- v1.0.6
- v1.0.5
- v1.0.4
- v1.0.3
- v1.0.2
- v1.0.1
- v1.0.0
This package is auto-updated.
Last update: 2024-10-07 13:36:23 UTC
README
This bundle is a fork of misd-service-development/phone-number-bundle. As this project doesn't look maintained anymore, we decided to create & maintain a fork.
This bundle integrates Google's libphonenumber into your Symfony application through the giggsey/libphonenumber-for-php port.
Installation
- Use Composer to download the PhoneNumberBundle:
$ composer require odolbeau/phone-number-bundle
if you're using Symfony Flex, that's all you have to do! Otherwise:
- Register the bundle in your application:
// app/AppKernel.php public function registerBundles() { $bundles = [ // ... new Misd\PhoneNumberBundle\MisdPhoneNumberBundle() ]; }
Update from misd/phone-number-bundle
The update from misd/phone-number-bundle
to odolbeau/phone-number-bundle
should be really easy.
Update your composer.json:
- "misd/phone-number-bundle": "^1.3", + "odolbeau/phone-number-bundle": "^3.0",
Then run composer update misd/phone-number-bundle odolbeau/phone-number-bundle
.
If you're using a container parameter or alias defined by misd/phone-number-bundle
you can use "odolbeau/phone-number-bundle": "^2.0"
until your project is cleaned.
Usage
Services
The following services are available:
To parse a string into a libphonenumber\PhoneNumber
object, inject the service and:
$phoneNumber = $this->phoneNumberUtil->parse($string, PhoneNumberUtil::UNKNOWN_REGION);
Doctrine mapping
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.
Note that if you're putting the phone_number
type on an already-existing schema the current values must be converted to the libphonenumber\PhoneNumberFormat::E164
format.
Twig Templating
If any of the form_div_layout
, bootstrap_3_*
, bootstrap_4_*
or bootstrap_5_*
layouts are registered in your twig configuration, the bundle will automatically register the template used to render the Misd\PhoneNumberBundle\Form\Type
form type.
phone_number_format
The phone_number_format
filter can be used to format a phone number object. A libphonenumber\PhoneNumberFormat
constant can be passed as argument to specify in which format the number should be printed.
For example, to format an object called myPhoneNumber
in the libphonenumber\PhoneNumberFormat::NATIONAL
format:
{{ myPhoneNumber|phone_number_format('NATIONAL') }}
By default phone numbers are formatted in the libphonenumber\PhoneNumberFormat::INTERNATIONAL
format.
phone_number_of_type
The phone_number_of_type
test can be used to check a phone number against a type: A libphonenumber\PhoneNumberType
constant name must be passed to specify to which type a number has to match.
For example, to check if an object called myPhoneNumber
is a libphonenumber\PhoneNumberType::MOBILE
type:
{% if myPhoneNumber is phone_number_of_type('MOBILE') }} %} ... {% endif %}
Using libphonenumber\PhoneNumber
objects in forms
You can use the PhoneNumberType
(phone_number
for Symfony 2.7) form type to create phone number fields. There are two widgets available.
Single text field
A single text field allows the user to type in the complete phone number. When an international prefix is not entered, the number is assumed to be part of the set default_region
. For example:
use libphonenumber\PhoneNumberFormat; use Misd\PhoneNumberBundle\Form\Type\PhoneNumberType; use Symfony\Component\Form\FormBuilderInterface; public function buildForm(FormBuilderInterface $builder, array $options) { $builder->add('phoneNumber', PhoneNumberType::class, ['default_region' => 'GB', 'format' => PhoneNumberFormat::NATIONAL]); }
By default the default_region
and format
options are PhoneNumberUtil::UNKNOWN_REGION
and PhoneNumberFormat::INTERNATIONAL
respectively.
Country choice fields
The phone number can be split into a country choice and phone number text fields. This allows the user to choose the relevant country (from a customisable list) and type in the phone number without international dialling.
use libphonenumber\PhoneNumberFormat; use Misd\PhoneNumberBundle\Form\Type\PhoneNumberType; use Symfony\Component\Form\FormBuilderInterface; public function buildForm(FormBuilderInterface $builder, array $options) { $builder->add('phoneNumber', PhoneNumberType::class, [ 'widget' => PhoneNumberType::WIDGET_COUNTRY_CHOICE, 'country_choices' => ['GB', 'JE', 'FR', 'US'], 'preferred_country_choices' => ['GB', 'JE'] ]); }
This produces the preferred choices of 'Jersey' and 'United Kingdom', and regular choices of 'France' and 'United States'.
By default the country_choices
is empty, which means all countries are included, as is preferred_country_choices
.
The option country_placeholder
can be specified to create a placeholder option on above the whole list.
The option country_display_type
can be specified to change the country dropdown label format. There are two formats available :
And with the option country_display_emoji_flag
set to true
(default is false
) you can add the emoji flag of the country before the label :
Validating phone numbers
ℹ️ Using a Symfony or PHP version that does not support attributes? This bundle also supports validation as annotation. Take a look at the old documentation.
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;
You can also set default region in the bundle config:
misd_phone_number: validator: default_region: GB
You can also define a region dynamically according to the context of the validated object thanks to the "regionPath" property (here according to the user's region):
use Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber as AssertPhoneNumber; #[AssertPhoneNumber(regionPath: 'countryCode')] private $phoneNumber; private $countryCode; public function getCountryCode() { return $this->countryCode; }
By default any valid phone number will be accepted. You can restrict the type through the type
property, recognised values:
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::ANY
(default)Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::FIXED_LINE
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::MOBILE
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::PAGER
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::PERSONAL_NUMBER
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::PREMIUM_RATE
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::SHARED_COST
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::TOLL_FREE
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::UAN
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::VOIP
Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber::VOICEMAIL
(Note that libphonenumber cannot always distinguish between mobile and fixed-line numbers (eg in the USA), in which case it will be accepted.)
use Misd\PhoneNumberBundle\Validator\Constraints\PhoneNumber as AssertPhoneNumber; #[AssertPhoneNumber(type: [AssertPhoneNumber::MOBILE])] private $mobilePhoneNumber; #[AssertPhoneNumber(type: [AssertPhoneNumber::FIXED_LINE, AssertPhoneNumber::VOIP])] private $fixedOrVoipPhoneNumber;
Translations
The bundle contains translations for the form field and validation constraints.
In cases where a language uses multiple terms for mobile phones, the generic language locale will use the term 'mobile', while country-specific locales will use the relevant term. So in English, for example, en
uses 'mobile', en_US
uses 'cell' and en_SG
uses 'handphone'.
If your language doesn't yet have translations, feel free to open a pull request to add them in!
Configuration
To disable integrations with components
misd_phone_number: twig: false form: false serializer: false validator: false
License
This bundle is released under the MIT License. See the bundled LICENSE file for details.