README.md

Laravel Phone Validator

Adds a phone validator to Laravel based on the PHP port of Google's libphonenumber API by giggsey.

Installation

1. In the require key of composer.json file add the following

    "propaganistas/laravel-phone": "dev-master"
   

2. Run the Composer update comand

    $ composer update
   

3. In your app/config/app.php add 'Propaganistas\LaravelPhone\LaravelPhoneServiceProvider', to the end of the $providers array

    'providers' => array(
      'Illuminate\Foundation\Providers\ArtisanServiceProvider',
      'Illuminate\Auth\AuthServiceProvider',
      ...
      'Propaganistas\LaravelPhone\LaravelPhoneServiceProvider',
    ),
   

4. In your app/lang add for each language an extra language line for the validator:

    "phone" => "The :attribute field contains an invalid number.",
   

Usage

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 two ways.

• You either specify ISO 3166-1 compliant country codes yourself as parameters for the validator, e.g.:

    public static $rules = array(
      '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.

• Or 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:

    public static $rules = array(
      'phonefield'          => 'phone',
      'phonefield_country'  => 'required_with:phonefield',
    );
  

  If using the CountryList package, you could then use the following in the form view:

    {{ Form::text('phonefield') }}
    {{ Form::select('phonefield_country', Countries::getList(App::getLocale(), 'php', 'cldr')) }}
  

  Finally, if using a Presenter package like robclancy/presenter, you could add this to the Presenter to automatically format phone fields.

    public function presentPhonefield()
    {
      $phone = $this->getObject()->phonefield;
      $country = $this->getObject()->phonefield_country; // Or supply a country code yourself...
      
      $phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
      $phoneProto = $phoneUtil->parse($phone, $country);
      return $phoneUtil->format($phoneProto, \libphonenumber\PhoneNumberFormat::INTERNATIONAL);
    }
  

NOTE: remember to update all occurences of phonefield (and phonefield_country) with their respective names.