Documentation

CompareRecord
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareRecord 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_ADDED  : mixed = 'added'
STATUS_CHANGED  : mixed = 'changed'
STATUS_REMOVED  : mixed = 'removed'

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
getKey()  : string|null
Gets key
getL()  : int|null
Gets l
getLV()  : int|null
Gets l_v
getMatchedBy()  : string|null
Gets matched_by
getModelName()  : string
The original name of the model.
getR()  : int|null
Gets r
getReport()  : CompareRecordReport|null
Gets report
getRule()  : string|null
Gets rule
getRV()  : int|null
Gets r_v
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
setCategory()  : self
Sets category
setChangedFeatures()  : self
Sets changed_features
setChanges()  : self
Sets changes
setKey()  : self
Sets key
setL()  : self
Sets l
setLV()  : self
Sets l_v
setMatchedBy()  : self
Sets matched_by
setR()  : self
Sets r
setReport()  : self
Sets report
setRule()  : self
Sets rule
setRV()  : self
Sets r_v
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
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 = ['category' => 'category', 'rule' => 'rule', 'status' => 'status', 'l' => 'l', 'r' => 'r', 'l_v' => 'l_v', 'r_v' => 'r_v', 'matched_by' => 'matched_by', 'key' => 'key', 'changed_features' => 'changed_features', 'changes' => 'changes', 'report' => 'report']

$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 = ['category' => 'getCategory', 'rule' => 'getRule', 'status' => 'getStatus', 'l' => 'getL', 'r' => 'getR', 'l_v' => 'getLV', 'r_v' => 'getRV', 'matched_by' => 'getMatchedBy', 'key' => 'getKey', 'changed_features' => 'getChangedFeatures', 'changes' => 'getChanges', 'report' => 'getReport']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['category' => null, 'rule' => null, 'status' => null, 'l' => null, 'r' => null, 'l_v' => null, 'r_v' => null, 'matched_by' => null, 'key' => null, 'changed_features' => null, 'changes' => null, 'report' => 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 = 'CompareRecord'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['category' => false, 'rule' => false, 'status' => false, 'l' => false, 'r' => false, 'l_v' => false, 'r_v' => false, 'matched_by' => false, 'key' => false, 'changed_features' => false, 'changes' => false, 'report' => 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 = ['category' => 'string', 'rule' => 'string', 'status' => 'string', 'l' => 'int', 'r' => 'int', 'l_v' => 'int', 'r_v' => 'int', 'matched_by' => 'string', 'key' => 'string', 'changed_features' => 'string[]', 'changes' => 'array<string,mixed>', 'report' => '\BIMworks\Model\CompareRecordReport']

$setters

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

protected static array<string|int, string> $setters = ['category' => 'setCategory', 'rule' => 'setRule', 'status' => 'setStatus', 'l' => 'setL', 'r' => 'setR', 'l_v' => 'setLV', 'r_v' => 'setRV', 'matched_by' => 'setMatchedBy', 'key' => 'setKey', 'changed_features' => 'setChangedFeatures', 'changes' => 'setChanges', 'report' => 'setReport']

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

getKey()

Gets key

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

getL()

Gets l

public getL() : int|null
Return values
int|null

getLV()

Gets l_v

public getLV() : int|null
Return values
int|null

getMatchedBy()

Gets matched_by

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getR()

Gets r

public getR() : int|null
Return values
int|null

getRule()

Gets rule

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

getRV()

Gets r_v

public getRV() : int|null
Return values
int|null

getStatus()

Gets status

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

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>

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

The watched features that changed, for example attribute.Name, geometry.translation

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: left, right, and for numbers delta and unit, for sets added and removed; geometry holds the measured facets

Return values
self

setKey()

Sets key

public setKey(string|null $key) : self
Parameters
$key : string|null

The GlobalId

Return values
self

setL()

Sets l

public setL(int|null $l) : self
Parameters
$l : int|null

The left object id

Return values
self

setLV()

Sets l_v

public setLV(int|null $l_v) : self
Parameters
$l_v : int|null

A federation's left side only. The index of the left object's Version in vids

Return values
self

setMatchedBy()

Sets matched_by

public setMatchedBy(string|null $matched_by) : self
Parameters
$matched_by : string|null

The matcher that paired the objects

Return values
self

setR()

Sets r

public setR(int|null $r) : self
Parameters
$r : int|null

The right object id

Return values
self

setRule()

Sets rule

public setRule(string|null $rule) : self
Parameters
$rule : string|null

rule

Return values
self

setRV()

Sets r_v

public setRV(int|null $r_v) : self
Parameters
$r_v : int|null

A federation's right side only. The index of the right object's Version in vids

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>

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