Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cs-eliseev/helpers-phone

The helpers allows you manipulating, extract, detecting PHONE.
https://github.com/cs-eliseev/helpers-phone

collection collections cse framework helper helpers library phone phones php tel telephone tool tools utilities utility utils

Last synced: about 1 month ago
JSON representation

The helpers allows you manipulating, extract, detecting PHONE.

Awesome Lists containing this project

README 

        
English | [Русский](https://github.com/cs-eliseev/helpers-phone/blob/master/README.ru_RU.md)



PHONE CSE HELPERS

=======



[![Travis (.org)](https://img.shields.io/travis/cs-eliseev/helpers-phone.svg?style=flat-square)](https://travis-ci.org/cs-eliseev/helpers-phone)

[![Codecov](https://img.shields.io/codecov/c/github/cs-eliseev/helpers-phone.svg?style=flat-square)](https://codecov.io/gh/cs-eliseev/helpers-email)

[![Scrutinizer code quality](https://img.shields.io/scrutinizer/g/cs-eliseev/helpers-phone.svg?style=flat-square)](https://scrutinizer-ci.com/g/cs-eliseev/helpers-phone/?branch=master)



[![Packagist](https://img.shields.io/packagist/v/cse/helpers-phone.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-phone)

[![Minimum PHP Version](https://img.shields.io/badge/php-%3E%3D%207.1-8892BF.svg?style=flat-square)](https://packagist.org/packages/cse/helpers-phone)

[![Packagist](https://img.shields.io/packagist/l/cse/helpers-phone.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-phone/blob/master/LICENSE.md)

[![GitHub repo size](https://img.shields.io/github/repo-size/cs-eliseev/helpers-phone.svg?style=flat-square)](https://github.com/cs-eliseev/helpers-phone/archive/master.zip)



The helpers allows you manipulating, extract, detecting PHONE.



Project repository: https://github.com/cs-eliseev/helpers-phone



**DEMO**

```php

switch (true) {

    case Phone::is($phone):

        break;

    case Phone::exist($phone):

        $phone = Phone::extract($phone);

        break;

    default:

        new Exception('Phone is not exist');

}



$phone = Phone::format($phone);

```



***



## Introduction



[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) is a collection of several libraries with simple functions written in PHP for people.



Despite using PHP as the main programming language for the Internet, its functions are not enough. PHONE CSE HELPERS for manipulating, extract and detecting phone.



[CSE HELPERS](https://github.com/cs-eliseev/helpers/blob/master/README.md) was created for the rapid development of web applications.



**CSE Helpers project:**

* [Array CSE helpers](https://github.com/cs-eliseev/helpers-arrays)

* [Cookie CSE helpers](https://github.com/cs-eliseev/helpers-cookie)

* [Date CSE helpers](https://github.com/cs-eliseev/helpers-date)

* [Email CSE helpers](https://github.com/cs-eliseev/helpers-email)

* [IP CSE helpers](https://github.com/cs-eliseev/helpers-ip)

* [Json CSE helpers](https://github.com/cs-eliseev/helpers-json)

* [Math Converter CSE helpers](https://github.com/cs-eliseev/helpers-math-converter)

* [Phone CSE helpers](https://github.com/cs-eliseev/helpers-phone)

* [Request CSE helpers](https://github.com/cs-eliseev/helpers-request)

* [Session CSE helpers](https://github.com/cs-eliseev/helpers-session)

* [Word CSE helpers](https://github.com/cs-eliseev/helpers-word)



Below you will find some information on how to init library and perform common commands.



## Install



You can find the most recent version of this project [here](https://github.com/cs-eliseev/helpers-phone).



### Composer



Execute the following command to get the latest version of the package:

```bash

composer require cse/helpers-phone

```



Or file composer.json should include the following contents:

```json

{

    "require": {

        "cse/helpers-phone": "*"

    }

}

```



### Git



Clone this repository locally:

```bash

git clone https://github.com/cs-eliseev/helpers-phone.git

```



### Download



[Download the latest release here](https://github.com/cs-eliseev/helpers-phone/archive/master.zip).



## Usage



The class consists of static methods that are conveniently used in any project. See example [examples-phone.php](https://github.com/cs-eliseev/helpers-phone/blob/master/examples/examples-phone.php).



Example data:

```php

$numbers = [

    6677,

    4456677,

    '+1 233 44 566 77',

    '(233) 445-6677',

    '((233) 445-6677',

    2334456677,

    '233 445-6677',

    '233-445-6677',

    '(233)4456677',

    '+123344566-77',

    '1-2334456677',

    '233-445-66-77   -Hello!',

    '+1 - 2334456677'

];

```



**CLEAR phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::clear($phone);

}

/**

* [

*     '6677',

*     '4456677',

*     '12334456677',

*     '2334456677',

*     '2334456677',

*     '2334456677',

*     '2334456677',

*     '2334456677',

*     '2334456677',

*     '12334456677',

*     '12334456677',

*     '2334456677',

*     '12334456677'

* ]

*/

```



**FORMAT phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::format($phone);

}

/**

 * [

 *    '66-77',

 *    '445-66-77',

 *    '+1 (233) 445-66-77',

 *    '(233) 445-66-77',

 *    '(233) 445-66-77',

 *    '(233) 445-66-77',

 *    '(233) 445-66-77',

 *    '(233) 445-66-77',

 *    '(233) 445-66-77',

 *    '+1 (233) 445-66-77',

 *    '+1 (233) 445-66-77',

 *    '(233) 445-66-77',

 *    '+1 (233) 445-66-77',

 * ]

 */

```



Not use mask:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::format($phone, Phone::FORMAT_DEFAULT, false);

}

/**

 * [

 *    '6677',

 *    '4456677',

 *    '+1 (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+1 (233) 445-66-77',

 *    '+1 (233) 445-66-77',

 *    '+ (233) 445-66-77',

 *    '+1 (233) 445-66-77',

 * ]

 */

```



Change format phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::format($phone, '$3-$4-$5');

}

/**

 * [

 *    '66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 *    '445-66-77',

 * ]

 */

```



Change pattern format phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::format($phone, '$1-$2-$3-$4-$5', true, '(.{2})(.{2})(.{2})(.{4})(.*)');

}

/**

 * [

 *    '66-77',

 *    '4-45-66-77',

 *    '1-2334-45-66-77',

 *    '2334-45-66-77',

 *    '2334-45-66-77',

 *    '2334-45-66-77',

 *    '2334-45-66-77',

 *    '2334-45-66-77',

 *    '2334-45-66-77',

 *    '1-2334-45-66-77',

 *    '1-2334-45-66-77',

 *    '2334-45-66-77',

 *    '1-2334-45-66-77',

 * ]

 */

```



Change revert format phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::format($phone, '$1 $2 $3 $4-$5-$6', true,'(.{2})(.{2})(.{2})(.{2})(.{2})(.*)', [

        '$6' => '1$',

        '$5' => '2$',

        '$4' => '3$',

        '$3' => '4$',

        '$2' => '5$',

        '$1' => '6$'

    ]);

}

/**

 * [

 *    '66-77',

 *    '4 45-66-77',

 *    '1 23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '1 23 34 45-66-77',

 *    '1 23 34 45-66-77',

 *    '23 34 45-66-77',

 *    '1 23 34 45-66-77',

 * ]

 */

```



**HIDE phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::hide($phone);

}

/**

 * [

 *    '***-**-77',

 *    '***-**-77',

 *    '+1 (233) ***-**-77',

 *    '(233) ***-**-77',

 *    '(233) ***-**-77',

 *    '(233) ***-**-77',

 *    '(233) ***-**-77',

 *    '(233) ***-**-77',

 *    '(233) ***-**-77',

 *    '+1 (233) ***-**-77',

 *    '+1 (233) ***-**-77',

 *    '(233) ***-**-77',

 *    '+1 (233) ***-**-77',

 * ]

 */

```



Change format hide phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::hide($phone, '8-*** ***-**-$6');

}

/**

 * [

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 *    '8-*** ***-**-77',

 * ]

 */

```



**IS phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::is($phone);

}

/**

 * [

 *     false,

 *     true,

 *     false,

 *     true,

 *     false,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     false,

 *     false

 * ]

 */

```



Change check min size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::is($phone, 11);

}

/**

 * [

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     true,

 *     true,

 *     false,

 *     false

 * ]

 */

```



Change check max size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::is($phone, Phone::SIZE_MIN, 10);

}

/**

 * [

 *     false,

 *     true,

 *     false,

 *     false,

 *     false,

 *     true,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false

 * ]

 */

```



**EXIST phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::exist($phone);

}

/**

 * [

 *     false,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true

 * ]

 */

```



Change check min size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::exist($phone, 11);

}

/**

 * [

 *     false,

 *     false,

 *     true,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     false,

 *     true,

 *     true,

 *     false,

 *     true

 * ]

 */

```



Change check max size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::exist($phone, Phone::SIZE_MIN, 10);

}

/**

 * [

 *     false,

 *     true,

 *     false,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     true,

 *     false,

 *     false,

 *     true,

 *     false

 * ]

 */

```



**EXTRACT phone number**



Example:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::extract($phone);

}

/**

 * [

 *     null,

 *     '4456677',

 *     '12334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '12334456677',

 *     '12334456677',

 *     '2334456677',

 *     '12334456677'

 * ]

 */

```



Change check min size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::extract($phone, 11);

}

/**

 * [

 *     null,

 *     null,

 *     '12334456677',

 *     null,

 *     null,

 *     null,

 *     null,

 *     null,

 *     null,

 *     '12334456677',

 *     '12334456677',

 *     null,

 *     '12334456677'

 * ]

 */

```



Change check max size phone number:

```php

$phones = [];

foreach($numbers as $phone)

{

    $phones[] = Phone::extract($phone, Phone::SIZE_MIN, 10);

}

/**

 * [

 *     null,

 *     '4456677',

 *     null,

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     '2334456677',

 *     null,

 *     null,

 *     '2334456677',

 *     null

 * ]

 */

```



## Testing & Code Coverage



PHPUnit is used for unit testing. Unit tests ensure that class and methods does exactly what it is meant to do.



General PHPUnit documentation can be found at https://phpunit.de/documentation.html.



To run the PHPUnit unit tests, execute:

```bash

phpunit PATH/TO/PROJECT/tests/

```



If you want code coverage reports, use the following:

```bash

phpunit --coverage-html ./report PATH/TO/PROJECT/tests/

```



Used PHPUnit default config:

```bash

phpunit --configuration PATH/TO/PROJECT/phpunit.xml

```



## Donating



You can support this project [here](https://www.paypal.me/cseliseev/10usd). 

You can also help out by contributing to the project, or reporting bugs. 

Even voicing your suggestions for features is great. Anything to help is much appreciated.



## License



The PHONE CSE HELPERS is open-source PHP library licensed under the MIT license. Please see [License File](https://github.com/cs-eliseev/helpers-phone/blob/master/LICENSE.md) for more information.



***



> GitHub [@cs-eliseev](https://github.com/cs-eliseev)