Documentation

Node
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Node 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

DISCRIMINATOR  = 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
getCreatedBy()  : string|null
Gets created_by
getCreatedOn()  : DateTime|null
Gets created_on
getErrors()  : array<string|int, Error>|null
Gets errors
getFolder()  : bool|null
Gets folder
getHasLoadableChildren()  : bool|null
Gets has_loadable_children
getInputFileType()  : InputFileType|null
Gets input_file_type
getLastVersion()  : Version|null
Gets last_version
getLastVersionNumber()  : float|null
Gets last_version_number
getLastVersionUuid()  : string|null
Gets last_version_uuid
getLevel()  : float|null
Gets level
getMetadata()  : object|null
Gets metadata
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getNonce()  : string|null
Gets nonce
getParentNodeUuid()  : string|null
Gets parent_node_uuid
getPath()  : string|null
Gets path
getProcessing()  : float|null
Gets processing
getProgress()  : float|null
Gets progress
getReadAccess()  : bool|null
Gets read_access
getRootNodeUuid()  : string|null
Gets root_node_uuid
getStatus()  : RecordStatus|null
Gets status
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTreeNodeStatus()  : NodeStatus|null
Gets tree_node_status
getType()  : NodeType|null
Gets type
getUserData()  : array<string, mixed>|null
Gets user_data
getUuid()  : string|null
Gets uuid
getVersions()  : array<string|int, Version>|null
Gets versions
getWriteAccess()  : bool|null
Gets write_access
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
setCreatedBy()  : self
Sets created_by
setCreatedOn()  : self
Sets created_on
setErrors()  : self
Sets errors
setFolder()  : self
Sets folder
setHasLoadableChildren()  : self
Sets has_loadable_children
setInputFileType()  : self
Sets input_file_type
setLastVersion()  : self
Sets last_version
setLastVersionNumber()  : self
Sets last_version_number
setLastVersionUuid()  : self
Sets last_version_uuid
setLevel()  : self
Sets level
setMetadata()  : self
Sets metadata
setName()  : self
Sets name
setNonce()  : self
Sets nonce
setParentNodeUuid()  : self
Sets parent_node_uuid
setPath()  : self
Sets path
setProcessing()  : self
Sets processing
setProgress()  : self
Sets progress
setReadAccess()  : self
Sets read_access
setRootNodeUuid()  : self
Sets root_node_uuid
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTreeNodeStatus()  : self
Sets tree_node_status
setType()  : self
Sets type
setUserData()  : self
Sets user_data
setUuid()  : self
Sets uuid
setVersions()  : self
Sets versions
setWriteAccess()  : self
Sets write_access
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

DISCRIMINATOR

public mixed DISCRIMINATOR = null

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 = ['uuid' => 'uuid', 'parent_node_uuid' => 'parent_node_uuid', 'has_loadable_children' => 'has_loadable_children', 'read_access' => 'read_access', 'write_access' => 'write_access', 'nonce' => 'nonce', 'name' => 'name', 'folder' => 'folder', 'path' => 'path', 'level' => 'level', 'root_node_uuid' => 'root_node_uuid', 'type' => 'type', 'metadata' => 'metadata', 'status' => 'status', 'last_version' => 'last_version', 'tree_node_status' => 'tree_node_status', 'last_version_uuid' => 'last_version_uuid', 'last_version_number' => 'last_version_number', 'progress' => 'progress', 'processing' => 'processing', 'created_by' => 'created_by', 'created_on' => 'created_on', 'versions' => 'versions', 'errors' => 'errors', 'input_file_type' => 'input_file_type', 'user_data' => 'user_data']

