-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(phonenumber): Add OCP wrapper for PhoneNumber utils library
Signed-off-by: Joas Schilling <coding@schilljs.com>
- Loading branch information
1 parent
bbfa9d1
commit 5092278
Showing
5 changed files
with
131 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
/** | ||
* | ||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> | ||
* | ||
* @author Joas Schilling <coding@schilljs.com> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
* | ||
*/ | ||
|
||
namespace OC; | ||
|
||
use libphonenumber\NumberParseException; | ||
use libphonenumber\PhoneNumberFormat; | ||
use OCP\IPhoneNumberUtil; | ||
|
||
/** | ||
* @since 28.0.0 | ||
*/ | ||
class PhoneNumberUtil implements IPhoneNumberUtil { | ||
/** | ||
* Returns the country code for a specific region | ||
* | ||
* For example, this would be `41` for Switzerland and `49` for Germany. | ||
* Returns null when the region is invalid. | ||
* | ||
* @since 28.0.0 | ||
*/ | ||
public function getCountryCodeForRegion(string $regionCode): ?int { | ||
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance(); | ||
$countryCode = $phoneUtil->getCountryCodeForRegion($regionCode); | ||
return $countryCode === 0 ? null : $countryCode; | ||
} | ||
|
||
/** | ||
* Converts a given input into an E164 formatted phone number | ||
* | ||
* E164 is the international format without any formatting characters or spaces. | ||
* E.g. +41446681800 where +41 is the region code. | ||
* Returns null when the input is invalid for the given region. | ||
* | ||
* @since 28.0.0 | ||
*/ | ||
public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string { | ||
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance(); | ||
try { | ||
$phoneNumber = $phoneUtil->parse($input, $defaultRegion); | ||
if ($phoneUtil->isValidNumber($phoneNumber)) { | ||
return $phoneUtil->format($phoneNumber, PhoneNumberFormat::E164); | ||
} | ||
} catch (NumberParseException) { | ||
} | ||
|
||
return null; | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
/** | ||
* | ||
* @copyright Copyright (c) 2023 Joas Schilling <coding@schilljs.com> | ||
* | ||
* @author Joas Schilling <coding@schilljs.com> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program is distributed in the hope that it will be useful, | ||
* but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
* GNU Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
* | ||
*/ | ||
|
||
namespace OCP; | ||
|
||
/** | ||
* @since 28.0.0 | ||
*/ | ||
interface IPhoneNumberUtil { | ||
/** | ||
* Returns the country code for a specific region | ||
* | ||
* For example, this would be `41` for Switzerland and `49` for Germany. | ||
* Returns null when there is no country code for the region. | ||
* | ||
* @since 28.0.0 | ||
*/ | ||
public function getCountryCodeForRegion(string $regionCode): ?int; | ||
|
||
/** | ||
* Converts a given input into an E164 formatted phone number | ||
* | ||
* E164 is the international format without any formatting characters or spaces. | ||
* E.g. +41446681800 where +41 is the country code | ||
* | ||
* @since 28.0.0 | ||
*/ | ||
public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string; | ||
} |