InboxPlacementAnalysisItemDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
InboxPlacementAnalysisItemDto Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_FAIL = 'FAIL'
- STATUS_INFO = 'INFO'
- STATUS_PASS = 'PASS'
- STATUS_WARN = 'WARN'
- $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
- getActionLabel() : string|null
- Gets action_label
- getActionUrl() : string|null
- Gets action_url
- getDetailTable() : InboxPlacementAnalysisItemDtoDetailTable|null
- Gets detail_table
- getKey() : string
- Gets key
- getMessage() : string
- Gets message
- getMeta() : array<string, string>
- Gets meta
- getModelName() : string
- The original name of the model.
- getStatus() : string
- Gets status
- getStatusAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTitle() : string
- Gets title
- 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
- setActionLabel() : self
- Sets action_label
- setActionUrl() : self
- Sets action_url
- setDetailTable() : self
- Sets detail_table
- setKey() : self
- Sets key
- setMessage() : self
- Sets message
- setMeta() : self
- Sets meta
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTitle() : self
- Sets title
- 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
STATUS_FAIL
public
mixed
STATUS_FAIL
= 'FAIL'
STATUS_INFO
public
mixed
STATUS_INFO
= 'INFO'
STATUS_PASS
public
mixed
STATUS_PASS
= 'PASS'
STATUS_WARN
public
mixed
STATUS_WARN
= 'WARN'
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
= ['key' => 'key', 'status' => 'status', 'title' => 'title', 'message' => 'message', 'meta' => 'meta', 'action_label' => 'actionLabel', 'action_url' => 'actionUrl', 'detail_table' => 'detailTable']
$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
= ['key' => 'getKey', 'status' => 'getStatus', 'title' => 'getTitle', 'message' => 'getMessage', 'meta' => 'getMeta', 'action_label' => 'getActionLabel', 'action_url' => 'getActionUrl', 'detail_table' => 'getDetailTable']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['key' => null, 'status' => null, 'title' => null, 'message' => null, 'meta' => null, 'action_label' => null, 'action_url' => null, 'detail_table' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'InboxPlacementAnalysisItemDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['key' => false, 'status' => false, 'title' => false, 'message' => false, 'meta' => false, 'action_label' => true, 'action_url' => true, 'detail_table' => 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
= ['key' => 'string', 'status' => 'string', 'title' => 'string', 'message' => 'string', 'meta' => 'array<string,string>', 'action_label' => 'string', 'action_url' => 'string', 'detail_table' => '\\MailSlurp\\Models\\InboxPlacementAnalysisItemDtoDetailTable']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['key' => 'setKey', 'status' => 'setStatus', 'title' => 'setTitle', 'message' => 'setMessage', 'meta' => 'setMeta', 'action_label' => 'setActionLabel', 'action_url' => 'setActionUrl', 'detail_table' => 'setDetailTable']
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> —getActionLabel()
Gets action_label
public
getActionLabel() : string|null
Return values
string|null —getActionUrl()
Gets action_url
public
getActionUrl() : string|null
Return values
string|null —getDetailTable()
Gets detail_table
public
getDetailTable() : InboxPlacementAnalysisItemDtoDetailTable|null
Return values
InboxPlacementAnalysisItemDtoDetailTable|null —getKey()
Gets key
public
getKey() : string
Return values
string —getMessage()
Gets message
public
getMessage() : string
Return values
string —getMeta()
Gets meta
public
getMeta() : array<string, string>
Return values
array<string, string> —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getStatus()
Gets status
public
getStatus() : string
Return values
string —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : 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> —getTitle()
Gets title
public
getTitle() : string
Return values
string —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> —setActionLabel()
Sets action_label
public
setActionLabel(string|null $action_label) : self
Parameters
- $action_label : string|null
-
action_label
Return values
self —setActionUrl()
Sets action_url
public
setActionUrl(string|null $action_url) : self
Parameters
- $action_url : string|null
-
action_url
Return values
self —setDetailTable()
Sets detail_table
public
setDetailTable(InboxPlacementAnalysisItemDtoDetailTable|null $detail_table) : self
Parameters
- $detail_table : InboxPlacementAnalysisItemDtoDetailTable|null
-
detail_table
Return values
self —setKey()
Sets key
public
setKey(string $key) : self
Parameters
- $key : string
-
key
Return values
self —setMessage()
Sets message
public
setMessage(string $message) : self
Parameters
- $message : string
-
message
Return values
self —setMeta()
Sets meta
public
setMeta(array<string, string> $meta) : self
Parameters
- $meta : array<string, string>
-
meta
Return values
self —setStatus()
Sets status
public
setStatus(string $status) : self
Parameters
- $status : string
-
Status for a setup or content analysis item
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> —setTitle()
Sets title
public
setTitle(string $title) : self
Parameters
- $title : string
-
title
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>