Documentation

CompareObjectsResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareObjectsResult Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null
STATUS_CHANGED  : mixed = 'changed'
STATUS_IGNORED  : mixed = 'ignored'
STATUS_UNCHANGED  : mixed = 'unchanged'

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
getCategory()  : string|null
Gets category
getChangedFeatures()  : array<string|int, string>|null
Gets changed_features
getChanges()  : array<string, mixed>|null
Gets changes
getDefinition()  : CompareDefinitionRef|null
Gets definition
getHiddenFeatures()  : array<string|int, string>|null
Gets hidden_features
getLabel()  : string|null
Gets label
getLeft()  : string|null
Gets left
getModelName()  : string
The original name of the model.
getRight()  : string|null
Gets right
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)
getWatched()  : array<string|int, string>|null
Gets watched
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
setCategory()  : self
Sets category
setChangedFeatures()  : self
Sets changed_features
setChanges()  : self
Sets changes
setDefinition()  : self
Sets definition
setHiddenFeatures()  : self
Sets hidden_features
setLabel()  : self
Sets label
setLeft()  : self
Sets left
setRight()  : self
Sets right
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWatched()  : self
Sets watched
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 = ['left' => 'left', 'right' => 'right', 'status' => 'status', 'category' => 'category', 'label' => 'label', 'changed_features' => 'changed_features', 'changes' => 'changes', 'watched' => 'watched', 'definition' => 'definition', 'hidden_features' => 'hiddenFeatures']

$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 = ['left' => 'getLeft', 'right' => 'getRight', 'status' => 'getStatus', 'category' => 'getCategory', 'label' => 'getLabel', 'changed_features' => 'getChangedFeatures', 'changes' => 'getChanges', 'watched' => 'getWatched', 'definition' => 'getDefinition', 'hidden_features' => 'getHiddenFeatures']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['left' => null, 'right' => null, 'status' => null, 'category' => null, 'label' => null, 'changed_features' => null, 'changes' => null, 'watched' => null, 'definition' => null, 'hidden_features' => 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 = 'CompareObjectsResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['left' => false, 'right' => false, 'status' => false, 'category' => false, 'label' => false, 'changed_features' => false, 'changes' => false, 'watched' => false, 'definition' => false, 'hidden_features' => 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 = ['left' => 'string', 'right' => 'string', 'status' => 'string', 'category' => 'string', 'label' => 'string', 'changed_features' => 'string[]', 'changes' => 'array<string,mixed>', 'watched' => 'string[]', 'definition' => '\BIMworks\Model\CompareDefinitionRef', 'hidden_features' => 'string[]']

$setters

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

protected static array<string|int, string> $setters = ['left' => 'setLeft', 'right' => 'setRight', 'status' => 'setStatus', 'category' => 'setCategory', 'label' => 'setLabel', 'changed_features' => 'setChangedFeatures', 'changes' => 'setChanges', 'watched' => 'setWatched', 'definition' => 'setDefinition', 'hidden_features' => 'setHiddenFeatures']

Methods

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

getCategory()

Gets category

public getCategory() : string|null
Return values
string|null

getChangedFeatures()

Gets changed_features

public getChangedFeatures() : array<string|int, string>|null
Return values
array<string|int, string>|null

getChanges()

Gets changes

public getChanges() : array<string, mixed>|null
Return values
array<string, mixed>|null

getHiddenFeatures()

Gets hidden_features

public getHiddenFeatures() : array<string|int, string>|null
Return values
array<string|int, string>|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

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>

getWatched()

Gets watched

public getWatched() : array<string|int, string>|null
Return values
array<string|int, string>|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

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

Attributes
#[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>

setCategory()

Sets category

public setCategory(string|null $category) : self
Parameters
$category : string|null

category

Return values
self

setChangedFeatures()

Sets changed_features

public setChangedFeatures(array<string|int, string>|null $changed_features) : self
Parameters
$changed_features : array<string|int, string>|null

changed_features

Return values
self

setChanges()

Sets changes

public setChanges(array<string, mixed>|null $changes) : self
Parameters
$changes : array<string, mixed>|null

Per changed feature at its record path its left and right value, and geometry's measures

Return values
self

setHiddenFeatures()

Sets hidden_features

public setHiddenFeatures(array<string|int, string>|null $hidden_features) : self
Parameters
$hidden_features : array<string|int, string>|null

hidden_features

Return values
self

setLabel()

Sets label

public setLabel(string|null $label) : self
Parameters
$label : string|null

label

Return values
self

setLeft()

Sets left

public setLeft(string|null $left) : self
Parameters
$left : string|null

left

Return values
self

setRight()

Sets right

public setRight(string|null $right) : self
Parameters
$right : string|null

right

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>

setWatched()

Sets watched

public setWatched(array<string|int, string>|null $watched) : self
Parameters
$watched : array<string|int, string>|null

What the definition watches; a feature that differs but is not watched is not compared

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>
On this page

Search results