ydee/phone-number-bundle

Symfony 6.4+ bundle for robust phone number validation and formatting, powered by libphonenumber.

dev-main / 1.0.x-dev 2025-07-04 07:55 UTC

Requires

• php: >=8.1
• giggsey/libphonenumber-for-php: ^8.12
• symfony/framework-bundle: >=6.4

Requires (Dev)

• phpunit/phpunit: ^10.0
• symfony/validator: ^6.4

MIT

• Yaovi

README

Symfony 6.4+ bundle for robust phone number validation and formatting, powered by libphonenumber.

Features

• Phone number validation for Symfony forms and Doctrine entities
• Region-aware validation (optional)
• Inspired by misd/phone-number-bundle, but fully compatible with Symfony 6.4+

Installation

Usage

1. Enable the bundle (if not using Symfony Flex)

// config/bundles.php
return [
    // ...
    Ydee\PhoneNumberBundle\PhoneNumberBundle::class => ['all' => true],
];

2. Add the constraint to your entity or form

use Ydee\PhoneNumberBundle\Validator\Constraints\PhoneNumber;

class User
{
    #[PhoneNumber(region: 'FR', message: 'Please enter a valid French phone number.')]
    private ?string $phone = null;
}

3. Customizing

• The region option is optional. If omitted, parsing will be international.
• The default error message is: This value is not a valid phone number.

Translation

The default error message can be translated using Symfony's translation component. Add the following to your translation files (e.g., validators.en.yaml):

Ydee\PhoneNumberBundle\Validator\Constraints\PhoneNumber:
    This value is not a valid phone number.: 'Your custom message here.'

Future Extensions

You may add a phone number formatting service to provide consistent output formatting using libphonenumber. If you need this, open an issue or contribute!

Symfony Flex Recipe

For easier installation, consider contributing a Symfony Flex recipe to enable auto-registration of the bundle.

Contributing

Contributions are welcome! Please submit pull requests or open issues for bugs, features, or improvements.

License

MIT +Copyright (c) 2025 Yaovi + +## Support + +For support, please open an issue on the repository or contact the author at [e-mail].

Changelog

See CHANGELOG.md for version history and updates.

Running Tests

To run the test suite:

composer install
vendor/bin/phpunit