Documentation

InboxForwarderEventProjection
in package
implements ModelInterface, ArrayAccess, JsonSerializable

InboxForwarderEventProjection Class Doc Comment

Tags
category

Class

description

Inbox forwarder event

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
STATUS_FAILURE  = 'FAILURE'
STATUS_SUCCESS  = 'SUCCESS'
$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
getCreatedAt()  : DateTime
Gets created_at
getEmailId()  : string|null
Gets email_id
getForwarderId()  : string|null
Gets forwarder_id
getId()  : string|null
Gets id
getInboxId()  : string|null
Gets inbox_id
getMessage()  : string|null
Gets message
getModelName()  : string
The original name of the model.
getStatus()  : string|null
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)
getUserId()  : string|null
Gets user_id
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
setCreatedAt()  : self
Sets created_at
setEmailId()  : self
Sets email_id
setForwarderId()  : self
Sets forwarder_id
setId()  : self
Sets id
setInboxId()  : self
Sets inbox_id
setMessage()  : self
Sets message
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUserId()  : self
Sets user_id
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

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 = ['email_id' => 'emailId', 'inbox_id' => 'inboxId', 'user_id' => 'userId', 'forwarder_id' => 'forwarderId', 'created_at' => 'createdAt', 'message' => 'message', 'id' => 'id', 'status' => 'status']

$getters

Array of attributes to getter functions (for serialization of requests)

protected static array<string|int, string> $getters = ['email_id' => 'getEmailId', 'inbox_id' => 'getInboxId', 'user_id' => 'getUserId', 'forwarder_id' => 'getForwarderId', 'created_at' => 'getCreatedAt', 'message' => 'getMessage', 'id' => 'getId', 'status' => 'getStatus']

$openAPIFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $openAPIFormats = ['email_id' => 'uuid', 'inbox_id' => 'uuid', 'user_id' => 'uuid', 'forwarder_id' => 'uuid', 'created_at' => 'date-time', 'message' => null, 'id' => 'uuid', 'status' => null]
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'InboxForwarderEventProjection'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['email_id' => true, 'inbox_id' => true, 'user_id' => true, 'forwarder_id' => true, 'created_at' => false, 'message' => true, 'id' => true, 'status' => 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 = ['email_id' => 'string', 'inbox_id' => 'string', 'user_id' => 'string', 'forwarder_id' => 'string', 'created_at' => '\\DateTime', 'message' => 'string', 'id' => 'string', 'status' => 'string']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['email_id' => 'setEmailId', 'inbox_id' => 'setInboxId', 'user_id' => 'setUserId', 'forwarder_id' => 'setForwarderId', 'created_at' => 'setCreatedAt', 'message' => 'setMessage', 'id' => 'setId', 'status' => 'setStatus']

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

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>

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>

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

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>

setCreatedAt()

Sets created_at

public setCreatedAt(DateTime $created_at) : self
Parameters
$created_at : DateTime

created_at

Return values
self

setEmailId()

Sets email_id

public setEmailId(string|null $email_id) : self
Parameters
$email_id : string|null

email_id

Return values
self

setForwarderId()

Sets forwarder_id

public setForwarderId(string|null $forwarder_id) : self
Parameters
$forwarder_id : string|null

forwarder_id

Return values
self

setInboxId()

Sets inbox_id

public setInboxId(string|null $inbox_id) : self
Parameters
$inbox_id : string|null

inbox_id

Return values
self

setMessage()

Sets message

public setMessage(string|null $message) : self
Parameters
$message : string|null

message

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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>

setUserId()

Sets user_id

public setUserId(string|null $user_id) : self
Parameters
$user_id : string|null

user_id

Return values
self

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>
Return values
void

Search results