danbettles/telex

v0.0.0-alpha.4 2022-04-23 07:50 UTC

Requires

• php: >=7.4.29

Requires (Dev)

• phpunit/phpunit: ^9.5.20
• squizlabs/php_codesniffer: ^3.5.8

MIT

• Dan Bettles

README

Telex finds telephone numbers in text.

Having written something horribly inflexible to deal with European telephone numbers, I wanted to see if I could write something relatively simple - and a little more elegant - that would detect any telephone number with a degree of precision. Telex is certainly more elegant, and probably more useful, than my previous solution, but it's still far from being perfect - it's still too naive, I think. It's an interesting challenge and we'd appreciate your input - thank you.

Telex is used by SeeTheWorld.

Usage

For now:

use DanBettles\Telex\Telex;
use DanBettles\Telex\NumberFinder;
use DanBettles\Telex\CountryTelephoneNumberMatcherFactory;

$telex = new Telex(new NumberFinder(), new CountryTelephoneNumberMatcherFactory());
$matches = $telex->findAll('A UK landline number: [phone].  A UK mobile number: [phone].');

TODO

• Encode patterns for area codes, and well-structured local numbers, whenever practicable, to increase the precision of the matcher.
• Write more tests, especially for Telex.
• Handle multiple adjacent numbers.
• Add logging to the find methods in Telex to make it easier to identify the causes of mismatches.