nextcloud/lib/public/Federation/ICloudIdManager.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

56 lines
1.1 KiB
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2017 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
namespace OCP\Federation;
/**
* Interface for resolving federated cloud ids
*
* @since 12.0.0
*/
interface ICloudIdManager {
/**
* @param string $cloudId
* @return ICloudId
* @throws \InvalidArgumentException
*
* @since 12.0.0
*/
public function resolveCloudId(string $cloudId): ICloudId;
/**
* Get the cloud id for a remote user
*
* @param string $user
* @param string|null $remote (optional since 23.0.0 for local users)
* @return ICloudId
*
* @since 12.0.0
*/
public function getCloudId(string $user, ?string $remote): ICloudId;
/**
* Check if the input is a correctly formatted cloud id
*
* @param string $cloudId
* @return bool
*
* @since 12.0.0
*/
public function isValidCloudId(string $cloudId): bool;
/**
* remove scheme/protocol from an url
*
* @param string $url
*
* @return string
* @since 28.0.0
*/
public function removeProtocolFromUrl(string $url): string;
}