You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-27
Original file line number
Diff line number
Diff line change
@@ -11,13 +11,12 @@ A PHP library for parsing, formatting, storing and validating international phon
11
11
-[Installation](#installation)
12
12
-[Documentation](#documentation)
13
13
-[Online Demo](#online-demo)
14
-
-[Highlights of functionality](#highlights-of-functionality)
15
-
-[Versioning](#versioning)
16
-
-[Quick Examples](#quick-examples)
17
-
-[Geocoder](#geocoder)
18
-
-[ShortNumberInfo](#shortnumberinfo)
19
-
-[Mapping Phone Numbers to Carrier](#mapping-phone-numbers-to-carrier)
20
-
-[Mapping Phone Numbers to TimeZones](#mapping-phone-numbers-to-timezones)
14
+
-[Versioning](#versioning)
15
+
-[Quick Examples](#quick-examples)
16
+
-[Geocoder](#geocoder)
17
+
-[ShortNumberInfo](#shortnumberinfo)
18
+
-[Mapping Phone Numbers to Carrier](#mapping-phone-numbers-to-carrier)
19
+
-[Mapping Phone Numbers to TimeZones](#mapping-phone-numbers-to-timezones)
21
20
-[FAQ](#faq)
22
21
-[Problems with Invalid Numbers?](#problems-with-invalid-numbers)
23
22
-[Generating data](#generating-data)
@@ -61,16 +60,6 @@ This library will be updated to use [supported versions of PHP](https://www.php.
61
60
## Online Demo
62
61
An [online demo](http://giggsey.com/libphonenumber/) is available, and the source can be found at [giggsey/libphonenumber-example](https://github.com/giggsey/libphonenumber-example).
63
62
64
-
# Highlights of functionality
65
-
* Parsing/formatting/validating phone numbers for all countries/regions of the world.
66
-
*`getNumberType` - gets the type of the number based on the number itself; able to distinguish Fixed-line, Mobile, Toll-free, Premium Rate, Shared Cost, VoIP and Personal Numbers (whenever feasible).
67
-
*`isNumberMatch` - gets a confidence level on whether two numbers could be the same.
68
-
*`getExampleNumber`/`getExampleNumberByType` - provides valid example numbers for all countries/regions, with the option of specifying which type of example phone number is needed.
69
-
*`isValidNumber` - full validation of a phone number for a region using length and prefix information.
70
-
*`PhoneNumberOfflineGeocoder` - provides geographical information related to a phone number.
71
-
*`PhoneNumberToTimeZonesMapper` - provides timezone information related to a phone number.
72
-
*`PhoneNumberToCarrierMapper` - provides carrier information related to a phone number.
73
-
74
63
## Versioning
75
64
76
65
This library will try to follow the same version numbers as Google. There could be additional releases where needed to fix critical issues that can not wait until the next release from Google.
@@ -240,21 +229,15 @@ If Google's [Online Demo](https://libphonenumber.appspot.com/) gives a different
240
229
241
230
## Generating data
242
231
243
-
Generating the data is not normally needed, as this repository will generally always have the up to data metadata.
232
+
Generating the data is not normally needed, as this repository will generally always have the up to date metadata.
244
233
245
-
If you do need to generate the data, the commands are provided by [Phing](https://www.phing.info). Ensure you have all the dev composer dependencies installed, then run
234
+
To compile the data, run the composer script 'build'
246
235
247
236
```bash
248
-
vendor/bin/phing compile
237
+
composer run build
249
238
```
250
239
251
-
This compile process clones the [libphonenumber](https://github.com/google/libphonenumber) project at the version specified in [METADATA-VERSION.php](METADATA-VERSION.php).
252
-
253
-
### Running tests
254
-
255
-
This project uses [PHPUnit Bridge](https://symfony.com/doc/current/components/phpunit_bridge.html) to maintain compatibility for the supported PHP versions.
256
-
257
-
To run the tests locally, run the `./phpunit` script.
240
+
This build process clones the [libphonenumber](https://github.com/google/libphonenumber) project at the version specified in [METADATA-VERSION.php](METADATA-VERSION.php).
0 commit comments