Documentation

ReplaceLinkedDataResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

ReplaceLinkedDataResult Class Doc Comment

Tags
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
getDeleted()  : bool|null
Gets deleted
getEnded()  : array<string|int, string>|null
Gets ended
getItem()  : LinkedDataItem|null
Gets item
getLinks()  : array<string|int, LinkedDataLink>|null
Gets links
getModelName()  : string
The original name of the model.
getters()  : array<string, string>
Array of attributes to getter functions (for serialization of requests)
getUnlinked()  : array<string|int, string>|null
Gets unlinked
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
setDeleted()  : $this
Sets deleted
setEnded()  : $this
Sets ended
setItem()  : $this
Sets item
setLinks()  : $this
Sets links
setters()  : array<string, string>
Array of attributes to setter functions (for deserialization of responses)
setUnlinked()  : $this
Sets unlinked
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 = ['item' => 'item', 'links' => 'links', 'ended' => 'ended', 'unlinked' => 'unlinked', 'deleted' => 'deleted']

$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 = ['item' => 'getItem', 'links' => 'getLinks', 'ended' => 'getEnded', 'unlinked' => 'getUnlinked', 'deleted' => 'getDeleted']

$openAPIFormats

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

protected static array<string, string|null> $openAPIFormats = ['item' => null, 'links' => null, 'ended' => 'uuid', 'unlinked' => 'uuid', 'deleted' => null]

$openAPIModelName

The original name of the model.

protected static string $openAPIModelName = 'ReplaceLinkedDataResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string, bool> $openAPINullables = ['item' => false, 'links' => false, 'ended' => false, 'unlinked' => false, 'deleted' => 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 = ['item' => '\BIMworks\Model\LinkedDataItem', 'links' => '\BIMworks\Model\LinkedDataLink[]', 'ended' => 'string[]', 'unlinked' => 'string[]', 'deleted' => 'bool']

$setters

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

protected static array<string, string> $setters = ['item' => 'setItem', 'links' => 'setLinks', 'ended' => 'setEnded', 'unlinked' => 'setUnlinked', 'deleted' => 'setDeleted']

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>

getEnded()

Gets ended

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

getters()

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

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

getUnlinked()

Gets unlinked

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

setDeleted()

Sets deleted

public setDeleted(bool|null $deleted) : $this
Parameters
$deleted : bool|null

The old item was on that Version only and is deleted (restorable)

Return values
$this

setEnded()

Sets ended

public setEnded(array<string|int, string>|null $ended) : $this
Parameters
$ended : array<string|int, string>|null

The old item's links ended from that Version (the older Versions keep them)

Return values
$this

Sets links

public setLinks(array<string|int, LinkedDataLink>|null $links) : $this
Parameters
$links : array<string|int, LinkedDataLink>|null

The new item's links, on the objects the old one is on from that Version

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>

setUnlinked()

Sets unlinked

public setUnlinked(array<string|int, string>|null $unlinked) : $this
Parameters
$unlinked : array<string|int, string>|null

The old item's links made on that very Version, taken off

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