msisdn-ph-php

KO | EN

gitlite — search

#php #java #c-plus-plus #javascript #python #ruby #metrics #monitoring #docker #android #rails #c-sharp

★ 28 Open GitHub ↗

Easily validate and manipulate Philippine mobile numbers.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

MsisdnPH - PHP
=====================

[![Latest Version on Packagist][ico-version]][link-packagist]
[![Software License][ico-license]](https://raw.githubusercontent.com/CoreProc/msisdn-ph-php/master/LICENSE.md)
[![Build Status][ico-travis]][link-travis]
[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
[![Quality Score][ico-code-quality]][link-code-quality]
[![Total Downloads][ico-downloads]][link-downloads]

Easily validate and manipulate Philippine mobile numbers.

## Table of contents

* [Install](#install)
* [Usage](#usage)
    * [Validate the mobile number](#validate-the-mobile-number)
    * [Instantiate an MSISDN object](#instantiate-an-msisdn-object)
    * [Return a standardized format of your mobile number](#return-a-standardized-format-of-your-mobile-number)
    * [Get the telco operator of a mobile number](#get-the-telco-operator-of-a-mobile-number)
    * [Get the prefix of a mobile number](#get-the-prefix-of-a-mobile-number)
    * [Validating mobile numbers using Laravel 5.1](#validating-mobile-numbers-using-laravel-51)
* [Credits](#credits)
* [License](#license)

## Install

Run the following command at the root of your project (assuming you have Composer and a composer.json file already)

```bash
composer require coreproc/msisdn-ph "^1.0"
```

## Usage

### Validate the mobile number

```php
$mobileNumber = '09171231234';

if (Msisdn::validate($mobileNumber)) {
    echo 'Valid mobile number';
} else {
    echo 'Invalid mobile number';
}
```

The `validate` method cleans the given mobile number and validates it so even if the mobile number is malformed or has other characters within it, it will still return true as long as the number is really valid:

```php
$validMobileNumber = '+639171231234';
$validMobileNumber = '+63-917-123-1234';
$validMobileNumber = '0917-123-1234';
$validMobileNumber = '0917.123.1234';
$validMobileNumber = '63 917 123 12 34 ';
```

### Instantiate an MSISDN object

You can instantiate an MSISDN object and get a standardized format of your mobile number and even get the telco attached to the mobile number using this object.

```php
$mobileNumber = '09171231234';

$msisdn = new Msisdn($mobileNumber);
```

The MSISDN object will throw an `InvalidMsisdnException` if you give it an invalid mobile number, so it's best to either catch the exception OR validate it before creating an MSISDN object.

```php
$invalidMobileNumber = '0917-123-123';

try {
   $msisdn = new Msisdn($invalidMobileNumber);
} catch (InvalidMsisdnException $e) {
   echo 'The number is invalid';
   return;
}
```

```php
$invalidMobileNumber = '0917-123-123';

if (Msisdn::validate($invalidMobileNumber)) {
    $msisdn = new Msisdn($invalidMobileNumber);
} else {
   echo 'Invalid mobile number';
   return;
}
```

### Return a standardized format of your mobile number

When you've instantiated an `Msisdn` object, you can return the mobile number in any format you want.

```php
$mobileNumber = '09171231234';

$msisdn = new Msisdn($mobileNumber);

echo $msisdn->get(); // will return 09171231234

echo $msisdn->get(true); // will return +639171231234

echo $msisdn->get(false, '-'); // will return 0917-123-1234

echo $msisdn->get(true, '-'); // will return +63-917-123-1234

echo $msisdn->get(true, '.'); // will return +63.917.123.1234
```

### Get the telco operator of a mobile number

You can also get the telco operator of the given mobile number - this is based on the included prefixes we have gathered from the telcos.

We cannot guarantee that this list is updated so use with a grain of salt.

If you want to add to the prefixes, you can find the list inside the `src/prefixes` directory.

```php
$mobileNumber = '09171231234';

$msisdn = new Msisdn($mobileNumber);

echo $msisdn->getOperator(); // will return Globe
```

### Get the prefix of a mobile number

You might just want to get the prefix of a mobile number.

```php
$mobileNumber = '09171231234';

$msisdn = new Msisdn($mobileNumber);

echo $msisdn->getPrefix(); // will return 917
```

### Validating mobile numbers using Laravel 5.1

You can easily integrate this into Laravel's validator class by adding the line below to the default `AppServiceProvider` located in the `app/Providers` directory.

Inside the `boot()` method, add the following line:

```php
Validator::extend('msisdn', function ($attribute, $value, $parameters) {
    return Coreproc\MsisdnPh\Msisdn::validate($value);
});
```

## Credits

- [Chris Bautista][link-author]
- [All Contributors][link-contributors]

## About CoreProc

CoreProc is a software development company that provides software development services to startups, digital/ad agencies, and enterprises.

Learn more about us on our [website](https://coreproc.com).

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

[ico-version]: https://img.shields.io/packagist/v/coreproc/msisdn-ph.svg?style=flat-square
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
[ico-travis]: https://img.shields.io/travis/CoreProc/msisdn-ph-php/master.svg?style=flat-square
[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/CoreProc/msisdn-ph-php.svg?style=flat-square
[ico-code-quality]: https://img.shields.io/scrutinizer/g/CoreProc/msisdn-ph-php.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/coreproc/msisdn-ph.svg?style=flat-square

[link-packagist]: https://packagist.org/packages/coreproc/msisdn-ph
[link-travis]: https://travis-ci.org/CoreProc/msisdn-ph-php
[link-scrutinizer]: https://scrutinizer-ci.com/g/CoreProc/msisdn-ph-php/code-structure
[link-code-quality]: https://scrutinizer-ci.com/g/CoreProc/msisdn-ph-php
[link-downloads]: https://packagist.org/packages/coreproc/msisdn-ph
[link-author]: https://github.com/chrisbjr
[link-contributors]: ../../contributors

msisdn-ph-php

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README