Documentation

CommitTransactionResult
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CommitTransactionResult Class Doc Comment

Tags
category

Class

description

The result of CommitTransaction. Which fields are present depends on the mode: a commit returns `transaction` and `node`; a dry run returns `updates`, `is_head` and (only when the Version is not the head) `head_version`

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|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
getHeadVersion()  : int|null
Gets head_version
getIsHead()  : bool|null
Gets is_head
getModelName()  : string
The original name of the model.
getNextVersion()  : int|null
Gets next_version
getNode()  : Node|null
Gets node
getOidsTruncated()  : bool|null
Gets oids_truncated
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTransaction()  : CommittedTransaction|null
Gets transaction
getUpdates()  : array<string|int, TransactionUpdate>|null
Gets updates
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
setHeadVersion()  : self
Sets head_version
setIsHead()  : self
Sets is_head
setNextVersion()  : self
Sets next_version
setNode()  : self
Sets node
setOidsTruncated()  : self
Sets oids_truncated
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTransaction()  : self
Sets transaction
setUpdates()  : self
Sets updates
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

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 = ['transaction' => 'transaction', 'node' => 'node', 'updates' => 'updates', 'is_head' => 'is_head', 'head_version' => 'head_version', 'next_version' => 'next_version', 'oids_truncated' => 'oids_truncated']

$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 = ['transaction' => 'getTransaction', 'node' => 'getNode', 'updates' => 'getUpdates', 'is_head' => 'getIsHead', 'head_version' => 'getHeadVersion', 'next_version' => 'getNextVersion', 'oids_truncated' => 'getOidsTruncated']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['transaction' => null, 'node' => null, 'updates' => null, 'is_head' => null, 'head_version' => null, 'next_version' => null, 'oids_truncated' => 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 = 'CommitTransactionResult'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['transaction' => false, 'node' => false, 'updates' => false, 'is_head' => false, 'head_version' => false, 'next_version' => false, 'oids_truncated' => 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 = ['transaction' => '\BIMworks\Model\CommittedTransaction', 'node' => '\BIMworks\Model\Node', 'updates' => '\BIMworks\Model\TransactionUpdate[]', 'is_head' => 'bool', 'head_version' => 'int', 'next_version' => 'int', 'oids_truncated' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['transaction' => 'setTransaction', 'node' => 'setNode', 'updates' => 'setUpdates', 'is_head' => 'setIsHead', 'head_version' => 'setHeadVersion', 'next_version' => 'setNextVersion', 'oids_truncated' => 'setOidsTruncated']

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>

getOidsTruncated()

Gets oids_truncated

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

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>

setHeadVersion()

Sets head_version

public setHeadVersion(int|null $head_version) : self
Parameters
$head_version : int|null

Dry run only, and only when the given Version is not the head. The version number of the current head

Return values
self

setIsHead()

Sets is_head

public setIsHead(bool|null $is_head) : self
Parameters
$is_head : bool|null

Dry run only. Whether the given Version is the head of its Node — a commit is only accepted against the head

Return values
self

setNextVersion()

Sets next_version

public setNextVersion(int|null $next_version) : self
Parameters
$next_version : int|null

Dry run only, and only when the given Version is the head. The version number a commit would create (the head's number plus one)

Return values
self

setNode()

Sets node

public setNode(Node|null $node) : self
Parameters
$node : Node|null

Commit only. The full Node, including the new Version

Return values
self

setOidsTruncated()

Sets oids_truncated

public setOidsTruncated(bool|null $oids_truncated) : self
Parameters
$oids_truncated : bool|null

Dry run with include_oids only, and only when true. The updates name more objects than the server-side cap, so matched_oids and changed_oids are left out (the counts are still there)

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>

setUpdates()

Sets updates

public setUpdates(array<string|int, TransactionUpdate>|null $updates) : self
Parameters
$updates : array<string|int, TransactionUpdate>|null

Dry run only. Per update the matched and changed counts, exactly what a commit would do

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