Documentation

CompareModelsRequest
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareModelsRequest 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

DEFINITION__DEFAULT  : mixed = 'default'
DEFINITION_EVERYTHING  : mixed = 'everything'
DEFINITION_GEOMETRY  : mixed = 'geometry'
DEFINITION_INVENTORY  : mixed = 'inventory'
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
getActionUuid()  : string|null
Gets action_uuid
getActionVersion()  : int|null
Gets action_version
getBcol()  : string|null
Gets bcol
getBcolJson()  : array<string, mixed>|null
Gets bcol_json
getDefinition()  : string|null
Gets definition
getDefinitionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getLeft()  : CompareSide
Gets left
getModelName()  : string
The original name of the model.
getOptions()  : CompareOptions|null
Gets options
getRight()  : CompareSide
Gets right
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
setActionUuid()  : self
Sets action_uuid
setActionVersion()  : self
Sets action_version
setBcol()  : self
Sets bcol
setBcolJson()  : self
Sets bcol_json
setDefinition()  : self
Sets definition
setLeft()  : self
Sets left
setOptions()  : self
Sets options
setRight()  : self
Sets right
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', 'bcol' => 'bcol', 'bcol_json' => 'bcol_json', 'definition' => 'definition', 'action_uuid' => 'action_uuid', 'action_version' => 'action_version', 'options' => 'options']

$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', 'bcol' => 'getBcol', 'bcol_json' => 'getBcolJson', 'definition' => 'getDefinition', 'action_uuid' => 'getActionUuid', 'action_version' => 'getActionVersion', 'options' => 'getOptions']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['left' => null, 'right' => null, 'bcol' => null, 'bcol_json' => null, 'definition' => null, 'action_uuid' => 'uuid', 'action_version' => null, 'options' => 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 = 'CompareModelsRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['left' => false, 'right' => false, 'bcol' => false, 'bcol_json' => false, 'definition' => false, 'action_uuid' => false, 'action_version' => false, 'options' => 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' => '\BIMworks\Model\CompareSide', 'right' => '\BIMworks\Model\CompareSide', 'bcol' => 'string', 'bcol_json' => 'array<string,mixed>', 'definition' => 'string', 'action_uuid' => 'string', 'action_version' => 'int', 'options' => '\BIMworks\Model\CompareOptions']

$setters

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

protected static array<string|int, string> $setters = ['left' => 'setLeft', 'right' => 'setRight', 'bcol' => 'setBcol', 'bcol_json' => 'setBcolJson', 'definition' => 'setDefinition', 'action_uuid' => 'setActionUuid', 'action_version' => 'setActionVersion', 'options' => 'setOptions']

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>

getActionUuid()

Gets action_uuid

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

getActionVersion()

Gets action_version

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

getBcolJson()

Gets bcol_json

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

getDefinition()

Gets definition

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

getDefinitionAllowableValues()

Gets allowable values of the enum

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
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>

setActionUuid()

Sets action_uuid

public setActionUuid(string|null $action_uuid) : self
Parameters
$action_uuid : string|null

A stored compare (BCOL) action

Return values
self

setActionVersion()

Sets action_version

public setActionVersion(int|null $action_version) : self
Parameters
$action_version : int|null

The version of the stored action; default its current version

Return values
self

setBcol()

Sets bcol

public setBcol(string|null $bcol) : self
Parameters
$bcol : string|null

A BCOL definition. When neither bcol, bcol_json, definition nor action_uuid is given, the built-in Default is used

Return values
self

setBcolJson()

Sets bcol_json

public setBcolJson(array<string, mixed>|null $bcol_json) : self
Parameters
$bcol_json : array<string, mixed>|null

A BCOL definition as JSON, the V3 envelope {"lang": "bcol", "version": "3", "definition": {...}}: the structure as JSON, conditions, features and styles as BQL and BVL text. Its JSON Schema (2020-12) is https://bim.works/schemas/bcol/v3 (ApiSpec/src/schemas/bcol-v3.schema.json). An error is reported at its JSON path

Return values
self

setDefinition()

Sets definition

public setDefinition(string|null $definition) : self
Parameters
$definition : string|null

A built-in definition

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