| Methods |
public
|
__construct(array<string, mixed> $data = ['openid' => []])
Creates a new ArrayWrapper over an underlying array
Creates a new ArrayWrapper over an underlying array
Parameters
| $data |
the underlying array
|
Overrides
|
#
|
public
|
isAdministrator(): bool
Determines whether the user is an administrator
Determines whether the user is an administrator
Returns
true if the user is an administrator
|
#
|
public
|
hasLocalOpenIDIdentity(): bool
Determines whether the user has a local OpenID identity
Determines whether the user has a local OpenID identity
Returns
true if the user has a local OpenID identity
|
#
|
public
|
getLocalOpenIDIdentity(): string
Returns the user's local OpenID identity
Returns the user's local OpenID identity
Returns
the user's local OpenID identity
|
#
|
public
|
getPairwiseIdentity(string $sector_identifier): string
Generates a pairwise identity for this user, based on a specified
sector identifier.
Generates a pairwise identity for this user, based on a specified
sector identifier.
A pairwise identity is an opaque string that is unique to one or more clients
(identified by a common $sector_identifier parameter) which identifies the
user to those clients. Issuing a pairwise identity means that the user's
SimpleID user name is not exposed to the clients.
Parameters
| $sector_identifier |
the client's sector identifier.
|
Returns
|
#
|
public
|
getDisplayName(): string
Returns a display name for the user. The display name is worked
out based on the data available.
Returns a display name for the user. The display name is worked
out based on the data available.
Returns
|
#
|
public
|
addActivity(string $id, array<string, mixed> $data): void
Add an entry to the user's recent activity log.
Add an entry to the user's recent activity log.
The recent activity log contains the most recent authentication
activity performed by or on behalf of the user. This includes instances
where the user manually logged into SimpleID, or where a client
requested authentication or authorisation from the user
Parameters
| $id |
the ID of the agent creating the activity - this could
be the user agent ID assigned by SimpleID (in case of user logins) or
the client ID
|
| $data |
additional data
|
|
#
|
public
|
getActivities(): array<string, array<string, mixed>>
Returns the user's recent activity log.
Returns the user's recent activity log.
Returns
|
#
|
public
|
loadData(array<mixed>|ArrayWrapper $data): void
|
#
|
public
|
offsetSet($offset, $value): void
Implementation of ArrayAccess
Implementation of ArrayAccess
Overrides
|
#
|
public
|
offsetExists($offset): bool
Implementation of ArrayAccess
Implementation of ArrayAccess
Overrides
|
#
|
public
|
offsetGet($offset): mixed
Implementation of ArrayAccess
Implementation of ArrayAccess
Ideally we should provide a mixed return type here, but for PHP7 compatibility,
we add a ReturnTypeWillChange attribute instead.
Overrides
|
#
|
public
|
serialize()
|
#
|
public
|
__serialize(): array<string, mixed>
PHP __serialize magic method.
PHP __serialize magic method.
|
#
|
public
|
unserialize($data)
|
#
|
public
|
__unserialize(array<string, mixed> $array): void
PHP __unserialize magic method.
PHP __unserialize magic method.
|
#
|
public
|
getStoreType()
Returns the item type for this object
Returns the item type for this object
Returns
Implements
|
#
|
public
|
getStoreID()
Returns the unique item ID for this object.
Returns the unique item ID for this object.
Returns
Implements
|
#
|
public
|
setStoreID($id)
Sets the unique item ID for this object
Sets the unique item ID for this object
The ID should be:
- unique for all items of this type; and
- able to be used as a file name.
Parameters
| $id |
the ID for this object
|
Implements
|
#
|
public
|
toString(): string
Returns a string representation of the user, with sensitive
information removed.
Returns a string representation of the user, with sensitive
information removed.
|
#
|