$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 = ['uuid' => 'getUuid', 'parent_node_uuid' => 'getParentNodeUuid', 'has_loadable_children' => 'getHasLoadableChildren', 'read_access' => 'getReadAccess', 'write_access' => 'getWriteAccess', 'nonce' => 'getNonce', 'name' => 'getName', 'folder' => 'getFolder', 'path' => 'getPath', 'level' => 'getLevel', 'root_node_uuid' => 'getRootNodeUuid', 'type' => 'getType', 'metadata' => 'getMetadata', 'status' => 'getStatus', 'last_version' => 'getLastVersion', 'tree_node_status' => 'getTreeNodeStatus', 'last_version_uuid' => 'getLastVersionUuid', 'last_version_number' => 'getLastVersionNumber', 'progress' => 'getProgress', 'processing' => 'getProcessing', 'created_by' => 'getCreatedBy', 'created_on' => 'getCreatedOn', 'versions' => 'getVersions', 'errors' => 'getErrors', 'input_file_type' => 'getInputFileType', 'user_data' => 'getUserData']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'parent_node_uuid' => 'uuid', 'has_loadable_children' => null, 'read_access' => null, 'write_access' => null, 'nonce' => null, 'name' => null, 'folder' => null, 'path' => null, 'level' => null, 'root_node_uuid' => 'UUID', 'type' => null, 'metadata' => null, 'status' => null, 'last_version' => null, 'tree_node_status' => null, 'last_version_uuid' => 'uuid', 'last_version_number' => null, 'progress' => null, 'processing' => null, 'created_by' => null, 'created_on' => 'date-time', 'versions' => null, 'errors' => null, 'input_file_type' => null, 'user_data' => 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 = 'Node'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'parent_node_uuid' => false, 'has_loadable_children' => false, 'read_access' => false, 'write_access' => false, 'nonce' => false, 'name' => false, 'folder' => false, 'path' => false, 'level' => false, 'root_node_uuid' => false, 'type' => false, 'metadata' => false, 'status' => false, 'last_version' => false, 'tree_node_status' => false, 'last_version_uuid' => false, 'last_version_number' => false, 'progress' => false, 'processing' => false, 'created_by' => false, 'created_on' => false, 'versions' => false, 'errors' => false, 'input_file_type' => false, 'user_data' => true]

$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 = ['uuid' => 'string', 'parent_node_uuid' => 'string', 'has_loadable_children' => 'bool', 'read_access' => 'bool', 'write_access' => 'bool', 'nonce' => 'string', 'name' => 'string', 'folder' => 'bool', 'path' => 'string', 'level' => 'float', 'root_node_uuid' => 'string', 'type' => '\BIMworks\Model\NodeType', 'metadata' => 'object', 'status' => '\BIMworks\Model\RecordStatus', 'last_version' => '\BIMworks\Model\Version', 'tree_node_status' => '\BIMworks\Model\NodeStatus', 'last_version_uuid' => 'string', 'last_version_number' => 'float', 'progress' => 'float', 'processing' => 'float', 'created_by' => 'string', 'created_on' => '\DateTime', 'versions' => '\BIMworks\Model\Version[]', 'errors' => '\BIMworks\Model\Error[]', 'input_file_type' => '\BIMworks\Model\InputFileType', 'user_data' => 'array<string,mixed>']

$setters

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

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'parent_node_uuid' => 'setParentNodeUuid', 'has_loadable_children' => 'setHasLoadableChildren', 'read_access' => 'setReadAccess', 'write_access' => 'setWriteAccess', 'nonce' => 'setNonce', 'name' => 'setName', 'folder' => 'setFolder', 'path' => 'setPath', 'level' => 'setLevel', 'root_node_uuid' => 'setRootNodeUuid', 'type' => 'setType', 'metadata' => 'setMetadata', 'status' => 'setStatus', 'last_version' => 'setLastVersion', 'tree_node_status' => 'setTreeNodeStatus', 'last_version_uuid' => 'setLastVersionUuid', 'last_version_number' => 'setLastVersionNumber', 'progress' => 'setProgress', 'processing' => 'setProcessing', 'created_by' => 'setCreatedBy', 'created_on' => 'setCreatedOn', 'versions' => 'setVersions', 'errors' => 'setErrors', 'input_file_type' => 'setInputFileType', 'user_data' => 'setUserData']

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>

getCreatedBy()

Gets created_by

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

getCreatedOn()

Gets created_on

public getCreatedOn() : DateTime|null
Return values
DateTime|null

getErrors()

Gets errors

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

getFolder()

Gets folder

public getFolder() : bool|null
Return values
bool|null

getHasLoadableChildren()

Gets has_loadable_children

public getHasLoadableChildren() : bool|null
Return values
bool|null

getLastVersion()

Gets last_version

public getLastVersion() : Version|null
Return values
Version|null

getLastVersionNumber()

Gets last_version_number

public getLastVersionNumber() : float|null
Return values
float|null

getLastVersionUuid()

Gets last_version_uuid

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

getLevel()

Gets level

public getLevel() : float|null
Return values
float|null

getMetadata()

Gets metadata

public getMetadata() : object|null
Return values
object|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

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

getNonce()

Gets nonce

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

getParentNodeUuid()

Gets parent_node_uuid

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

getPath()

Gets path

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

getProcessing()

Gets processing

public getProcessing() : float|null
Return values
float|null

getProgress()

Gets progress

public getProgress() : float|null
Return values
float|null

getReadAccess()

Gets read_access

public getReadAccess() : bool|null
Return values
bool|null

getRootNodeUuid()

Gets root_node_uuid

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

getUserData()

Gets user_data

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

getUuid()

Gets uuid

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

getVersions()

Gets versions

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

getWriteAccess()

