Documentation

ResolvedActions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ResolvedActions Class Doc Comment

Tags
category

Class

description

What a BVL script (or the BVL of a check) does to the objects of the models, ready for a viewer. Every key but `force` is optional and present only when the script uses it; the keys not listed here (pickability, section and end-cap behaviour, wireframes, colour alterations, geometries, overlays) follow the BVL actions of the same name.

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
getAnnotations()  : array<string|int, array<string, mixed>>|null
Gets annotations
getColor()  : array<string, array<string|int, mixed>>|null
Gets color
getColorReset()  : array<string, array<string|int, int>>|null
Gets color_reset
getForce()  : bool
Gets force
getHide()  : array<string, array<string|int, int>>|null
Gets hide
getLabels()  : array<string|int, array<string, mixed>>|null
Gets labels
getModelName()  : string
The original name of the model.
getSelect()  : array<string, array<string|int, int>>|null
Gets select
getShow()  : array<string, array<string|int, int>>|null
Gets show
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUnselect()  : array<string, array<string|int, int>>|null
Gets unselect
getViewFit()  : array<string, array<string|int, int>>|null
Gets view_fit
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
setAnnotations()  : self
Sets annotations
setColor()  : self
Sets color
setColorReset()  : self
Sets color_reset
setForce()  : self
Sets force
setHide()  : self
Sets hide
setLabels()  : self
Sets labels
setSelect()  : self
Sets select
setShow()  : self
Sets show
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUnselect()  : self
Sets unselect
setViewFit()  : self
Sets view_fit
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 = ['force' => 'force', 'show' => 'show', 'hide' => 'hide', 'select' => 'select', 'unselect' => 'unselect', 'view_fit' => 'viewFit', 'color' => 'color', 'color_reset' => 'colorReset', 'labels' => 'labels', 'annotations' => 'annotations']

$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 = ['force' => 'getForce', 'show' => 'getShow', 'hide' => 'getHide', 'select' => 'getSelect', 'unselect' => 'getUnselect', 'view_fit' => 'getViewFit', 'color' => 'getColor', 'color_reset' => 'getColorReset', 'labels' => 'getLabels', 'annotations' => 'getAnnotations']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['force' => null, 'show' => 'int32', 'hide' => 'int32', 'select' => 'int32', 'unselect' => 'int32', 'view_fit' => 'int32', 'color' => 'int32', 'color_reset' => 'int32', 'labels' => null, 'annotations' => 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 = 'ResolvedActions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['force' => false, 'show' => false, 'hide' => false, 'select' => false, 'unselect' => false, 'view_fit' => false, 'color' => false, 'color_reset' => false, 'labels' => false, 'annotations' => 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 = ['force' => 'bool', 'show' => 'array<string,int[]>', 'hide' => 'array<string,int[]>', 'select' => 'array<string,int[]>', 'unselect' => 'array<string,int[]>', 'view_fit' => 'array<string,int[]>', 'color' => 'array<string,array>', 'color_reset' => 'array<string,int[]>', 'labels' => 'array<string,mixed>[]', 'annotations' => 'array<string,mixed>[]']

$setters

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

protected static array<string|int, string> $setters = ['force' => 'setForce', 'show' => 'setShow', 'hide' => 'setHide', 'select' => 'setSelect', 'unselect' => 'setUnselect', 'view_fit' => 'setViewFit', 'color' => 'setColor', 'color_reset' => 'setColorReset', 'labels' => 'setLabels', 'annotations' => 'setAnnotations']

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>

getAnnotations()

Gets annotations

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

getColor()

Gets color

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

getColorReset()

Gets color_reset

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

getHide()

Gets hide

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

getLabels()

Gets labels

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSelect()

Gets select

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

getShow()

Gets show

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

getUnselect()

Gets unselect

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

getViewFit()

Gets view_fit

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

setAnnotations()

Sets annotations

public setAnnotations(array<string|int, array<string, mixed>>|null $annotations) : self
Parameters
$annotations : array<string|int, array<string, mixed>>|null

Annotations placed at objects (BVL annotate), one entry per object with its qid and its annotations

Return values
self

setColor()

Sets color

public setColor(array<string, array<string|int, mixed>>|null $color) : self
Parameters
$color : array<string, array<string|int, mixed>>|null

The new colour of objects: hex colour #rrggbbaa (the alpha byte is the opacity) to the objects that get it

Return values
self

setColorReset()

Sets color_reset

public setColorReset(array<string, array<string|int, int>>|null $color_reset) : self
Parameters
$color_reset : 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

setForce()

Sets force

public setForce(bool $force) : self
Parameters
$force : bool

Visibility, pickability and section changes override what the viewer's user set by hand

Return values
self

setHide()

Sets hide

public setHide(array<string, array<string|int, int>>|null $hide) : self
Parameters
$hide : 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

setLabels()

Sets labels

public setLabels(array<string|int, array<string, mixed>>|null $labels) : self
Parameters
$labels : array<string|int, array<string, mixed>>|null

Texts shown next to objects (BVL label), one entry per object with its qid and its labels

Return values
self

setSelect()

Sets select

public setSelect(array<string, array<string|int, int>>|null $select) : self
Parameters
$select : 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

setShow()

Sets show

public setShow(array<string, array<string|int, int>>|null $show) : self
Parameters
$show : 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

setters()

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

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>

setUnselect()

Sets unselect

public setUnselect(array<string, array<string|int, int>>|null $unselect) : self
Parameters
$unselect : 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

setViewFit()

Sets view_fit

public setViewFit(array<string, array<string|int, int>>|null $view_fit) : self
Parameters
$view_fit : 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

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