Tectly PHP Client

Floor
in package

Tectly

OpenAPI

implements ModelInterface, ArrayAccess, JsonSerializable

Floor Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR = null

Properties

$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)

Methods

__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
getCaption() : string|null: Gets caption
getCeilingHeight() : float|null: Gets ceiling_height
getCreatedDate() : DateTime|null: Gets created_date
getEnvelope() : array<string|int, array<string|int, float>>|null: Gets envelope
getHorizontalScale() : float: Gets horizontal_scale
getId() : string|null: Gets id
getLastModifiedDate() : DateTime|null: Gets last_modified_date
getLevel() : string|null: Gets level
getModelName() : string: The original name of the model.
getPlanId() : string|null: Gets plan_id
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getVerticalScale() : float: Gets vertical_scale
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
setCaption() : self: Sets caption
setCeilingHeight() : self: Sets ceiling_height
setCreatedDate() : self: Sets created_date
setEnvelope() : self: Sets envelope
setHorizontalScale() : self: Sets horizontal_scale
setId() : self: Sets id
setLastModifiedDate() : self: Sets last_modified_date
setLevel() : self: Sets level
setPlanId() : self: Sets plan_id
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setVerticalScale() : self: Sets vertical_scale
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

$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', 'created_date' => 'createdDate', 'last_modified_date' => 'lastModifiedDate', 'plan_id' => 'planId', 'caption' => 'caption', 'level' => 'level', 'ceiling_height' => 'ceilingHeight', 'envelope' => 'envelope', 'horizontal_scale' => 'horizontalScale', 'vertical_scale' => 'verticalScale']

$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
     = ['id' => 'getId', 'created_date' => 'getCreatedDate', 'last_modified_date' => 'getLastModifiedDate', 'plan_id' => 'getPlanId', 'caption' => 'getCaption', 'level' => 'getLevel', 'ceiling_height' => 'getCeilingHeight', 'envelope' => 'getEnvelope', 'horizontal_scale' => 'getHorizontalScale', 'vertical_scale' => 'getVerticalScale']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['id' => 'uuid', 'created_date' => 'date-time', 'last_modified_date' => 'date-time', 'plan_id' => 'uuid', 'caption' => null, 'level' => null, 'ceiling_height' => 'double', 'envelope' => 'double', 'horizontal_scale' => 'double', 'vertical_scale' => 'double']

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'Floor'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['id' => false, 'created_date' => false, 'last_modified_date' => false, 'plan_id' => false, 'caption' => false, 'level' => false, 'ceiling_height' => false, 'envelope' => false, 'horizontal_scale' => false, 'vertical_scale' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here


        protected
            array<string|int, bool>
    $openAPINullablesSetToNull
     = []

$openAPITypes

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


        protected
        static    array<string|int, string>
    $openAPITypes
     = ['id' => 'string', 'created_date' => '\DateTime', 'last_modified_date' => '\DateTime', 'plan_id' => 'string', 'caption' => 'string', 'level' => 'string', 'ceiling_height' => 'float', 'envelope' => 'float[][]', 'horizontal_scale' => 'float', 'vertical_scale' => 'float']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['id' => 'setId', 'created_date' => 'setCreatedDate', 'last_modified_date' => 'setLastModifiedDate', 'plan_id' => 'setPlanId', 'caption' => 'setCaption', 'level' => 'setLevel', 'ceiling_height' => 'setCeilingHeight', 'envelope' => 'setEnvelope', 'horizontal_scale' => 'setHorizontalScale', 'vertical_scale' => 'setVerticalScale']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed>|null $data = null ]) : mixed

Parameters

$data : array<string|int, mixed>|null = null: Associated array of property values initializing the model

__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>

getCaption()

Gets caption


    public
                    getCaption() : string|null

Return values

string|null

getCeilingHeight()

Gets ceiling_height


    public
                    getCeilingHeight() : float|null

Return values

float|null

getCreatedDate()

Gets created_date


    public
                    getCreatedDate() : DateTime|null

Return values

DateTime|null

getEnvelope()

Gets envelope


    public
                    getEnvelope() : array<string|int, array<string|int, float>>|null

Return values

array<string|int, array<string|int, float>>|null

getHorizontalScale()

Gets horizontal_scale


    public
                    getHorizontalScale() : float

Return values

float

getId()

Gets id


    public
                    getId() : string|null

Return values

string|null

getLastModifiedDate()

Gets last_modified_date


    public
                    getLastModifiedDate() : DateTime|null

Return values

DateTime|null

getLevel()

Gets level


    public
                    getLevel() : string|null

Return values

string|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getPlanId()

Gets plan_id


    public
                    getPlanId() : 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>

getVerticalScale()

Gets vertical_scale


    public
                    getVerticalScale() : float

Return values

float

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

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|string $offset) : bool

Parameters

$offset : int|string: Offset

Return values

bool

offsetGet()

Gets offset.


    public
                    offsetGet(int|string $offset) : mixed|null

Parameters

$offset : int|string: Offset

#[ReturnTypeWillChange]

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

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int|string $offset) : void

Parameters

$offset : int|string: Offset

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>

setCaption()

Sets caption


    public
                    setCaption(string|null $caption) : self

Parameters

$caption : string|null: caption

Return values

self

setCeilingHeight()

Sets ceiling_height


    public
                    setCeilingHeight(float|null $ceiling_height) : self

Parameters

$ceiling_height : float|null: ceiling_height

Return values

self

setCreatedDate()

Sets created_date


    public
                    setCreatedDate(DateTime|null $created_date) : self

Parameters

$created_date : DateTime|null: created_date

Return values

self

setEnvelope()

Sets envelope


    public
                    setEnvelope(array<string|int, array<string|int, float>>|null $envelope) : self

Parameters

$envelope : array<string|int, array<string|int, float>>|null: envelope

Return values

self

setHorizontalScale()

Sets horizontal_scale


    public
                    setHorizontalScale(float $horizontal_scale) : self

Parameters

$horizontal_scale : float: horizontal_scale

Return values

self

setId()

Sets id


    public
                    setId(string|null $id) : self

Parameters

$id : string|null: id

Return values

self

setLastModifiedDate()

Sets last_modified_date


    public
                    setLastModifiedDate(DateTime|null $last_modified_date) : self

Parameters

$last_modified_date : DateTime|null: last_modified_date

Return values

self

setLevel()

Sets level


    public
                    setLevel(string|null $level) : self

Parameters

$level : string|null: level

Return values

self

setPlanId()

Sets plan_id


    public
                    setPlanId(string|null $plan_id) : self

Parameters

$plan_id : string|null: plan_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>

setVerticalScale()

Sets vertical_scale


    public
                    setVerticalScale(float $vertical_scale) : self

Parameters

$vertical_scale : float: vertical_scale

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

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>

Floor in package Tectly OpenAPI implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getCaption()

Return values

getCeilingHeight()

Return values

getCreatedDate()

Return values

getEnvelope()

Return values

getHorizontalScale()

Return values

getId()

Return values

getLastModifiedDate()

Return values

getLevel()

Return values

getModelName()

Return values

getPlanId()

Return values

getters()

Return values

getVerticalScale()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

openAPITypes()

Return values

setCaption()

Parameters

Floor
in package

Tectly

OpenAPI

implements ModelInterface, ArrayAccess, JsonSerializable