Documentation

ObjectStyling
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ObjectStyling Class Doc Comment

Tags
category

Class

description

Which objects a call works on and how they are styled, as BQL and BVL - the same fields the 3D Tiles settings, the vector export and the interactive viewer take. All optional; without any of them the call uses its default scope and the objects' own colours.

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
getBql()  : string|null
Gets bql
getBqlUuid()  : string|null
Gets bql_uuid
getBvl()  : string|null
Gets bvl
getBvlUuid()  : string|null
Gets bvl_uuid
getHighlight()  : array<string, array<string|int, int>>|null
Gets highlight
getModelName()  : string
The original name of the model.
getParameters()  : array<string, mixed>|null
Gets parameters
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
setBql()  : self
Sets bql
setBqlUuid()  : self
Sets bql_uuid
setBvl()  : self
Sets bvl
setBvlUuid()  : self
Sets bvl_uuid
setHighlight()  : self
Sets highlight
setParameters()  : self
Sets parameters
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 = ['bql' => 'bql', 'bql_uuid' => 'bql_uuid', 'bvl' => 'bvl', 'bvl_uuid' => 'bvl_uuid', 'parameters' => 'parameters', 'highlight' => 'highlight']

$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 = ['bql' => 'getBql', 'bql_uuid' => 'getBqlUuid', 'bvl' => 'getBvl', 'bvl_uuid' => 'getBvlUuid', 'parameters' => 'getParameters', 'highlight' => 'getHighlight']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['bql' => null, 'bql_uuid' => 'uuid', 'bvl' => null, 'bvl_uuid' => 'uuid', 'parameters' => null, 'highlight' => 'int32']
Tags
phpstan-var

array<string, string|null>

psalm-var

array<string, string|null>

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ObjectStyling'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['bql' => false, 'bql_uuid' => false, 'bvl' => false, 'bvl_uuid' => false, 'parameters' => false, 'highlight' => 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 = ['bql' => 'string', 'bql_uuid' => 'string', 'bvl' => 'string', 'bvl_uuid' => 'string', 'parameters' => 'array<string,mixed>', 'highlight' => 'array<string,int[]>']

$setters

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

protected static array<string|int, string> $setters = ['bql' => 'setBql', 'bql_uuid' => 'setBqlUuid', 'bvl' => 'setBvl', 'bvl_uuid' => 'setBvlUuid', 'parameters' => 'setParameters', 'highlight' => 'setHighlight']

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>

getBql()

Gets bql

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

getBqlUuid()

Gets bql_uuid

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

getBvl()

Gets bvl

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

getBvlUuid()

Gets bvl_uuid

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

getHighlight()

Gets highlight

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getParameters()

Gets parameters

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

setBql()

Sets bql

public setBql(string|null $bql) : self
Parameters
$bql : string|null

A BQL query (or a bare boolean expression) whose result objects are the visible set. Objects outside it are absent from the output.

Return values
self

setBqlUuid()

Sets bql_uuid

public setBqlUuid(string|null $bql_uuid) : self
Parameters
$bql_uuid : string|null

A stored BQL query used instead of bql.

Return values
self

setBvl()

Sets bvl

public setBvl(string|null $bvl) : self
Parameters
$bvl : string|null

A BVL script - SHOW/HIDE, COLOR, label(), annotate(text()), VIEWFIT. Actions that only mean something in the interactive viewer are ignored.

Return values
self

setBvlUuid()

Sets bvl_uuid

public setBvlUuid(string|null $bvl_uuid) : self
Parameters
$bvl_uuid : string|null

A stored BVL script used instead of bvl.

Return values
self

setHighlight()

Sets highlight

public setHighlight(array<string, array<string|int, int>>|null $highlight) : self
Parameters
$highlight : array<string, array<string|int, int>>|null

Object ids per model version - the JSON form of a BIM.works qid set - keyed by version uuid, each value the object ids (oids) in that version.

Return values
self

setParameters()

Sets parameters

public setParameters(array<string, mixed>|null $parameters) : self
Parameters
$parameters : array<string, mixed>|null

Values for the $name parameters of bql and bvl.

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