Documentation

CompareStats
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareStats 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

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
getDuplicates()  : CompareStatsDuplicates|null
Gets duplicates
getElapsedMs()  : int|null
Gets elapsed_ms
getFastPath()  : CompareStatsFastPath|null
Gets fast_path
getIgnored()  : int|null
Gets ignored
getLeft()  : int|null
Gets left
getLineage()  : bool|null
Gets lineage
getMatched()  : int|null
Gets matched
getMatchedBy()  : array<string, int>|null
Gets matched_by
getMatchRate()  : float|null
Gets match_rate
getModelName()  : string
The original name of the model.
getRight()  : int|null
Gets right
getSameContent()  : bool|null
Gets same_content
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
setDuplicates()  : self
Sets duplicates
setElapsedMs()  : self
Sets elapsed_ms
setFastPath()  : self
Sets fast_path
setIgnored()  : self
Sets ignored
setLeft()  : self
Sets left
setLineage()  : self
Sets lineage
setMatched()  : self
Sets matched
setMatchedBy()  : self
Sets matched_by
setMatchRate()  : self
Sets match_rate
setRight()  : self
Sets right
setSameContent()  : self
Sets same_content
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 = ['left' => 'left', 'right' => 'right', 'matched' => 'matched', 'match_rate' => 'match_rate', 'matched_by' => 'matched_by', 'duplicates' => 'duplicates', 'ignored' => 'ignored', 'lineage' => 'lineage', 'same_content' => 'same_content', 'fast_path' => 'fast_path', 'elapsed_ms' => 'elapsed_ms']

$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', 'matched' => 'getMatched', 'match_rate' => 'getMatchRate', 'matched_by' => 'getMatchedBy', 'duplicates' => 'getDuplicates', 'ignored' => 'getIgnored', 'lineage' => 'getLineage', 'same_content' => 'getSameContent', 'fast_path' => 'getFastPath', 'elapsed_ms' => 'getElapsedMs']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['left' => null, 'right' => null, 'matched' => null, 'match_rate' => null, 'matched_by' => null, 'duplicates' => null, 'ignored' => null, 'lineage' => null, 'same_content' => null, 'fast_path' => null, 'elapsed_ms' => 'int64']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'CompareStats'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['left' => false, 'right' => false, 'matched' => false, 'match_rate' => false, 'matched_by' => false, 'duplicates' => false, 'ignored' => false, 'lineage' => false, 'same_content' => false, 'fast_path' => false, 'elapsed_ms' => 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' => 'int', 'right' => 'int', 'matched' => 'int', 'match_rate' => 'float', 'matched_by' => 'array<string,int>', 'duplicates' => '\BIMworks\Model\CompareStatsDuplicates', 'ignored' => 'int', 'lineage' => 'bool', 'same_content' => 'bool', 'fast_path' => '\BIMworks\Model\CompareStatsFastPath', 'elapsed_ms' => 'int']

$setters

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

protected static array<string|int, string> $setters = ['left' => 'setLeft', 'right' => 'setRight', 'matched' => 'setMatched', 'match_rate' => 'setMatchRate', 'matched_by' => 'setMatchedBy', 'duplicates' => 'setDuplicates', 'ignored' => 'setIgnored', 'lineage' => 'setLineage', 'same_content' => 'setSameContent', 'fast_path' => 'setFastPath', 'elapsed_ms' => 'setElapsedMs']

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>

getElapsedMs()

Gets elapsed_ms

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

getIgnored()

Gets ignored

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

getLeft()

Gets left

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

getLineage()

Gets lineage

public getLineage() : bool|null
Return values
bool|null

getMatched()

Gets matched

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

getMatchedBy()

Gets matched_by

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

getMatchRate()

Gets match_rate

public getMatchRate() : float|null
Return values
float|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getRight()

Gets right

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

getSameContent()

Gets same_content

public getSameContent() : bool|null
Return values
bool|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>

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>

setElapsedMs()

Sets elapsed_ms

public setElapsedMs(int|null $elapsed_ms) : self
Parameters
$elapsed_ms : int|null

elapsed_ms

Return values
self

setIgnored()

Sets ignored

public setIgnored(int|null $ignored) : self
Parameters
$ignored : int|null

Objects and pairs a rule ignored

Return values
self

setLeft()

Sets left

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

Objects in scope on the left

Return values
self

setLineage()

Sets lineage

public setLineage(bool|null $lineage) : self
Parameters
$lineage : bool|null

Whether one Version descends from the other, so equal object ids are the same object

Return values
self

setMatched()

Sets matched

public setMatched(int|null $matched) : self
Parameters
$matched : int|null

Pairs

Return values
self

setMatchedBy()

Sets matched_by

public setMatchedBy(array<string, int>|null $matched_by) : self
Parameters
$matched_by : array<string, int>|null

Pairs per matcher

Return values
self

setMatchRate()

Sets match_rate

public setMatchRate(float|null $match_rate) : self
Parameters
$match_rate : float|null

Pairs per object of the smaller side

Return values
self

setRight()

Sets right

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

Objects in scope on the right

Return values
self

setSameContent()

Sets same_content

public setSameContent(bool|null $same_content) : self
Parameters
$same_content : bool|null

Whether both sides have identical content

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