Documentation

CompareBul
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareBul Class Doc Comment

Tags
category

Class

description

The changes of a compare of two Versions as BUL (GetCompareBul)

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
getBlocker()  : string|null
Gets blocker
getBul()  : string|null
Gets bul
getCoverage()  : CompareBulCoverage|null
Gets coverage
getLeftVersionUuid()  : string|null
Gets left_version_uuid
getModelName()  : string
The original name of the model.
getRecord()  : CompareBulRecord|null
Gets record
getResidual()  : array<string|int, CompareBulResidualInner>|null
Gets residual
getResultUuid()  : string|null
Gets result_uuid
getRightVersionUuid()  : string|null
Gets right_version_uuid
getStatements()  : array<string|int, CompareBulStatementsInner>|null
Gets statements
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getVerified()  : bool|null
Gets verified
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
setBlocker()  : self
Sets blocker
setBul()  : self
Sets bul
setCoverage()  : self
Sets coverage
setLeftVersionUuid()  : self
Sets left_version_uuid
setRecord()  : self
Sets record
setResidual()  : self
Sets residual
setResultUuid()  : self
Sets result_uuid
setRightVersionUuid()  : self
Sets right_version_uuid
setStatements()  : self
Sets statements
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setVerified()  : self
Sets verified
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 = ['result_uuid' => 'result_uuid', 'left_version_uuid' => 'left_version_uuid', 'right_version_uuid' => 'right_version_uuid', 'bul' => 'bul', 'statements' => 'statements', 'residual' => 'residual', 'coverage' => 'coverage', 'verified' => 'verified', 'blocker' => 'blocker', 'record' => 'record']

$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 = ['result_uuid' => 'getResultUuid', 'left_version_uuid' => 'getLeftVersionUuid', 'right_version_uuid' => 'getRightVersionUuid', 'bul' => 'getBul', 'statements' => 'getStatements', 'residual' => 'getResidual', 'coverage' => 'getCoverage', 'verified' => 'getVerified', 'blocker' => 'getBlocker', 'record' => 'getRecord']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['result_uuid' => 'uuid', 'left_version_uuid' => 'uuid', 'right_version_uuid' => 'uuid', 'bul' => null, 'statements' => null, 'residual' => null, 'coverage' => null, 'verified' => null, 'blocker' => null, 'record' => 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 = 'CompareBul'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['result_uuid' => false, 'left_version_uuid' => false, 'right_version_uuid' => false, 'bul' => false, 'statements' => false, 'residual' => false, 'coverage' => false, 'verified' => false, 'blocker' => false, 'record' => 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 = ['result_uuid' => 'string', 'left_version_uuid' => 'string', 'right_version_uuid' => 'string', 'bul' => 'string', 'statements' => '\BIMworks\Model\CompareBulStatementsInner[]', 'residual' => '\BIMworks\Model\CompareBulResidualInner[]', 'coverage' => '\BIMworks\Model\CompareBulCoverage', 'verified' => 'bool', 'blocker' => 'string', 'record' => '\BIMworks\Model\CompareBulRecord']

$setters

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

protected static array<string|int, string> $setters = ['result_uuid' => 'setResultUuid', 'left_version_uuid' => 'setLeftVersionUuid', 'right_version_uuid' => 'setRightVersionUuid', 'bul' => 'setBul', 'statements' => 'setStatements', 'residual' => 'setResidual', 'coverage' => 'setCoverage', 'verified' => 'setVerified', 'blocker' => 'setBlocker', 'record' => 'setRecord']

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>

getBlocker()

Gets blocker

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

getBul()

Gets bul

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

getLeftVersionUuid()

Gets left_version_uuid

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getResultUuid()

Gets result_uuid

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

getRightVersionUuid()

Gets right_version_uuid

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

getVerified()

Gets verified

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

setBlocker()

Sets blocker

public setBlocker(string|null $blocker) : self
Parameters
$blocker : string|null

Why the BUL cannot replace the right Version even with every change in it, when something does

Return values
self

setBul()

Sets bul

public setBul(string|null $bul) : self
Parameters
$bul : string|null

The statements the dry run accepts, one per line

Return values
self

setLeftVersionUuid()

Sets left_version_uuid

public setLeftVersionUuid(string|null $left_version_uuid) : self
Parameters
$left_version_uuid : string|null

left_version_uuid

Return values
self

setResultUuid()

Sets result_uuid

public setResultUuid(string|null $result_uuid) : self
Parameters
$result_uuid : string|null

The stored compare result the BUL is made from

Return values
self

setRightVersionUuid()

Sets right_version_uuid

public setRightVersionUuid(string|null $right_version_uuid) : self
Parameters
$right_version_uuid : string|null

right_version_uuid

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>

setVerified()

Sets verified

public setVerified(bool|null $verified) : self
Parameters
$verified : bool|null

Whether every statement ran in a dry run of the left Version

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