DevicePreviewSharedScreenshotDto
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
DevicePreviewSharedScreenshotDto 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
- getCreatedAt() : DateTime
- Gets created_at
- getDescription() : string|null
- Gets description
- getDisplayOrder() : int
- Gets display_order
- getHeight() : int|null
- Gets height
- getImageUrl() : string|null
- Gets image_url
- getIsPrimary() : bool
- Gets is_primary
- getModelName() : string
- The original name of the model.
- getRunId() : string
- Gets run_id
- getScreenshotId() : string
- Gets screenshot_id
- getTargetId() : string|null
- Gets target_id
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTitle() : string|null
- Gets title
- getUpdatedAt() : DateTime
- Gets updated_at
- getVariant() : string|null
- Gets variant
- getWidth() : int|null
- Gets width
- 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
- setDescription() : self
- Sets description
- setDisplayOrder() : self
- Sets display_order
- setHeight() : self
- Sets height
- setImageUrl() : self
- Sets image_url
- setIsPrimary() : self
- Sets is_primary
- setRunId() : self
- Sets run_id
- setScreenshotId() : self
- Sets screenshot_id
- setTargetId() : self
- Sets target_id
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTitle() : self
- Sets title
- setUpdatedAt() : self
- Sets updated_at
- setVariant() : self
- Sets variant
- setWidth() : self
- Sets width
- 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
= ['screenshot_id' => 'screenshotId', 'run_id' => 'runId', 'target_id' => 'targetId', 'variant' => 'variant', 'title' => 'title', 'description' => 'description', 'is_primary' => 'isPrimary', 'display_order' => 'displayOrder', 'image_url' => 'imageUrl', 'width' => 'width', 'height' => 'height', 'created_at' => 'createdAt', 'updated_at' => 'updatedAt']
$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
= ['screenshot_id' => 'getScreenshotId', 'run_id' => 'getRunId', 'target_id' => 'getTargetId', 'variant' => 'getVariant', 'title' => 'getTitle', 'description' => 'getDescription', 'is_primary' => 'getIsPrimary', 'display_order' => 'getDisplayOrder', 'image_url' => 'getImageUrl', 'width' => 'getWidth', 'height' => 'getHeight', 'created_at' => 'getCreatedAt', 'updated_at' => 'getUpdatedAt']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['screenshot_id' => 'uuid', 'run_id' => 'uuid', 'target_id' => 'uuid', 'variant' => null, 'title' => null, 'description' => null, 'is_primary' => null, 'display_order' => 'int32', 'image_url' => null, 'width' => 'int32', 'height' => 'int32', 'created_at' => 'date-time', 'updated_at' => 'date-time']
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'DevicePreviewSharedScreenshotDto'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['screenshot_id' => false, 'run_id' => false, 'target_id' => true, 'variant' => true, 'title' => true, 'description' => true, 'is_primary' => false, 'display_order' => false, 'image_url' => true, 'width' => true, 'height' => true, 'created_at' => false, 'updated_at' => 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
= ['screenshot_id' => 'string', 'run_id' => 'string', 'target_id' => 'string', 'variant' => 'string', 'title' => 'string', 'description' => 'string', 'is_primary' => 'bool', 'display_order' => 'int', 'image_url' => 'string', 'width' => 'int', 'height' => 'int', 'created_at' => '\\DateTime', 'updated_at' => '\\DateTime']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['screenshot_id' => 'setScreenshotId', 'run_id' => 'setRunId', 'target_id' => 'setTargetId', 'variant' => 'setVariant', 'title' => 'setTitle', 'description' => 'setDescription', 'is_primary' => 'setIsPrimary', 'display_order' => 'setDisplayOrder', 'image_url' => 'setImageUrl', 'width' => 'setWidth', 'height' => 'setHeight', 'created_at' => 'setCreatedAt', 'updated_at' => 'setUpdatedAt']
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> —getCreatedAt()
Gets created_at
public
getCreatedAt() : DateTime
Return values
DateTime —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getDisplayOrder()
Gets display_order
public
getDisplayOrder() : int
Return values
int —getHeight()
Gets height
public
getHeight() : int|null
Return values
int|null —getImageUrl()
Gets image_url
public
getImageUrl() : string|null
Return values
string|null —getIsPrimary()
Gets is_primary
public
getIsPrimary() : bool
Return values
bool —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRunId()
Gets run_id
public
getRunId() : string
Return values
string —getScreenshotId()
Gets screenshot_id
public
getScreenshotId() : string
Return values
string —getTargetId()
Gets target_id
public
getTargetId() : string|null
Return values
string|null —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|null
Return values
string|null —getUpdatedAt()
Gets updated_at
public
getUpdatedAt() : DateTime
Return values
DateTime —getVariant()
Gets variant
public
getVariant() : string|null
Return values
string|null —getWidth()
Gets width
public
getWidth() : int|null
Return values
int|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> —setCreatedAt()
Sets created_at
public
setCreatedAt(DateTime $created_at) : self
Parameters
- $created_at : DateTime
-
created_at
Return values
self —setDescription()
Sets description
public
setDescription(string|null $description) : self
Parameters
- $description : string|null
-
description
Return values
self —setDisplayOrder()
Sets display_order
public
setDisplayOrder(int $display_order) : self
Parameters
- $display_order : int
-
display_order
Return values
self —setHeight()
Sets height
public
setHeight(int|null $height) : self
Parameters
- $height : int|null
-
height
Return values
self —setImageUrl()
Sets image_url
public
setImageUrl(string|null $image_url) : self
Parameters
- $image_url : string|null
-
image_url
Return values
self —setIsPrimary()
Sets is_primary
public
setIsPrimary(bool $is_primary) : self
Parameters
- $is_primary : bool
-
is_primary
Return values
self —setRunId()
Sets run_id
public
setRunId(string $run_id) : self
Parameters
- $run_id : string
-
run_id
Return values
self —setScreenshotId()
Sets screenshot_id
public
setScreenshotId(string $screenshot_id) : self
Parameters
- $screenshot_id : string
-
screenshot_id
Return values
self —setTargetId()
Sets target_id
public
setTargetId(string|null $target_id) : self
Parameters
- $target_id : string|null
-
target_id
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|null $title) : self
Parameters
- $title : string|null
-
title
Return values
self —setUpdatedAt()
Sets updated_at
public
setUpdatedAt(DateTime $updated_at) : self
Parameters
- $updated_at : DateTime
-
updated_at
Return values
self —setVariant()
Sets variant
public
setVariant(string|null $variant) : self
Parameters
- $variant : string|null
-
variant
Return values
self —setWidth()
Sets width
public
setWidth(int|null $width) : self
Parameters
- $width : int|null
-
width
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>