Documentation

LinkedDataLink
in package
implements ModelInterface, ArrayAccess, JsonSerializable

LinkedDataLink Class Doc Comment

Tags
description

One item on one object of a model. The fields after `deleted_by` describe it on the Version listed (ListLinkedData, LinkData) or give its trail (`anchors`, GetLinkedData and the calls that change a link)

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, 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, string>
Array of attributes to getter functions (for serialization of requests)
$openAPIFormats  : array<string, string|null>
Array of property to format mappings. Used for (de)serialization
$openAPIModelName  : string
The original name of the model.
$openAPINullables  : array<string, bool>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string, bool>
If a nullable field gets set to null, insert it here
$openAPITypes  : array<string, string>
Array of property to type mappings. Used for (de)serialization
$setters  : array<string, 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, string>
Array of attributes where the key is the local name, and the value is the original name
getAnchors()  : array<string|int, LinkedDataAnchor>|null
Gets anchors
getAnchorUuid()  : string|null
Gets anchor_uuid
getBackwardThroughVersion()  : int|null
Gets backward_through_version
getCandidates()  : array<string|int, int>|null
Gets candidates
getClient()  : string|null
Gets client
getCopiedFromLinkUuid()  : string|null
Gets copied_from_link_uuid
getDeletedBy()  : string|null
Gets deleted_by
getDeletedOn()  : string|null
Gets deleted_on
getDirection()  : LinkedDataAnchorDirection|null
Gets direction
getEndedBy()  : string|null
Gets ended_by
getEndedFromVersion()  : int|null
Gets ended_from_version
getEndedFromVersionUuid()  : string|null
Gets ended_from_version_uuid
getEndedOn()  : string|null
Gets ended_on
getFirstVersion()  : int|null
Gets first_version
getFirstVersionUuid()  : string|null
Gets first_version_uuid
getGlobalId()  : string|null
Gets global_id
getHow()  : LinkedDataAnchorHow|null
Gets how
getIfcType()  : string|null
Gets ifc_type
getItemUuid()  : string|null
Gets item_uuid
getLinkedBy()  : string|null
Gets linked_by
getLinkedOn()  : string|null
Gets linked_on
getModelName()  : string
The original name of the model.
getNodeName()  : string|null
Gets node_name
getNodeUuid()  : string|null
Gets node_uuid
getObjectBefore()  : LinkedDataObject|null
Gets object_before
getObjectHere()  : LinkedDataObject|null
Gets object_here
getObjectName()  : string|null
Gets object_name
getOid()  : int|null
Gets oid
getOidHere()  : int|null
Gets oid_here
getSpanFirstVersion()  : int|null
Gets span_first_version
getState()  : LinkedDataAnchorState|null
Gets state
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getUuid()  : string|null
Gets uuid
getVia()  : LinkedDataVia|null
Gets via
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, string>
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, string|null>
Array of property to format mappings. Used for (de)serialization
openAPITypes()  : array<string, string>
Array of property to type mappings. Used for (de)serialization
setAnchors()  : $this
Sets anchors
setAnchorUuid()  : $this
Sets anchor_uuid
setBackwardThroughVersion()  : $this
Sets backward_through_version
setCandidates()  : $this
Sets candidates
setClient()  : $this
Sets client
setCopiedFromLinkUuid()  : $this
Sets copied_from_link_uuid
setDeletedBy()  : $this
Sets deleted_by
setDeletedOn()  : $this
Sets deleted_on
setDirection()  : $this
Sets direction
setEndedBy()  : $this
Sets ended_by
setEndedFromVersion()  : $this
Sets ended_from_version
setEndedFromVersionUuid()  : $this
Sets ended_from_version_uuid
setEndedOn()  : $this
Sets ended_on
setFirstVersion()  : $this
Sets first_version
setFirstVersionUuid()  : $this
Sets first_version_uuid
setGlobalId()  : $this
Sets global_id
setHow()  : $this
Sets how
setIfcType()  : $this
Sets ifc_type
setItemUuid()  : $this
Sets item_uuid
setLinkedBy()  : $this
Sets linked_by
setLinkedOn()  : $this
Sets linked_on
setNodeName()  : $this
Sets node_name
setNodeUuid()  : $this
Sets node_uuid
setObjectBefore()  : $this
Sets object_before
setObjectHere()  : $this
Sets object_here
setObjectName()  : $this
Sets object_name
setOid()  : $this
Sets oid
setOidHere()  : $this
Sets oid_here
setSpanFirstVersion()  : $this
Sets span_first_version
setState()  : $this
Sets state
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setUuid()  : $this
Sets uuid
setVia()  : $this
Sets via
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, bool>
Array of nullable properties
fillIfExists()  : 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
getOpenAPINullablesSetToNull()  : array<string, bool>
Array of nullable field names deliberately set to null
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, string> $attributeMap = ['uuid' => 'uuid', 'item_uuid' => 'item_uuid', 'node_uuid' => 'node_uuid', 'first_version_uuid' => 'first_version_uuid', 'first_version' => 'first_version', 'oid' => 'oid', 'global_id' => 'global_id', 'ifc_type' => 'ifc_type', 'object_name' => 'object_name', 'ended_from_version_uuid' => 'ended_from_version_uuid', 'ended_from_version' => 'ended_from_version', 'ended_on' => 'ended_on', 'ended_by' => 'ended_by', 'backward_through_version' => 'backward_through_version', 'copied_from_link_uuid' => 'copied_from_link_uuid', 'linked_on' => 'linked_on', 'linked_by' => 'linked_by', 'via' => 'via', 'client' => 'client', 'deleted_on' => 'deleted_on', 'deleted_by' => 'deleted_by', 'anchor_uuid' => 'anchor_uuid', 'oid_here' => 'oid_here', 'how' => 'how', 'state' => 'state', 'direction' => 'direction', 'span_first_version' => 'span_first_version', 'candidates' => 'candidates', 'object_here' => 'object_here', 'object_before' => 'object_before', 'node_name' => 'node_name', 'anchors' => 'anchors']

