Documentation

CompareLayer
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

CompareLayer Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null
KIND_ADDED : mixed = 'added'
KIND_CHANGED : mixed = 'changed'
KIND_IGNORED : mixed = 'ignored'
KIND_OTHERS : mixed = 'others'
KIND_REMOVED : mixed = 'removed'
KIND_UNCHANGED : mixed = 'unchanged'
SIDE_LEFT : mixed = 'left'
SIDE_OTHERS : mixed = 'others'
SIDE_RIGHT : mixed = 'right'

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
getActions() : array<string, mixed>|null: Gets actions
getCategory() : string|null: Gets category
getDefaultLeft() : bool|null: Gets default_left
getKind() : string|null: Gets kind
getKindAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getModelName() : string: The original name of the model.
getOids() : array<string|int, int>|null: Gets oids
getOidsV() : array<string|int, int>|null: Gets oids_v
getSide() : string|null: Gets side
getSideAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getStyle() : CompareLayerStyle|null: Gets style
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
setActions() : self: Sets actions
setCategory() : self: Sets category
setDefaultLeft() : self: Sets default_left
setKind() : self: Sets kind
setOids() : self: Sets oids
setOidsV() : self: Sets oids_v
setSide() : self: Sets side
setStyle() : self: Sets style
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

KIND_ADDED


    public
        mixed
    KIND_ADDED
    = 'added'

KIND_CHANGED


    public
        mixed
    KIND_CHANGED
    = 'changed'

KIND_IGNORED


    public
        mixed
    KIND_IGNORED
    = 'ignored'

KIND_OTHERS


    public
        mixed
    KIND_OTHERS
    = 'others'

KIND_REMOVED


    public
        mixed
    KIND_REMOVED
    = 'removed'

KIND_UNCHANGED


    public
        mixed
    KIND_UNCHANGED
    = 'unchanged'

SIDE_LEFT


    public
        mixed
    SIDE_LEFT
    = 'left'

SIDE_OTHERS


    public
        mixed
    SIDE_OTHERS
    = 'others'

SIDE_RIGHT


    public
        mixed
    SIDE_RIGHT
    = 'right'

$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
     = ['category' => 'category', 'kind' => 'kind', 'side' => 'side', 'default_left' => 'default_left', 'oids' => 'oids', 'oids_v' => 'oids_v', 'actions' => 'actions', 'style' => 'style']

$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
     = ['category' => 'getCategory', 'kind' => 'getKind', 'side' => 'getSide', 'default_left' => 'getDefaultLeft', 'oids' => 'getOids', 'oids_v' => 'getOidsV', 'actions' => 'getActions', 'style' => 'getStyle']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['category' => null, 'kind' => null, 'side' => null, 'default_left' => null, 'oids' => null, 'oids_v' => null, 'actions' => null, 'style' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'CompareLayer'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['category' => false, 'kind' => false, 'side' => false, 'default_left' => false, 'oids' => false, 'oids_v' => false, 'actions' => false, 'style' => 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
     = ['category' => 'string', 'kind' => 'string', 'side' => 'string', 'default_left' => 'bool', 'oids' => 'int[]', 'oids_v' => 'int[]', 'actions' => 'array<string,mixed>', 'style' => '\BIMworks\Model\CompareLayerStyle']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['category' => 'setCategory', 'kind' => 'setKind', 'side' => 'setSide', 'default_left' => 'setDefaultLeft', 'oids' => 'setOids', 'oids_v' => 'setOidsV', 'actions' => 'setActions', 'style' => 'setStyle']

__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>

getActions()

Gets actions


    public
                    getActions() : array<string, mixed>|null

Return values

array<string, mixed>|null

getCategory()

Gets category


    public
                    getCategory() : string|null

Return values

string|null

getDefaultLeft()

Gets default_left


    public
                    getDefaultLeft() : bool|null

Return values

bool|null

getKind()

Gets kind


    public
                    getKind() : string|null

Return values

string|null

getKindAllowableValues()

Gets allowable values of the enum


    public
                    getKindAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getOids()

Gets oids


    public
                    getOids() : array<string|int, int>|null

Return values

array<string|int, int>|null

getOidsV()

Gets oids_v


    public
                    getOidsV() : array<string|int, int>|null

Return values

array<string|int, int>|null

getSide()

Gets side


    public
                    getSide() : string|null

Return values

string|null

getSideAllowableValues()

Gets allowable values of the enum


    public
                    getSideAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getStyle()

Gets style


    public
                    getStyle() : CompareLayerStyle|null

Return values

CompareLayerStyle|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

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

Return values

mixed —

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

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

#[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>

setActions()

Sets actions


    public
                    setActions(array<string, mixed>|null $actions) : self

Parameters

$actions : array<string, mixed>|null: The resolved BVL actions of the layer's objects, in the shape ExecuteBvl returns

Return values

self

setCategory()

Sets category


    public
                    setCategory(string|null $category) : self

Parameters

$category : string|null: category

Return values

self

setDefaultLeft()

Sets default_left


    public
                    setDefaultLeft(bool|null $default_left) : self

Parameters

$default_left : bool|null: The left objects of pairs without a left block of their own: hidden when both sides share one viewer, styled like their right objects side by side

Return values

self

setKind()

Sets kind


    public
                    setKind(string|null $kind) : self

Parameters

$kind : string|null: kind

Return values

self

setOids()

Sets oids


    public
                    setOids(array<string|int, int>|null $oids) : self

Parameters

$oids : array<string|int, int>|null: The object ids of the layer, on its side's Version

Return values

self

setOidsV()

Sets oids_v


    public
                    setOidsV(array<string|int, int>|null $oids_v) : self

Parameters

$oids_v : array<string|int, int>|null: A federation's side only. Aligned with oids, the index of each object's Version in vids

Return values

self

setSide()

Sets side


    public
                    setSide(string|null $side) : self

Parameters

$side : string|null: side

Return values

self

setStyle()

Sets style


    public
                    setStyle(CompareLayerStyle|null $style) : self

Parameters

$style : CompareLayerStyle|null: style

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>

CompareLayer in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

KIND_ADDED

KIND_CHANGED

KIND_IGNORED

KIND_OTHERS

KIND_REMOVED

KIND_UNCHANGED

SIDE_LEFT

SIDE_OTHERS

SIDE_RIGHT

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getActions()

Return values

getCategory()

Return values

getDefaultLeft()

Return values

getKind()

Return values

getKindAllowableValues()

Return values

getModelName()

Return values

getOids()

Return values

getOidsV()

Return values

getSide()

Return values

getSideAllowableValues()

Return values

getStyle()

Return values

getters()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

CompareLayer
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable