User
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
User Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- $attributeMap : array<string|int, string>
- Array of attributes where the key is the local name, and the value is the original name
- $container : array<string|int, mixed>
- Associative array for storing property values
- $getters : array<string|int, string>
- Array of attributes to getter functions (for serialization of requests)
- $openAPIFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $openAPIModelName : string
- The original name of the model.
- $openAPINullables : array<string|int, bool>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, bool>
- If a nullable field gets set to null, insert it here
- $openAPITypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- __construct() : mixed
- Constructor
- __toString() : string
- Gets the string presentation of the object
- attributeMap() : array<string|int, mixed>
- Array of attributes where the key is the local name, and the value is the original name
- getEmail() : string|null
- Gets email
- getFirstName() : string|null
- Gets first_name
- getId() : int|null
- Gets id
- getLastName() : string|null
- Gets last_name
- getModelName() : string
- The original name of the model.
- getPassword() : string|null
- Gets password
- getPhone() : string|null
- Gets phone
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUsername() : string|null
- Gets username
- getUserStatus() : int|null
- Gets user_status
- isNullable() : bool
- Checks if a property is nullable
- isNullableSetToNull() : bool
- Checks if a nullable property is set to null.
- jsonSerialize() : mixed
- Serializes the object to a value that can be serialized natively by json_encode().
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed|null
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- openAPIFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- openAPITypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- setEmail() : self
- Sets email
- setFirstName() : self
- Sets first_name
- setId() : self
- Sets id
- setLastName() : self
- Sets last_name
- setPassword() : self
- Sets password
- setPhone() : self
- Sets phone
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUsername() : self
- Sets username
- setUserStatus() : self
- Sets user_status
- toHeaderValue() : string
- Gets a header-safe presentation of the object
- valid() : bool
- Validate all the properties in the model return true if all passed
- openAPINullables() : array<string|int, mixed>
- Array of nullable properties
- getOpenAPINullablesSetToNull() : array<string|int, bool>
- Array of nullable field names deliberately set to null
- setIfExists() : void
- Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Tags
Properties
$attributeMap
Array of attributes where the key is the local name, and the value is the original name
protected
static array<string|int, string>
$attributeMap
= ['id' => 'id', 'username' => 'username', 'first_name' => 'firstName', 'last_name' => 'lastName', 'email' => 'email', 'password' => 'password', 'phone' => 'phone', 'user_status' => 'userStatus']
Tags
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
Tags
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['id' => 'getId', 'username' => 'getUsername', 'first_name' => 'getFirstName', 'last_name' => 'getLastName', 'email' => 'getEmail', 'password' => 'getPassword', 'phone' => 'getPhone', 'user_status' => 'getUserStatus']
Tags
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'int64', 'username' => null, 'first_name' => null, 'last_name' => null, 'email' => null, 'password' => null, 'phone' => null, 'user_status' => 'int32']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'User'
Tags
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, bool>
$openAPINullables
= ['id' => false, 'username' => false, 'first_name' => false, 'last_name' => false, 'email' => false, 'password' => false, 'phone' => false, 'user_status' => false]
Tags
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, bool>
$openAPINullablesSetToNull
= []
Tags
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['id' => 'int', 'username' => 'string', 'first_name' => 'string', 'last_name' => 'string', 'email' => 'string', 'password' => 'string', 'phone' => 'string', 'user_status' => 'int']
Tags
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'username' => 'setUsername', 'first_name' => 'setFirstName', 'last_name' => 'setLastName', 'email' => 'setEmail', 'password' => 'setPassword', 'phone' => 'setPhone', 'user_status' => 'setUserStatus']
Tags
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
- $data : array<string|int, mixed> = null
-
Associated array of property values initializing the model
Tags
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
Tags
Return values
string —attributeMap()
Array of attributes where the key is the local name, and the value is the original name
public
static attributeMap() : array<string|int, mixed>
Return values
array<string|int, mixed> —getEmail()
Gets email
public
getEmail() : string|null
Tags
Return values
string|null —getFirstName()
Gets first_name
public
getFirstName() : string|null
Tags
Return values
string|null —getId()
Gets id
public
getId() : int|null
Tags
Return values
int|null —getLastName()
Gets last_name
public
getLastName() : string|null
Tags
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Tags
Return values
string —getPassword()
Gets password
public
getPassword() : string|null
Tags
Return values
string|null —getPhone()
Gets phone
public
getPhone() : string|null
Tags
Return values
string|null —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUsername()
Gets username
public
getUsername() : string|null
Tags
Return values
string|null —getUserStatus()
Gets user_status
public
getUserStatus() : int|null
Tags
Return values
int|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Tags
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Tags
Return values
bool —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
Return values
mixed —Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.
listInvalidProperties()
Show all the invalid properties with reasons.
public
listInvalidProperties() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —invalid properties with reasons
offsetExists()
Returns true if offset exists. False otherwise.
public
offsetExists(int $offset) : bool
Parameters
- $offset : int
-
Offset
Tags
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
Tags
Return values
mixed|null —offsetSet()
Sets value based on offset.
public
offsetSet(int|null $offset, mixed $value) : void
Parameters
- $offset : int|null
-
Offset
- $value : mixed
-
Value to be set
Tags
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
Tags
Return values
void —openAPIFormats()
Array of property to format mappings. Used for (de)serialization
public
static openAPIFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —openAPITypes()
Array of property to type mappings. Used for (de)serialization
public
static openAPITypes() : array<string|int, mixed>
Return values
array<string|int, mixed> —setEmail()
Sets email
public
setEmail(string|null $email) : self
Parameters
- $email : string|null
-
email
Tags
Return values
self —setFirstName()
Sets first_name
public
setFirstName(string|null $first_name) : self
Parameters
- $first_name : string|null
-
first_name
Tags
Return values
self —setId()
Sets id
public
setId(int|null $id) : self
Parameters
- $id : int|null
-
id
Tags
Return values
self —setLastName()
Sets last_name
public
setLastName(string|null $last_name) : self
Parameters
- $last_name : string|null
-
last_name
Tags
Return values
self —setPassword()
Sets password
public
setPassword(string|null $password) : self
Parameters
- $password : string|null
-
password
Tags
Return values
self —setPhone()
Sets phone
public
setPhone(string|null $phone) : self
Parameters
- $phone : string|null
-
phone
Tags
Return values
self —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setUsername()
Sets username
public
setUsername(string|null $username) : self
Parameters
- $username : string|null
-
username
Tags
Return values
self —setUserStatus()
Sets user_status
public
setUserStatus(int|null $user_status) : self
Parameters
- $user_status : int|null
-
User Status
Tags
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Tags
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
Tags
Return values
bool —True if all properties are valid
openAPINullables()
Array of nullable properties
protected
static openAPINullables() : array<string|int, mixed>
Return values
array<string|int, mixed> —getOpenAPINullablesSetToNull()
Array of nullable field names deliberately set to null
private
getOpenAPINullablesSetToNull() : array<string|int, bool>
Tags
Return values
array<string|int, bool> —setIfExists()
Sets $this->container[$variableName] to the given data or to the given default Value; if $variableName is nullable and its value is set to null in the $fields array, then mark it as "set to null" in the $this->openAPINullablesSetToNull array
private
setIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
- $variableName : string
- $fields : array<string|int, mixed>
- $defaultValue : mixed