Gets write_access

public getWriteAccess() : bool|null
Return values
bool|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

jsonSerialize()

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

public jsonSerialize() : mixed
Tags
link
https://www.php.net/manual/en/jsonserializable.jsonserialize.php
Attributes
#[ReturnTypeWillChange]
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

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>

setCreatedBy()

Sets created_by

public setCreatedBy(string|null $created_by) : self
Parameters
$created_by : string|null

Username of the user that created this Node

Return values
self

setCreatedOn()

Sets created_on

public setCreatedOn(DateTime|null $created_on) : self
Parameters
$created_on : DateTime|null

created_on

Return values
self

setErrors()

Sets errors

public setErrors(array<string|int, Error>|null $errors) : self
Parameters
$errors : array<string|int, Error>|null

errors

Return values
self

setFolder()

Sets folder

public setFolder(bool|null $folder) : self
Parameters
$folder : bool|null

Whether this Node is a folder or not

Return values
self

setHasLoadableChildren()

Sets has_loadable_children

public setHasLoadableChildren(bool|null $has_loadable_children) : self
Parameters
$has_loadable_children : bool|null

Whether this Node has children that can be loaded (can be used UI purposes)

Return values
self

setInputFileType()

Sets input_file_type

public setInputFileType(InputFileType|null $input_file_type) : self
Parameters
$input_file_type : InputFileType|null

input_file_type

Return values
self

setLastVersion()

Sets last_version

public setLastVersion(Version|null $last_version) : self
Parameters
$last_version : Version|null

last_version

Return values
self

setLastVersionNumber()

Sets last_version_number

public setLastVersionNumber(float|null $last_version_number) : self
Parameters
$last_version_number : float|null

The last version number (incremental id)

Return values
self

setLastVersionUuid()

Sets last_version_uuid

public setLastVersionUuid(string|null $last_version_uuid) : self
Parameters
$last_version_uuid : string|null

UUID of the latest Version, can be null for Nodes without active Versions

Return values
self

setLevel()

Sets level

public setLevel(float|null $level) : self
Parameters
$level : float|null

The current level of this Node, indicating the depth of this Node compared to the Root Node

Return values
self

setMetadata()

Sets metadata

public setMetadata(object|null $metadata) : self
Parameters
$metadata : object|null

Additional information for viewers

Return values
self

setName()

Sets name

public setName(string|null $name) : self
Parameters
$name : string|null

The name of this Node

Return values
self

setNonce()

Sets nonce

public setNonce(string|null $nonce) : self
Parameters
$nonce : string|null

Currently not used

Return values
self

setParentNodeUuid()

Sets parent_node_uuid

public setParentNodeUuid(string|null $parent_node_uuid) : self
Parameters
$parent_node_uuid : string|null

The UUID of the parent Node, can be null

Return values
self

setPath()

Sets path

public setPath(string|null $path) : self
Parameters
$path : string|null

The full path of this Node from the current Root Node

Return values
self

setProcessing()

Sets processing

public setProcessing(float|null $processing) : self
Parameters
$processing : float|null

Indication of the number of uploads currently being processed on this Node and all sub nodes

Return values
self

setProgress()

Sets progress

public setProgress(float|null $progress) : self
Parameters
$progress : float|null

The current progress on this Node, for example when there is an upload active. A percentage between 0-100 inclusive

Return values
self

setReadAccess()

Sets read_access

public setReadAccess(bool|null $read_access) : self
Parameters
$read_access : bool|null

Whether the current Token has read access to this Node

Return values
self

setRootNodeUuid()

Sets root_node_uuid

public setRootNodeUuid(string|null $root_node_uuid) : self
Parameters
$root_node_uuid : string|null

The UUID of the current Root Node of the used Token

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>

setTreeNodeStatus()

Sets tree_node_status

public setTreeNodeStatus(NodeStatus|null $tree_node_status) : self
Parameters
$tree_node_status : NodeStatus|null

tree_node_status

Return values
self

setType()

Sets type

public setType(NodeType|null $type) : self
Parameters
$type : NodeType|null

The type of this Node

Return values
self

setUserData()

Sets user_data

public setUserData(array<string, mixed>|null $user_data) : self
Parameters
$user_data : array<string, mixed>|null

user_data

Return values
self

setUuid()

Sets uuid

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

The UUID of this Node

Return values
self

setVersions()

Sets versions

public setVersions(array<string|int, Version>|null $versions) : self
Parameters
$versions : array<string|int, Version>|null

versions

Return values
self

setWriteAccess()

Sets write_access

public setWriteAccess(bool|null $write_access) : self
Parameters
$write_access : bool|null

Whether the current Token has write access to this Node

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