Nextcloud PHP API (master)

ICloudIdManager

Interface for resolving federated cloud ids

Tags
since
12.0.0
Attributes
#[Consumable]
$since: '12.0.0'

Table of Contents

Methods

createCloudId()  : ICloudId
getCloudId()  : ICloudId
Get the cloud id for a remote user
isValidCloudId()  : bool
Check if the input is a correctly formatted cloud id
registerCloudIdResolver()  : void
removeProtocolFromUrl()  : string
remove scheme/protocol from an url
resolveCloudId()  : ICloudId
unregisterCloudIdResolver()  : void

Methods

createCloudId()

public createCloudId(string $id, string $user, string $remote[, string|null $displayName = null ]) : ICloudId
Parameters
$id : string

The remote cloud id

$user : string

The user id on the remote server

$remote : string

The base address of the remote server

$displayName : string|null = null

The displayname of the remote user

Tags
since
32.0.0
Return values
ICloudId

getCloudId()

Get the cloud id for a remote user

public getCloudId(string $user, string|null $remote) : ICloudId
Parameters
$user : string
$remote : string|null

(optional since 23.0.0 for local users)

Tags
since
12.0.0
Return values
ICloudId

isValidCloudId()

Check if the input is a correctly formatted cloud id

public isValidCloudId(string $cloudId) : bool
Parameters
$cloudId : string
Tags
since
12.0.0
Return values
bool

registerCloudIdResolver()

public registerCloudIdResolver(mixed $resolver) : void
Parameters
$resolver : mixed

The cloud id resolver to register

Tags
since
32.0.0

removeProtocolFromUrl()

remove scheme/protocol from an url

public removeProtocolFromUrl(string $url[, bool $httpsOnly = false ]) : string
Parameters
$url : string
$httpsOnly : bool = false
Tags
since
28.0.0
since
30.0.0
  • Optional parameter $httpsOnly was added
Return values
string

resolveCloudId()

public resolveCloudId(string $cloudId) : ICloudId
Parameters
$cloudId : string
Tags
throws
InvalidArgumentException
since
12.0.0
Return values
ICloudId

unregisterCloudIdResolver()

public unregisterCloudIdResolver(mixed $resolver) : void
Parameters
$resolver : mixed

The cloud id resolver to unregister

Tags
since
32.0.0

        
On this page

Search results