Order
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
Order Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Table of Contents
- DISCRIMINATOR = null
- STATUS_APPROVED = 'approved'
- STATUS_DELIVERED = 'delivered'
- STATUS_PLACED = 'placed'
- $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
- getComplete() : bool|null
- Gets complete
- getId() : int|null
- Gets id
- getModelName() : string
- The original name of the model.
- getPetId() : int|null
- Gets pet_id
- getQuantity() : int|null
- Gets quantity
- getShipDate() : DateTime|null
- Gets ship_date
- 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)
- 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
- setComplete() : self
- Sets complete
- setId() : self
- Sets id
- setPetId() : self
- Sets pet_id
- setQuantity() : self
- Sets quantity
- setShipDate() : self
- Sets ship_date
- setStatus() : self
- Sets status
- 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
Constants
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
Tags
STATUS_APPROVED
public
mixed
STATUS_APPROVED
= 'approved'
Tags
STATUS_DELIVERED
public
mixed
STATUS_DELIVERED
= 'delivered'
Tags
STATUS_PLACED
public
mixed
STATUS_PLACED
= 'placed'
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', 'pet_id' => 'petId', 'quantity' => 'quantity', 'ship_date' => 'shipDate', 'status' => 'status', 'complete' => 'complete']
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', 'pet_id' => 'getPetId', 'quantity' => 'getQuantity', 'ship_date' => 'getShipDate', 'status' => 'getStatus', 'complete' => 'getComplete']
Tags
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['id' => 'int64', 'pet_id' => 'int64', 'quantity' => 'int32', 'ship_date' => 'date-time', 'status' => null, 'complete' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'Order'
Tags
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, bool>
$openAPINullables
= ['id' => false, 'pet_id' => false, 'quantity' => false, 'ship_date' => false, 'status' => false, 'complete' => 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', 'pet_id' => 'int', 'quantity' => 'int', 'ship_date' => '\\DateTime', 'status' => 'string', 'complete' => 'bool']
Tags
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['id' => 'setId', 'pet_id' => 'setPetId', 'quantity' => 'setQuantity', 'ship_date' => 'setShipDate', 'status' => 'setStatus', 'complete' => 'setComplete']
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> —getComplete()
Gets complete
public
getComplete() : bool|null
Tags
Return values
bool|null —getId()
Gets id
public
getId() : int|null
Tags
Return values
int|null —getModelName()
The original name of the model.
public
getModelName() : string
Tags
Return values
string —getPetId()
Gets pet_id
public
getPetId() : int|null
Tags
Return values
int|null —getQuantity()
Gets quantity
public
getQuantity() : int|null
Tags
Return values
int|null —getShipDate()
Gets ship_date
public
getShipDate() : DateTime|null
Tags
Return values
DateTime|null —getStatus()
Gets status
public
getStatus() : string|null
Tags
Return values
string|null —getStatusAllowableValues()
Gets allowable values of the enum
public
getStatusAllowableValues() : array<string|int, string>
Tags
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
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> —setComplete()
Sets complete
public
setComplete(bool|null $complete) : self
Parameters
- $complete : bool|null
-
complete
Tags
Return values
self —setId()
Sets id
public
setId(int|null $id) : self
Parameters
- $id : int|null
-
id
Tags
Return values
self —setPetId()
Sets pet_id
public
setPetId(int|null $pet_id) : self
Parameters
- $pet_id : int|null
-
pet_id
Tags
Return values
self —setQuantity()
Sets quantity
public
setQuantity(int|null $quantity) : self
Parameters
- $quantity : int|null
-
quantity
Tags
Return values
self —setShipDate()
Sets ship_date
public
setShipDate(DateTime|null $ship_date) : self
Parameters
- $ship_date : DateTime|null
-
ship_date
Tags
Return values
self —setStatus()
Sets status
public
setStatus(string|null $status) : self
Parameters
- $status : string|null
-
Order Status
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> —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