UserIdentificationHintType Uses EnumTrait
Types of hints for end-user identification.
Tags
Table of Contents
- $ID_TOKEN_HINT : UserIdentificationHintType
- An ID token previously issued to the client.
- $LOGIN_HINT : UserIdentificationHintType
- An arbitrary string whose interpretation varies depending on contexts.
- $LOGIN_HINT_TOKEN : UserIdentificationHintType
- A token whose format is deployment or profile specific.
- __toString() : string
- Get the name of this instance.
- name() : string
- Get the name of this instance.
- valueOf() : static
- Get an instance of this class that the given argument represents.
- values() : array<string|int, mixed>
- Get the list of public class variables listed in this class.
Properties
$ID_TOKEN_HINT
An ID token previously issued to the client.
public
static UserIdentificationHintType
$ID_TOKEN_HINT
Tags
$LOGIN_HINT
An arbitrary string whose interpretation varies depending on contexts.
public
static UserIdentificationHintType
$LOGIN_HINT
Tags
$LOGIN_HINT_TOKEN
A token whose format is deployment or profile specific.
public
static UserIdentificationHintType
$LOGIN_HINT_TOKEN
Tags
Methods
__toString()
Get the name of this instance.
public
__toString() : string
Return values
string —The name of this instance.
name()
Get the name of this instance.
public
name() : string
Return values
string —The name of this instance.
valueOf()
Get an instance of this class that the given argument represents.
public
static valueOf(mixed $value) : static
If the given argument is an instance of this class, the instance itself is returned.
Otherwise, if the given argument is null
, null
is returned.
Otherwise, if the type of the given argument is not string
,
an InvalidArgumentException
is returned.
Otherwise, a class variable whose name is equal to the given
argument is looked up. If found, the instance is returned.
If not found, an InvalidArgumentException
is thrown.
Parameters
- $value : mixed
-
A string that represents an instance of this class, or an instance of this class, or
null
.
Return values
static —An instance of this class.
values()
Get the list of public class variables listed in this class.
public
static values() : array<string|int, mixed>
Return values
array<string|int, mixed> —Instances of this class which are defined as public class variables.