Edit
in package
Class to edit user data.
Important: To change the email address, phone number or the password, use the Email or Password Class!
Table of Contents
Properties
Methods
- __construct() : mixed
- Initialize the user data change. Important: To change the email address or the password, use the Email or Password Class!
- edit() : void
- Change the user data and sends the data to Zitadel
- setDisplayName() : void
- Change display name
- setGender() : void
- Change the gender of the user
- setLanguage() : void
- Change the preferred user language
- setName() : void
- Set the full name of the new user. You must always enter your full name, even if you don't change it.
- setNickName() : void
- Change the nickname
- setUserId() : void
- Set the user id of the user
- setUserName() : void
- Change the username of the user
Properties
$request
private
array<string|int, mixed>
$request
$settings
private
array<string|int, mixed>
$settings
$userid
private
int
$userid
Methods
__construct()
Initialize the user data change. Important: To change the email address or the password, use the Email or Password Class!
public
__construct(mixed $settings) : mixed
Parameters
- $settings : mixed
-
array The settings array
edit()
Change the user data and sends the data to Zitadel
public
edit() : void
Tags
setDisplayName()
Change display name
public
setDisplayName(mixed $displayName) : void
Parameters
- $displayName : mixed
-
string Display name
setGender()
Change the gender of the user
public
setGender(mixed $gender) : void
Parameters
- $gender : mixed
-
string Default: GENDER_UNSPECIFIED, Possible values: GENDER_MALE, GENDER_FEMALE, GENDER_DIVERSE
setLanguage()
Change the preferred user language
public
setLanguage(mixed $lang) : void
Parameters
- $lang : mixed
-
string Shortcode of the language, e.g. "en" or "de"
setName()
Set the full name of the new user. You must always enter your full name, even if you don't change it.
public
setName(mixed $givenName, mixed $familyName) : void
Parameters
- $givenName : mixed
-
string Given Name
- $familyName : mixed
-
string Family Name
setNickName()
Change the nickname
public
setNickName(mixed $nickName) : void
Parameters
- $nickName : mixed
-
string Nickname
setUserId()
Set the user id of the user
public
setUserId(mixed $userid) : void
Parameters
- $userid : mixed
-
int The user id of the user
setUserName()
Change the username of the user
public
setUserName(mixed $username) : void
Parameters
- $username : mixed
-
string The username of the new user