ellisio/laravel-phone

A phone validator for Laravel using the free Twilio phone lookup service.

Laravel Phone

, _(*1)

- Introduction - Installation - Configuration - Usage - Phone validation - Country validation - Formatting phone numbers - Creating phone number objects - Handling invalid numbers - Support, _(*2)

Introduction

A phone validator for Laravel 6+ using the free Twilio Lookup API., _(*3)

This package gives developers the ability to validate phone numbers and format phone numbers. All data will be pulled from the Twilio Lookup API., _(*4)

Validation can be configured to check if the number is valid, or if it is valid within a given list of ISO-3166-1 Alpha 2 country codes., _(*5)

Installation

Install via composer:, _(*6)

composer require ellisio/laravel-phone

Add your Twilio credentials to your .env file. If you don't have a Twilio account you can register one here for free., _(*7)

TWILIO_ACCOUNT_SID=xxxxxxxx
TWILIO_AUTH_TOKEN=xxxxxxxx

Configuration

If you want to customize the configuration for this package, you can publish the config file to /config/phone.php by running the following command:, _(*8)

php artisan vendor:publish --provider=EllisIO/Phone/PhoneServiceProvider --tag=laravel-phone-config

If you want to customize the output of the validation messages, you can publish the translations file to /lang/vendor/laravel-phone by running the following command:, _(*9)

php artisan vendor:publish --provider=EllisIO/Phone/PhoneServiceProvider --tag=laravel-phone-translations

Usage

Phone validation

If you need to verify that the given number is valid and that is all, use the phone rule., _(*10)

return [
    'phone' => 'required|phone',
];

Country validation

If you need to validate that the given number is valid in a list of countries, use the phone_country:US,CA rule. You can list as many ISO-3166-1 Alpha 2 as you wish delimited by a comma., _(*11)

return [
    'phone' => 'required|phone_country:US,CA',
];

Formatting phone numbers

If you want to format the phone number using INTERNATIONAL_FORMAT use the following code:, _(*12)

Phone::formatNumber('5551234567');

Creating phone number objects

This library includes the ability to generate a Phone object. This object contains the following details about a number:, _(*13)

• countryCode: ISO-3166 alpha 2 country code.
• number: E.164 number.
• formattedNumber: National formatted number.

$phone = Phone::getPhone('5551234567');
$phone->getNumber(); // Returns "+15551234567"
$phone->getNationalNumber(); // Returns "5551234567"
$phone->getFormattedNumber(); // Returns "(555) 123-4567"
$phone->getCountry(); // Returns "US"
$phone->getCountryCallingCode(); // Returns "1"

Handling invalid numbers

Sometimes you may have bad data, it happens. To handle this, simply check to see if null was returned., _(*14)

if (! $phone = Phone::getPhone('123')) {
    echo "Invalid number provided.";
}

Support

Need help? Create an issue., _(*15)