UpdateUser
in package
implements
JsonSerializable
uses
JsonSerializableTrait
Read onlyYes
Table of Contents
Interfaces
- JsonSerializable
Properties
- $email : string|null
- The email address of the user.
- $emailVerified : bool|null
- Whether the user's email has been verified.
- $externalId : string|null
- The external ID of the user.
- $firstName : string|null
- The first name of the user.
- $lastName : string|null
- The last name of the user.
- $locale : string|null
- The user's preferred locale.
- $metadata : array<string, string>|null
- Object containing metadata key/value pairs associated with the user.
- $password : string|null
- The password to set for the user. Mutually exclusive with `password_hash` and `password_hash_type`.
- $passwordHash : string|null
- The hashed password to set for the user. Required with `password_hash_type`. Mutually exclusive with `password`.
- $passwordHashType : CreateUserPasswordHashType|null
- The algorithm originally used to hash the password, used when providing a `password_hash`. Required with `password_hash`. Mutually exclusive with `password`.
Methods
- __construct() : mixed
- fromArray() : self
- jsonSerialize() : array<string|int, mixed>
- toArray() : array<string|int, mixed>
Properties
The email address of the user.
public
string|null
$email
= null
$emailVerified
Whether the user's email has been verified.
public
bool|null
$emailVerified
= null
$externalId
The external ID of the user.
public
string|null
$externalId
= null
$firstName
The first name of the user.
public
string|null
$firstName
= null
$lastName
The last name of the user.
public
string|null
$lastName
= null
$locale
The user's preferred locale.
public
string|null
$locale
= null
$metadata
Object containing metadata key/value pairs associated with the user.
public
array<string, string>|null
$metadata
= null
$password
The password to set for the user. Mutually exclusive with `password_hash` and `password_hash_type`.
public
string|null
$password
= null
$passwordHash
The hashed password to set for the user. Required with `password_hash_type`. Mutually exclusive with `password`.
public
string|null
$passwordHash
= null
$passwordHashType
The algorithm originally used to hash the password, used when providing a `password_hash`. Required with `password_hash`. Mutually exclusive with `password`.
public
CreateUserPasswordHashType|null
$passwordHashType
= null
Methods
__construct()
public
__construct([string|null $email = null ][, string|null $firstName = null ][, string|null $lastName = null ][, bool|null $emailVerified = null ][, array<string|int, mixed>|null $metadata = null ][, string|null $externalId = null ][, string|null $locale = null ][, string|null $password = null ][, string|null $passwordHash = null ][, CreateUserPasswordHashType|null $passwordHashType = null ]) : mixed
Parameters
- $email : string|null = null
- $firstName : string|null = null
- $lastName : string|null = null
- $emailVerified : bool|null = null
- $metadata : array<string|int, mixed>|null = null
- $externalId : string|null = null
- $locale : string|null = null
- $password : string|null = null
- $passwordHash : string|null = null
- $passwordHashType : CreateUserPasswordHashType|null = null
fromArray()
public
static fromArray(array<string|int, mixed> $data) : self
Parameters
- $data : array<string|int, mixed>
Return values
selfjsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Return values
array<string|int, mixed>toArray()
public
toArray() : array<string|int, mixed>