ExpirationDefaults
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
ExpirationDefaults 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
- getCanPermanentInbox() : bool
- Gets can_permanent_inbox
- getDefaultExpirationMillis() : int|null
- Gets default_expiration_millis
- getDefaultExpiresAt() : DateTime|null
- Gets default_expires_at
- getMaxExpirationMillis() : int|null
- Gets max_expiration_millis
- getModelName() : string
- The original name of the model.
- getNextInboxAllowsPermanent() : bool
- Gets next_inbox_allows_permanent
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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
- setCanPermanentInbox() : self
- Sets can_permanent_inbox
- setDefaultExpirationMillis() : self
- Sets default_expiration_millis
- setDefaultExpiresAt() : self
- Sets default_expires_at
- setMaxExpirationMillis() : self
- Sets max_expiration_millis
- setNextInboxAllowsPermanent() : self
- Sets next_inbox_allows_permanent
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
= ['default_expiration_millis' => 'defaultExpirationMillis', 'max_expiration_millis' => 'maxExpirationMillis', 'default_expires_at' => 'defaultExpiresAt', 'can_permanent_inbox' => 'canPermanentInbox', 'next_inbox_allows_permanent' => 'nextInboxAllowsPermanent']
$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
= ['default_expiration_millis' => 'getDefaultExpirationMillis', 'max_expiration_millis' => 'getMaxExpirationMillis', 'default_expires_at' => 'getDefaultExpiresAt', 'can_permanent_inbox' => 'getCanPermanentInbox', 'next_inbox_allows_permanent' => 'getNextInboxAllowsPermanent']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['default_expiration_millis' => 'int64', 'max_expiration_millis' => 'int64', 'default_expires_at' => 'date-time', 'can_permanent_inbox' => null, 'next_inbox_allows_permanent' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'ExpirationDefaults'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['default_expiration_millis' => true, 'max_expiration_millis' => true, 'default_expires_at' => true, 'can_permanent_inbox' => false, 'next_inbox_allows_permanent' => false]
$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
= ['default_expiration_millis' => 'int', 'max_expiration_millis' => 'int', 'default_expires_at' => '\\DateTime', 'can_permanent_inbox' => 'bool', 'next_inbox_allows_permanent' => 'bool']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['default_expiration_millis' => 'setDefaultExpirationMillis', 'max_expiration_millis' => 'setMaxExpirationMillis', 'default_expires_at' => 'setDefaultExpiresAt', 'can_permanent_inbox' => 'setCanPermanentInbox', 'next_inbox_allows_permanent' => 'setNextInboxAllowsPermanent']
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> —getCanPermanentInbox()
Gets can_permanent_inbox
public
getCanPermanentInbox() : bool
Return values
bool —getDefaultExpirationMillis()
Gets default_expiration_millis
public
getDefaultExpirationMillis() : int|null
Return values
int|null —getDefaultExpiresAt()
Gets default_expires_at
public
getDefaultExpiresAt() : DateTime|null
Return values
DateTime|null —getMaxExpirationMillis()
Gets max_expiration_millis
public
getMaxExpirationMillis() : int|null
Return values
int|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getNextInboxAllowsPermanent()
Gets next_inbox_allows_permanent
public
getNextInboxAllowsPermanent() : bool
Return values
bool —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —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> —setCanPermanentInbox()
Sets can_permanent_inbox
public
setCanPermanentInbox(bool $can_permanent_inbox) : self
Parameters
- $can_permanent_inbox : bool
-
can_permanent_inbox
Return values
self —setDefaultExpirationMillis()
Sets default_expiration_millis
public
setDefaultExpirationMillis(int|null $default_expiration_millis) : self
Parameters
- $default_expiration_millis : int|null
-
default_expiration_millis
Return values
self —setDefaultExpiresAt()
Sets default_expires_at
public
setDefaultExpiresAt(DateTime|null $default_expires_at) : self
Parameters
- $default_expires_at : DateTime|null
-
default_expires_at
Return values
self —setMaxExpirationMillis()
Sets max_expiration_millis
public
setMaxExpirationMillis(int|null $max_expiration_millis) : self
Parameters
- $max_expiration_millis : int|null
-
max_expiration_millis
Return values
self —setNextInboxAllowsPermanent()
Sets next_inbox_allows_permanent
public
setNextInboxAllowsPermanent(bool $next_inbox_allows_permanent) : self
Parameters
- $next_inbox_allows_permanent : bool
-
next_inbox_allows_permanent
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> —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>