ScimUserResource
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ScimUserResource 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, mixed>
- Array of nullable properties. Used for (de)serialization
- $openAPINullablesSetToNull : array<string|int, mixed>
- 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
- getActive() : bool|null
- Gets active
- getDisplayName() : string|null
- Gets display_name
- getEmails() : array<string|int, ScimEmail>|null
- Gets emails
- getExternalId() : string|null
- Gets external_id
- getId() : string|null
- Gets id
- getMeta() : ScimUserResourceMeta|null
- Gets meta
- getModelName() : string
- The original name of the model.
- getName() : ScimUserResourceName|null
- Gets name
- getSchemas() : array<string|int, string>
- Gets schemas
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUserName() : string|null
- Gets user_name
- 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
- setActive() : self
- Sets active
- setDisplayName() : self
- Sets display_name
- setEmails() : self
- Sets emails
- setExternalId() : self
- Sets external_id
- setId() : self
- Sets id
- setMeta() : self
- Sets meta
- setName() : self
- Sets name
- setSchemas() : self
- Sets schemas
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUserName() : self
- Sets user_name
- 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
- setOpenAPINullablesSetToNull() : void
- Setter - Array of nullable field names deliberately set to null
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['schemas' => 'schemas', 'id' => 'id', 'external_id' => 'externalId', 'user_name' => 'userName', 'name' => 'name', 'display_name' => 'displayName', 'emails' => 'emails', 'active' => 'active', 'meta' => 'meta']
$container
Associative array for storing property values
protected
array<string|int, mixed>
$container
= []
$getters
Array of attributes to getter functions (for serialization of requests)
protected
static array<string|int, string>
$getters
= ['schemas' => 'getSchemas', 'id' => 'getId', 'external_id' => 'getExternalId', 'user_name' => 'getUserName', 'name' => 'getName', 'display_name' => 'getDisplayName', 'emails' => 'getEmails', 'active' => 'getActive', 'meta' => 'getMeta']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['schemas' => null, 'id' => null, 'external_id' => null, 'user_name' => null, 'name' => null, 'display_name' => null, 'emails' => null, 'active' => null, 'meta' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ScimUserResource'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['schemas' => false, 'id' => true, 'external_id' => true, 'user_name' => true, 'name' => true, 'display_name' => true, 'emails' => true, 'active' => true, 'meta' => true]
$openAPINullablesSetToNull
If a nullable field gets set to null, insert it here
protected
array<string|int, mixed>
$openAPINullablesSetToNull
= []
$openAPITypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPITypes
= ['schemas' => 'string[]', 'id' => 'string', 'external_id' => 'string', 'user_name' => 'string', 'name' => '\\MailSlurp\\Models\\ScimUserResourceName', 'display_name' => 'string', 'emails' => '\\MailSlurp\\Models\\ScimEmail[]', 'active' => 'bool', 'meta' => '\\MailSlurp\\Models\\ScimUserResourceMeta']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['schemas' => 'setSchemas', 'id' => 'setId', 'external_id' => 'setExternalId', 'user_name' => 'setUserName', 'name' => 'setName', 'display_name' => 'setDisplayName', 'emails' => 'setEmails', 'active' => 'setActive', 'meta' => 'setMeta']
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
Return values
mixed —__toString()
Gets the string presentation of the object
public
__toString() : string
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> —getActive()
Gets active
public
getActive() : bool|null
Return values
bool|null —getDisplayName()
Gets display_name
public
getDisplayName() : string|null
Return values
string|null —getEmails()
Gets emails
public
getEmails() : array<string|int, ScimEmail>|null
Return values
array<string|int, ScimEmail>|null —getExternalId()
Gets external_id
public
getExternalId() : string|null
Return values
string|null —getId()
Gets id
public
getId() : string|null
Return values
string|null —getMeta()
Gets meta
public
getMeta() : ScimUserResourceMeta|null
Return values
ScimUserResourceMeta|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : ScimUserResourceName|null
Return values
ScimUserResourceName|null —getSchemas()
Gets schemas
public
getSchemas() : array<string|int, string>
Return values
array<string|int, string> —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 user_name
public
getUserName() : string|null
Return values
string|null —isNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
bool —isNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
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>
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
Return values
bool —offsetGet()
Gets offset.
public
offsetGet(int $offset) : mixed|null
Parameters
- $offset : int
-
Offset
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
Return values
void —offsetUnset()
Unsets offset.
public
offsetUnset(int $offset) : void
Parameters
- $offset : int
-
Offset
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> —setActive()
Sets active
public
setActive(bool|null $active) : self
Parameters
- $active : bool|null
-
active
Return values
self —setDisplayName()
Sets display_name
public
setDisplayName(string|null $display_name) : self
Parameters
- $display_name : string|null
-
display_name
Return values
self —setEmails()
Sets emails
public
setEmails(array<string|int, ScimEmail>|null $emails) : self
Parameters
- $emails : array<string|int, ScimEmail>|null
-
emails
Return values
self —setExternalId()
Sets external_id
public
setExternalId(string|null $external_id) : self
Parameters
- $external_id : string|null
-
external_id
Return values
self —setId()
Sets id
public
setId(string|null $id) : self
Parameters
- $id : string|null
-
id
Return values
self —setMeta()
Sets meta
public
setMeta(ScimUserResourceMeta|null $meta) : self
Parameters
- $meta : ScimUserResourceMeta|null
-
meta
Return values
self —setName()
Sets name
public
setName(ScimUserResourceName|null $name) : self
Parameters
- $name : ScimUserResourceName|null
-
name
Return values
self —setSchemas()
Sets schemas
public
setSchemas(array<string|int, string> $schemas) : self
Parameters
- $schemas : array<string|int, string>
-
schemas
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 user_name
public
setUserName(string|null $user_name) : self
Parameters
- $user_name : string|null
-
user_name
Return values
self —toHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
string —valid()
Validate all the properties in the model return true if all passed
public
valid() : bool
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>
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
Return values
void —setOpenAPINullablesSetToNull()
Setter - Array of nullable field names deliberately set to null
private
setOpenAPINullablesSetToNull(array<string|int, bool> $openAPINullablesSetToNull) : void
Parameters
- $openAPINullablesSetToNull : array<string|int, bool>