$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, string> $getters = ['uuid' => 'getUuid', 'item_uuid' => 'getItemUuid', 'node_uuid' => 'getNodeUuid', 'first_version_uuid' => 'getFirstVersionUuid', 'first_version' => 'getFirstVersion', 'oid' => 'getOid', 'global_id' => 'getGlobalId', 'ifc_type' => 'getIfcType', 'object_name' => 'getObjectName', 'ended_from_version_uuid' => 'getEndedFromVersionUuid', 'ended_from_version' => 'getEndedFromVersion', 'ended_on' => 'getEndedOn', 'ended_by' => 'getEndedBy', 'backward_through_version' => 'getBackwardThroughVersion', 'copied_from_link_uuid' => 'getCopiedFromLinkUuid', 'linked_on' => 'getLinkedOn', 'linked_by' => 'getLinkedBy', 'via' => 'getVia', 'client' => 'getClient', 'deleted_on' => 'getDeletedOn', 'deleted_by' => 'getDeletedBy', 'anchor_uuid' => 'getAnchorUuid', 'oid_here' => 'getOidHere', 'how' => 'getHow', 'state' => 'getState', 'direction' => 'getDirection', 'span_first_version' => 'getSpanFirstVersion', 'candidates' => 'getCandidates', 'object_here' => 'getObjectHere', 'object_before' => 'getObjectBefore', 'node_name' => 'getNodeName', 'anchors' => 'getAnchors']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['uuid' => 'uuid', 'item_uuid' => 'uuid', 'node_uuid' => 'uuid', 'first_version_uuid' => 'uuid', 'first_version' => null, 'oid' => null, 'global_id' => null, 'ifc_type' => null, 'object_name' => null, 'ended_from_version_uuid' => 'uuid', 'ended_from_version' => null, 'ended_on' => null, 'ended_by' => null, 'backward_through_version' => null, 'copied_from_link_uuid' => 'uuid', 'linked_on' => null, 'linked_by' => null, 'via' => null, 'client' => null, 'deleted_on' => null, 'deleted_by' => null, 'anchor_uuid' => 'uuid', 'oid_here' => null, 'how' => null, 'state' => null, 'direction' => null, 'span_first_version' => null, 'candidates' => null, 'object_here' => null, 'object_before' => null, 'node_name' => null, 'anchors' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'LinkedDataLink'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['uuid' => false, 'item_uuid' => false, 'node_uuid' => false, 'first_version_uuid' => false, 'first_version' => false, 'oid' => false, 'global_id' => false, 'ifc_type' => false, 'object_name' => false, 'ended_from_version_uuid' => false, 'ended_from_version' => false, 'ended_on' => false, 'ended_by' => false, 'backward_through_version' => false, 'copied_from_link_uuid' => false, 'linked_on' => false, 'linked_by' => false, 'via' => false, 'client' => false, 'deleted_on' => false, 'deleted_by' => false, 'anchor_uuid' => false, 'oid_here' => false, 'how' => false, 'state' => false, 'direction' => false, 'span_first_version' => false, 'candidates' => false, 'object_here' => false, 'object_before' => false, 'node_name' => false, 'anchors' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string, bool> $openAPINullablesSetToNull = []

$openAPITypes

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

protected static array<string, string> $openAPITypes = ['uuid' => 'string', 'item_uuid' => 'string', 'node_uuid' => 'string', 'first_version_uuid' => 'string', 'first_version' => 'int', 'oid' => 'int', 'global_id' => 'string', 'ifc_type' => 'string', 'object_name' => 'string', 'ended_from_version_uuid' => 'string', 'ended_from_version' => 'int', 'ended_on' => 'string', 'ended_by' => 'string', 'backward_through_version' => 'int', 'copied_from_link_uuid' => 'string', 'linked_on' => 'string', 'linked_by' => 'string', 'via' => '\BIMworks\Model\LinkedDataVia', 'client' => 'string', 'deleted_on' => 'string', 'deleted_by' => 'string', 'anchor_uuid' => 'string', 'oid_here' => 'int', 'how' => '\BIMworks\Model\LinkedDataAnchorHow', 'state' => '\BIMworks\Model\LinkedDataAnchorState', 'direction' => '\BIMworks\Model\LinkedDataAnchorDirection', 'span_first_version' => 'int', 'candidates' => 'int[]', 'object_here' => '\BIMworks\Model\LinkedDataObject', 'object_before' => '\BIMworks\Model\LinkedDataObject', 'node_name' => 'string', 'anchors' => '\BIMworks\Model\LinkedDataAnchor[]']

$setters

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

protected static array<string, string> $setters = ['uuid' => 'setUuid', 'item_uuid' => 'setItemUuid', 'node_uuid' => 'setNodeUuid', 'first_version_uuid' => 'setFirstVersionUuid', 'first_version' => 'setFirstVersion', 'oid' => 'setOid', 'global_id' => 'setGlobalId', 'ifc_type' => 'setIfcType', 'object_name' => 'setObjectName', 'ended_from_version_uuid' => 'setEndedFromVersionUuid', 'ended_from_version' => 'setEndedFromVersion', 'ended_on' => 'setEndedOn', 'ended_by' => 'setEndedBy', 'backward_through_version' => 'setBackwardThroughVersion', 'copied_from_link_uuid' => 'setCopiedFromLinkUuid', 'linked_on' => 'setLinkedOn', 'linked_by' => 'setLinkedBy', 'via' => 'setVia', 'client' => 'setClient', 'deleted_on' => 'setDeletedOn', 'deleted_by' => 'setDeletedBy', 'anchor_uuid' => 'setAnchorUuid', 'oid_here' => 'setOidHere', 'how' => 'setHow', 'state' => 'setState', 'direction' => 'setDirection', 'span_first_version' => 'setSpanFirstVersion', 'candidates' => 'setCandidates', 'object_here' => 'setObjectHere', 'object_before' => 'setObjectBefore', 'node_name' => 'setNodeName', 'anchors' => 'setAnchors']

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = 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, string>
Return values
array<string, string>

getAnchorUuid()

Gets anchor_uuid

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

getBackwardThroughVersion()

Gets backward_through_version

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

getCandidates()

Gets candidates

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

getClient()

Gets client

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

getCopiedFromLinkUuid()

Gets copied_from_link_uuid

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

getDeletedBy()

Gets deleted_by

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

getDeletedOn()

Gets deleted_on

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

getEndedBy()

Gets ended_by

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

getEndedFromVersion()

Gets ended_from_version

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

getEndedFromVersionUuid()

Gets ended_from_version_uuid

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

getEndedOn()

Gets ended_on

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

getFirstVersion()

Gets first_version

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

getFirstVersionUuid()

Gets first_version_uuid

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

getGlobalId()

Gets global_id

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

getIfcType()

Gets ifc_type

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

getItemUuid()

Gets item_uuid

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

getLinkedBy()

Gets linked_by

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

getLinkedOn()

Gets linked_on

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNodeName()

Gets node_name

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

getNodeUuid()

Gets node_uuid

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

getObjectName()

Gets object_name

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

getOid()

Gets oid

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

getOidHere()

Gets oid_here

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

getSpanFirstVersion()

Gets span_first_version

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

getters()

Array of attributes to getter functions (for serialization of requests)

public static getters() : array<string, string>
Return values
array<string, string>

getUuid()

Gets uuid

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

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|string|null $offset, mixed $value) : void
Parameters
$offset : int|string|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, string|null>
Return values
array<string, string|null>

openAPITypes()

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

public static openAPITypes() : array<string, string>
Return values
array<string, string>

setAnchors()

Sets anchors

public setAnchors(array<string|int, LinkedDataAnchor>|null $anchors) : $this
Parameters
$anchors : array<string|int, LinkedDataAnchor>|null

The spans, forward ones first, each oldest first

Return values
$this

setAnchorUuid()

Sets anchor_uuid

public setAnchorUuid(string|null $anchor_uuid) : $this
Parameters
$anchor_uuid : string|null

The span the link is on, on the Version listed

Return values
$this

setBackwardThroughVersion()

Sets backward_through_version

public setBackwardThroughVersion(int|null $backward_through_version) : $this
Parameters
$backward_through_version : int|null

How far down the backward follow took the link; 0 when it found nothing further down

Return values
$this

setCandidates()

Sets candidates

public setCandidates(array<string|int, int>|null $candidates) : $this
Parameters
$candidates : array<string|int, int>|null

candidates

Return values
$this

setClient()

Sets client

public setClient(string|null $client) : $this
Parameters
$client : string|null

client

Return values
$this

setCopiedFromLinkUuid()

Sets copied_from_link_uuid

public setCopiedFromLinkUuid(string|null $copied_from_link_uuid) : $this
Parameters
$copied_from_link_uuid : string|null

copied_from_link_uuid

Return values
$this

setDeletedBy()

Sets deleted_by

public setDeletedBy(string|null $deleted_by) : $this
Parameters
$deleted_by : string|null

deleted_by

Return values
$this

setDeletedOn()

Sets deleted_on

public setDeletedOn(string|null $deleted_on) : $this
Parameters
$deleted_on : string|null

deleted_on

Return values
$this

setEndedBy()

Sets ended_by

public setEndedBy(string|null $ended_by) : $this
Parameters
$ended_by : string|null

ended_by

Return values
$this

setEndedFromVersion()

Sets ended_from_version

public setEndedFromVersion(int|null $ended_from_version) : $this
Parameters
$ended_from_version : int|null

ended_from_version

Return values
$this

setEndedFromVersionUuid()

Sets ended_from_version_uuid

public setEndedFromVersionUuid(string|null $ended_from_version_uuid) : $this
Parameters
$ended_from_version_uuid : string|null

ended_from_version_uuid

Return values
$this

setEndedOn()

Sets ended_on

public setEndedOn(string|null $ended_on) : $this
Parameters
$ended_on : string|null

ended_on

Return values
$this

setFirstVersion()

Sets first_version

public setFirstVersion(int|null $first_version) : $this
Parameters
$first_version : int|null

first_version

Return values
$this

setFirstVersionUuid()

Sets first_version_uuid

public setFirstVersionUuid(string|null $first_version_uuid) : $this
Parameters
$first_version_uuid : string|null

The Version the link was made on

Return values
$this

setGlobalId()

Sets global_id

public setGlobalId(string|null $global_id) : $this
Parameters
$global_id : string|null

The GlobalId the link follows

Return values
$this

setIfcType()

Sets ifc_type

public setIfcType(string|null $ifc_type) : $this
Parameters
$ifc_type : string|null

ifc_type

Return values
$this

setItemUuid()

Sets item_uuid

public setItemUuid(string|null $item_uuid) : $this
Parameters
$item_uuid : string|null

item_uuid

Return values
$this

setLinkedBy()

Sets linked_by

public setLinkedBy(string|null $linked_by) : $this
Parameters
$linked_by : string|null

linked_by

Return values
$this

setLinkedOn()

Sets linked_on

public setLinkedOn(string|null $linked_on) : $this
Parameters
$linked_on : string|null

linked_on

Return values
$this

setNodeName()

Sets node_name

public setNodeName(string|null $node_name) : $this
Parameters
$node_name : string|null

node_name

Return values
$this

setNodeUuid()

Sets node_uuid

public setNodeUuid(string|null $node_uuid) : $this
Parameters
$node_uuid : string|null

node_uuid

Return values
$this

setObjectName()

Sets object_name

public setObjectName(string|null $object_name) : $this
Parameters
$object_name : string|null

object_name

Return values
$this

setOid()

Sets oid

public setOid(int|null $oid) : $this
Parameters
$oid : int|null

The object the link was made on, on its first Version

Return values
$this

setOidHere()

Sets oid_here

public setOidHere(int|null $oid_here) : $this
Parameters
$oid_here : int|null

The object on the Version listed; absent when orphaned

Return values
$this

setSpanFirstVersion()

Sets span_first_version

public setSpanFirstVersion(int|null $span_first_version) : $this
Parameters
$span_first_version : int|null

Since which Version the link is where it is

Return values
$this

setters()

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

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

setUuid()

Sets uuid

public setUuid(string|null $uuid) : $this
Parameters
$uuid : string|null

uuid

Return values
$this

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, bool>
Return values
array<string, bool>

fillIfExists()

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 fillIfExists(string $variableName, array<string|int, mixed> $fields, mixed $defaultValue) : void
Parameters
$variableName : string
$fields : array<string|int, mixed>
$defaultValue : mixed

getOpenAPINullablesSetToNull()

Array of nullable field names deliberately set to null

private getOpenAPINullablesSetToNull() : array<string, bool>
Return values
array<string, bool>

setOpenAPINullablesSetToNull()

Setter - Array of nullable field names deliberately set to null

private setOpenAPINullablesSetToNull(array<string, bool> $openAPINullablesSetToNull) : void
Parameters
$openAPINullablesSetToNull : array<string, bool>
On this page

Search results