nextcloud
/
server
mirror of https://github.com/nextcloud/server
0
0
Fork 0
Code Issues Releases Wiki Activity

fix(phonenumber): Improve docs by adding input details 

Signed-off-by: Joas Schilling <coding@schilljs.com>
This commit is contained in:
Joas Schilling 2023-09-25 17:32:47 +02:00
parent 0956b493b6
commit 3b4c306860
No known key found for this signature in database
GPG Key ID: 74434EFE0D2E2205
2 changed files with 9 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
lib/private/PhoneNumberUtil.php
View File

@ -35,12 +35,7 @@ use OCP\IPhoneNumberUtil;
*/
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
* {@inheritDoc}
*/
public function getCountryCodeForRegion(string $regionCode): ?int {
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();
@ -49,13 +44,7 @@ class PhoneNumberUtil implements IPhoneNumberUtil {
}
/**
* 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
* {@inheritDoc}
*/
public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string {
$phoneUtil = \libphonenumber\PhoneNumberUtil::getInstance();

9
lib/public/IPhoneNumberUtil.php
View File

@ -34,8 +34,10 @@ 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.
* Returns null when the region is invalid.
*
* @param string $regionCode Two-letter region code of ISO 3166-1
* @return int|null Null when invalid/unsupported, the phone country code otherwise
* @since 28.0.0
*/
public function getCountryCodeForRegion(string $regionCode): ?int;
@ -44,8 +46,11 @@ interface IPhoneNumberUtil {
* 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
* E.g. +41446681800 where +41 is the region code.
*
* @param string $input Input phone number can contain formatting spaces, slashes and dashes
* @param string|null $defaultRegion Two-letter region code of ISO 3166-1
* @return string|null Null when the input is invalid for the given region or requires a region.
* @since 28.0.0
*/
public function convertToStandardFormat(string $input, ?string $defaultRegion = null): ?string;