Adds a phone validator to Laravel 4 and 5 based on the PHP port of Google's libphonenumber API by giggsey.
-
In the
require
key ofcomposer.json
file add the following"propaganistas/laravel-phone": "~2.0"
-
Run the Composer update command
$ composer update
-
In your app config, add the Service Provider to the end of the
$providers
arrayLaravel 5
'providers' => [ App\Providers\EventServiceProvider::class, App\Providers\RouteServiceProvider::class, ... Propaganistas\LaravelPhone\LaravelPhoneServiceProvider::class, ],
Laravel 4
'providers' => [ 'Illuminate\Foundation\Providers\ArtisanServiceProvider', 'Illuminate\Auth\AuthServiceProvider', ... 'Propaganistas\LaravelPhone\LaravelPhoneServiceProvider', ],
-
In your languages directory, add for each language an extra language line for the validator:
"phone" => "The :attribute field contains an invalid number.", ```
To validate a field using the phone validator, use the phone
keyword in your validation rules array. The phone validator is able to operate in three ways.
-
You either specify ISO 3166-1 alpha-2 compliant country codes yourself as parameters for the validator, e.g.:
'phonefield' => 'phone:US,BE', ```
The validator will check if the number is valid in at least one of provided countries, so feel free to add as many country codes as you like.
-
You don't specify any parameters but you plug in a dedicated country input field (keyed by ISO 3166-1 compliant country codes) to allow end users to supply a country on their own. The easiest method by far is to install the CountryList package by monarobase. The country field has to be named similar to the phone field but with
_country
appended:
'phonefield' => 'phone', 'phonefield_country' => 'required_with:phonefield', ```
If using the CountryList package, you could then use the following snippet to populate a country selection list:
```php
Countries::getList(App::getLocale(), 'php', 'cldr')) ```
-
You instruct the validator to detect which country the number belongs to using the
AUTO
keyword:
'phonefield' => 'phone:AUTO', ```
The validator will try to extract the country from the number itself and then check if the number is valid for that country. Note that this will only work when phone numbers are entered in international format (prefixed with a +
sign, e.g. +32 ....). Leading double zeros will NOT be parsed correctly as this isn't an established consistency.
To specify constraints on the number type, just append the allowed types to the end of the parameters, e.g.:
'phonefield' => 'phone:US,BE,mobile',
The most common types are mobile
and fixed_line
, but feel free to use any of the types defined here.
Format a fetched phone value using the helper function:
phone_format($phone_number, $country_code, $format = null)
The $format
parameter is optional and should be a constant of \libphonenumber\PhoneNumberFormat
(defaults to \libphonenumber\PhoneNumberFormat::INTERNATIONAL
)