Documentation

Workspace
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Workspace 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  : mixed = null
RECORD_STATUS_ACTIVE  : mixed = 'ACTIVE'
RECORD_STATUS_DELETED  : mixed = 'DELETED'

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
getActive()  : bool|null
Gets active
getChildren()  : array<string|int, Workspace>|null
Gets children
getCreatedBy()  : string|null
Gets created_by
getCreatedOn()  : string|null
Gets created_on
getEffectiveRootNode()  : string|null
Gets effective_root_node
getFilter()  : string|null
Gets filter
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getParentWorkspaceUuid()  : string|null
Gets parent_workspace_uuid
getPublishUuid()  : string|null
Gets publish_uuid
getRecordStatus()  : string|null
Gets record_status
getRecordStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getScopes()  : array<string|int, string>|null
Gets scopes
getSettings()  : array<string, mixed>|null
Gets settings
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUuid()  : string|null
Gets uuid
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
setActive()  : self
Sets active
setChildren()  : self
Sets children
setCreatedBy()  : self
Sets created_by
setCreatedOn()  : self
Sets created_on
setEffectiveRootNode()  : self
Sets effective_root_node
setFilter()  : self
Sets filter
setName()  : self
Sets name
setParentWorkspaceUuid()  : self
Sets parent_workspace_uuid
setPublishUuid()  : self
Sets publish_uuid
setRecordStatus()  : self
Sets record_status
setScopes()  : self
Sets scopes
setSettings()  : self
Sets settings
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUuid()  : self
Sets uuid
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

RECORD_STATUS_ACTIVE

public mixed RECORD_STATUS_ACTIVE = 'ACTIVE'

RECORD_STATUS_DELETED

public mixed RECORD_STATUS_DELETED = 'DELETED'

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', 'name' => 'name', 'created_by' => 'created_by', 'created_on' => 'created_on', 'record_status' => 'record_status', 'parent_workspace_uuid' => 'parent_workspace_uuid', 'publish_uuid' => 'publish_uuid', 'filter' => 'filter', 'scopes' => 'scopes', 'settings' => 'settings', 'effective_root_node' => 'effective_root_node', 'active' => 'active', 'children' => 'children']

$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', 'name' => 'getName', 'created_by' => 'getCreatedBy', 'created_on' => 'getCreatedOn', 'record_status' => 'getRecordStatus', 'parent_workspace_uuid' => 'getParentWorkspaceUuid', 'publish_uuid' => 'getPublishUuid', 'filter' => 'getFilter', 'scopes' => 'getScopes', 'settings' => 'getSettings', 'effective_root_node' => 'getEffectiveRootNode', 'active' => 'getActive', 'children' => 'getChildren']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'name' => null, 'created_by' => null, 'created_on' => null, 'record_status' => null, 'parent_workspace_uuid' => 'uuid', 'publish_uuid' => 'uuid', 'filter' => null, 'scopes' => null, 'settings' => null, 'effective_root_node' => 'uuid', 'active' => null, 'children' => 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 = 'Workspace'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'name' => false, 'created_by' => false, 'created_on' => false, 'record_status' => false, 'parent_workspace_uuid' => true, 'publish_uuid' => true, 'filter' => true, 'scopes' => true, 'settings' => false, 'effective_root_node' => true, 'active' => false, 'children' => 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 = ['uuid' => 'string', 'name' => 'string', 'created_by' => 'string', 'created_on' => 'string', 'record_status' => 'string', 'parent_workspace_uuid' => 'string', 'publish_uuid' => 'string', 'filter' => 'string', 'scopes' => 'string[]', 'settings' => 'array<string,mixed>', 'effective_root_node' => 'string', 'active' => 'bool', 'children' => '\BIMworks\Model\Workspace[]']

$setters

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

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'name' => 'setName', 'created_by' => 'setCreatedBy', 'created_on' => 'setCreatedOn', 'record_status' => 'setRecordStatus', 'parent_workspace_uuid' => 'setParentWorkspaceUuid', 'publish_uuid' => 'setPublishUuid', 'filter' => 'setFilter', 'scopes' => 'setScopes', 'settings' => 'setSettings', 'effective_root_node' => 'setEffectiveRootNode', 'active' => 'setActive', 'children' => 'setChildren']

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>

getActive()

Gets active

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

getCreatedBy()

Gets created_by

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

getCreatedOn()

Gets created_on

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

getEffectiveRootNode()

Gets effective_root_node

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

getFilter()

Gets filter

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

getParentWorkspaceUuid()

Gets parent_workspace_uuid

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

getPublishUuid()

Gets publish_uuid

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

getRecordStatus()

Gets record_status

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

getRecordStatusAllowableValues()

Gets allowable values of the enum

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

getScopes()

Gets scopes

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

getSettings()

Gets settings

public getSettings() : 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>

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

setActive()

Sets active

public setActive(bool|null $active) : self
Parameters
$active : bool|null

active

Return values
self

setChildren()

Sets children

public setChildren(array<string|int, Workspace>|null $children) : self
Parameters
$children : array<string|int, Workspace>|null

children

Return values
self

setCreatedBy()

Sets created_by

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

created_by

Return values
self

setCreatedOn()

Sets created_on

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

created_on

Return values
self

setEffectiveRootNode()

Sets effective_root_node

public setEffectiveRootNode(string|null $effective_root_node) : self
Parameters
$effective_root_node : string|null

effective_root_node

Return values
self

setFilter()

Sets filter

public setFilter(string|null $filter) : self
Parameters
$filter : string|null

filter

Return values
self

setName()

Sets name

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

name

Return values
self

setParentWorkspaceUuid()

Sets parent_workspace_uuid

public setParentWorkspaceUuid(string|null $parent_workspace_uuid) : self
Parameters
$parent_workspace_uuid : string|null

parent_workspace_uuid

Return values
self

setPublishUuid()

Sets publish_uuid

public setPublishUuid(string|null $publish_uuid) : self
Parameters
$publish_uuid : string|null

The share link, when published

Return values
self

setRecordStatus()

Sets record_status

public setRecordStatus(string|null $record_status) : self
Parameters
$record_status : string|null

record_status

Return values
self

setScopes()

Sets scopes

public setScopes(array<string|int, string>|null $scopes) : self
Parameters
$scopes : array<string|int, string>|null

scopes

Return values
self

setSettings()

Sets settings

public setSettings(array<string, mixed>|null $settings) : self
Parameters
$settings : array<string, mixed>|null

settings

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>

setUuid()

Sets uuid

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

uuid

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