lekoala/silverstripe-phonenumber

Format, store and validate phone number in SilverStripe

1.1.0 2023-08-10 14:59 UTC

Requires

• php: ^7.4 || ^8
• silverstripe/framework: ^4.4 || ^5
• silverstripe/recipe-plugin: ^1 || ^2

Requires (Dev)

• giggsey/libphonenumber-for-php: ^8
• phpunit/phpunit: ^9.5
• squizlabs/php_codesniffer: ^3.5

MIT

• LeKoala

• i18n
• module
• cms
• silverstripe
• phonenumber

README

Intro

Provide some helper services to deal with phone numbers in SilverStripe

This module integrates libphonenumber as the utility to parse and validate phonenumbers.

Most of the time, it's a good idea to set the country of the phone number. Otherwise, current locale will be used.

Sample code:

	$phone = new PhoneField('phone', 'Phone number');
	$phone->setCountryField('CountryCode');

	$validator = ZenValidator::create();
	$validator->setConstraint('phone', Constraint_remote::create('/__phonenumber/validate',null,array('data' => array('country' => 'BE'))));

This module also provide an extension to apply to dataobject, for example to members

SilverStripe\Security\Member:
  extensions:
    - LeKoala\PhoneNumber\PhoneNumberExtension

Phone DBField

You can set your DataObject db field to Phone or DBPhone::class

This will automatically scaffold a CountryPhoneField which is a combo field with a country dropdown (with list of prefixes) and a space for the field itself

Form fields

Two available fields:

• PhoneField : a plain phone field that supports national and international numbers
• CountryPhoneField : a combo field with a country dropdown + national phone number

Ajax validation and formatting

Expose ´phonenumber/validate´ and ´phonenumber/format´ endpoints for validation and formatting of phone numbers

Todo

None

Compatibility

Tested with 5.x but should work on any ^4|^5 projects

Maintainer

LeKoala - [e-mail]