0
0
mirror of https://github.com/nextcloud/server.git synced 2024-11-14 04:16:59 +00:00
nextcloud_server/lib/public/IPhoneNumberUtil.php
Andy Scherzinger dae7c159f7
chore: Add SPDX header
Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
2024-05-24 13:11:22 +02:00

39 lines
1.2 KiB
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
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 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;
/**
* 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.
*
* @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;
}