Documentation

CreateNetworkFloorPlan implements ModelInterface, ArrayAccess

CreateNetworkFloorPlan Class Doc Comment

Tags
category

Class

author

Swagger Codegen team

link
https://github.com/swagger-api/swagger-codegen

Interfaces, Classes and Traits

ModelInterface
Interface abstracting model access.
ArrayAccess

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)
$setters  : array<string|int, string>
Array of attributes to setter functions (for deserialization of responses)
$swaggerFormats  : array<string|int, string>
Array of property to format mappings. Used for (de)serialization
$swaggerModelName  : string
The original name of the model.
$swaggerTypes  : array<string|int, string>
Array of property to type mappings. Used for (de)serialization
__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
getBottomLeftCorner()  : NetworksnetworkIdfloorPlansBottomLeftCorner
Gets bottom_left_corner
getBottomRightCorner()  : NetworksnetworkIdfloorPlansBottomRightCorner
Gets bottom_right_corner
getCenter()  : NetworksnetworkIdfloorPlansCenter
Gets center
getImageContents()  : string
Gets image_contents
getModelName()  : string
The original name of the model.
getName()  : string
Gets name
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTopLeftCorner()  : NetworksnetworkIdfloorPlansTopLeftCorner
Gets top_left_corner
getTopRightCorner()  : NetworksnetworkIdfloorPlansTopRightCorner
Gets top_right_corner
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
offsetExists()  : bool
Returns true if offset exists. False otherwise.
offsetGet()  : mixed
Gets offset.
offsetSet()  : void
Sets value based on offset.
offsetUnset()  : void
Unsets offset.
setBottomLeftCorner()  : $this
Sets bottom_left_corner
setBottomRightCorner()  : $this
Sets bottom_right_corner
setCenter()  : $this
Sets center
setImageContents()  : $this
Sets image_contents
setName()  : $this
Sets name
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTopLeftCorner()  : $this
Sets top_left_corner
setTopRightCorner()  : $this
Sets top_right_corner
swaggerFormats()  : array<string|int, mixed>
Array of property to format mappings. Used for (de)serialization
swaggerTypes()  : array<string|int, mixed>
Array of property to type mappings. Used for (de)serialization
valid()  : bool
Validate all the properties in the model return true if all passed

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 = ['name' => 'name', 'center' => 'center', 'bottom_left_corner' => 'bottomLeftCorner', 'bottom_right_corner' => 'bottomRightCorner', 'top_left_corner' => 'topLeftCorner', 'top_right_corner' => 'topRightCorner', 'image_contents' => 'imageContents']

$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 = ['name' => 'getName', 'center' => 'getCenter', 'bottom_left_corner' => 'getBottomLeftCorner', 'bottom_right_corner' => 'getBottomRightCorner', 'top_left_corner' => 'getTopLeftCorner', 'top_right_corner' => 'getTopRightCorner', 'image_contents' => 'getImageContents']

$setters

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

protected static array<string|int, string> $setters = ['name' => 'setName', 'center' => 'setCenter', 'bottom_left_corner' => 'setBottomLeftCorner', 'bottom_right_corner' => 'setBottomRightCorner', 'top_left_corner' => 'setTopLeftCorner', 'top_right_corner' => 'setTopRightCorner', 'image_contents' => 'setImageContents']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['name' => null, 'center' => null, 'bottom_left_corner' => null, 'bottom_right_corner' => null, 'top_left_corner' => null, 'top_right_corner' => null, 'image_contents' => 'byte']

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'createNetworkFloorPlan'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['name' => 'string', 'center' => '\Swagger\Client\Model\NetworksnetworkIdfloorPlansCenter', 'bottom_left_corner' => '\Swagger\Client\Model\NetworksnetworkIdfloorPlansBottomLeftCorner', 'bottom_right_corner' => '\Swagger\Client\Model\NetworksnetworkIdfloorPlansBottomRightCorner', 'top_left_corner' => '\Swagger\Client\Model\NetworksnetworkIdfloorPlansTopLeftCorner', 'top_right_corner' => '\Swagger\Client\Model\NetworksnetworkIdfloorPlansTopRightCorner', 'image_contents' => 'string']

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>

getImageContents()

Gets image_contents

public getImageContents() : string
Return values
string

getModelName()

The original name of the model.

public getModelName() : string
Return values
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>

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
Parameters
$offset : int

Offset

Return values
mixed

offsetSet()

Sets value based on offset.

public offsetSet(int $offset, mixed $value) : void
Parameters
$offset : int

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

setImageContents()

Sets image_contents

public setImageContents(string $image_contents) : $this
Parameters
$image_contents : string

The file contents (a base 64 encoded string) of your image. Supported formats are PNG, GIF, and JPG. Note that all images are saved as PNG files, regardless of the format they are uploaded in.

Return values
$this

setName()

Sets name

public setName(string $name) : $this
Parameters
$name : string

The name of your floor plan.

Return values
$this

setters()

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

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerFormats()

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

public static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed>

swaggerTypes()

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

public static swaggerTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

Search results