ICloudIdManager
in
Interface for resolving federated cloud ids
Tags
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
Return values
ICloudIdgetCloudId()
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
Return values
ICloudIdisValidCloudId()
Check if the input is a correctly formatted cloud id
public
isValidCloudId(string $cloudId) : bool
Parameters
- $cloudId : string
Tags
Return values
boolregisterCloudIdResolver()
public
registerCloudIdResolver(mixed $resolver) : void
Parameters
- $resolver : mixed
-
The cloud id resolver to register
Tags
removeProtocolFromUrl()
remove scheme/protocol from an url
public
removeProtocolFromUrl(string $url[, bool $httpsOnly = false ]) : string
Parameters
- $url : string
- $httpsOnly : bool = false
Tags
Return values
stringresolveCloudId()
public
resolveCloudId(string $cloudId) : ICloudId
Parameters
- $cloudId : string
Tags
Return values
ICloudIdunregisterCloudIdResolver()
public
unregisterCloudIdResolver(mixed $resolver) : void
Parameters
- $resolver : mixed
-
The cloud id resolver to unregister