Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/m-adamski/symfony-phone-number-bundle
Bundle for Symfony which integrates with the libphonenumber library
https://github.com/m-adamski/symfony-phone-number-bundle
phonenumber-bundle php symfony symfony-bundle
Last synced: 26 days ago
JSON representation
Bundle for Symfony which integrates with the libphonenumber library
- Host: GitHub
- URL: https://github.com/m-adamski/symfony-phone-number-bundle
- Owner: m-adamski
- License: mit
- Created: 2018-11-19T14:28:18.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T10:23:45.000Z (9 months ago)
- Last Synced: 2024-09-12T22:21:31.686Z (about 2 months ago)
- Topics: phonenumber-bundle, php, symfony, symfony-bundle
- Language: PHP
- Homepage:
- Size: 73.2 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PhoneNumber Bundle for Symfony
Custom PhoneNumber Bundle integrating [libphonenumber](https://github.com/giggsey/libphonenumber-for-php) library into Symfony 4 project. This bundle is inspired by [PhoneNumberBundle](https://github.com/misd-service-development/phone-number-bundle) but simplified and created for own projects.
This bundle is compatible with Symfony 4.1 and Symfony 5.0. Symfony 3.4 compatibility abandoned.
## Installation
Use Composer to install this bundle into Symfony 4 project:
```
$ composer require m-adamski/symfony-phone-number-bundle
```
## Configuration
Register new Doctrine Type in ``config/packages/doctrine.yaml``
```yaml
doctrine:
dbal:
types:
phone_number: Adamski\Symfony\PhoneNumberBundle\Doctrine\DBAL\Types\PhoneNumberType
```
This Bundle provide type template for Bootstrap 4. Register it in ``config/packages/twig.yaml``
```yaml
twig:
form_themes:
- '@PhoneNumber/Form/phone_number_widget.html.twig'
```
You can also overwrite default Symfony Bootstrap 4 template by adding ``- '@PhoneNumber/Form/bootstrap_4_layout.html.twig'`` into ``form_themes`` parameter:
```yaml
twig:
form_themes:
- '@PhoneNumber/Form/bootstrap_4_layout.html.twig'
- '@PhoneNumber/Form/phone_number_widget.html.twig'
```
## How to use it?
Bundle provide additional Doctrine Type and Form Type. First, edit entity to use PhoneNumber Type:
```php
use Adamski\Symfony\PhoneNumberBundle\Model\PhoneNumber;
use Adamski\Symfony\PhoneNumberBundle\Validator\Constraints\PhoneNumber as AssertPhoneNumber;
/**
* @var string
* @AssertPhoneNumber
* @ORM\Column(name="phone_number", type="phone_number", nullable=true)
*/
protected $phoneNumber;
```
Now it's time to provide changes in Form Type:
```php
use Adamski\Symfony\PhoneNumberBundle\Form\PhoneNumberType;
public function buildForm(FormBuilderInterface $builder, array $options) {
$builder->add("phoneNumber", PhoneNumberType::class, [
"label" => "Phone number",
"preferred" => "PL",
"required" => false
]);
}
```
The displayed phone number in the template can be formatted according to the given pattern.
For this purpose, the Twig ``phone_number`` filter has been implemented.
```twig
{{ current_customer.phoneNumber|phone_number('E164') }}
{{ current_customer.phoneNumber|phone_number('RFC3966') }}
{{ current_customer.phoneNumber|phone_number('NATIONAL') }}
{{ current_customer.phoneNumber|phone_number('INTERNATIONAL') }}
```
## License
MIT