Documentation

TransactionUpdate
in package
implements ModelInterface, ArrayAccess, JsonSerializable

TransactionUpdate Class Doc Comment

Tags
category

Class

description

The effect of a single update (one SET assignment, one DEL feature, one DELETE OBJECT, or one TRANSFORM) of a transaction

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
OPERATION_DEL  : mixed = 'DEL'
OPERATION_DELETE_OBJECT  : mixed = 'DELETE_OBJECT'
OPERATION_REMOVE_GEOREFERENCE  : mixed = 'REMOVE_GEOREFERENCE'
OPERATION_SET  : mixed = 'SET'
OPERATION_SET_GEOREFERENCE  : mixed = 'SET_GEOREFERENCE'
OPERATION_TRANSFORM_OBJECT  : mixed = 'TRANSFORM_OBJECT'

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
getChangedCount()  : int|null
Gets changed_count
getChangedOids()  : array<string|int, int>|null
Gets changed_oids
getCreatedCount()  : int|null
Gets created_count
getDeletedCount()  : int|null
Gets deleted_count
getFeature()  : string|null
Gets feature
getGeoreference()  : array<string, mixed>|null
Gets georeference
getMatchedCount()  : int|null
Gets matched_count
getMatchedOids()  : array<string|int, int>|null
Gets matched_oids
getModelName()  : string
The original name of the model.
getOperation()  : string|null
Gets operation
getOperationAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getStatementIndex()  : int|null
Gets statement_index
getStatementLines()  : array<string|int, int>|null
Gets statement_lines
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUpdateIndex()  : int|null
Gets update_index
getValue()  : string|null
Gets value
getWarnings()  : array<string|int, string>|null
Gets warnings
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
setChangedCount()  : self
Sets changed_count
setChangedOids()  : self
Sets changed_oids
setCreatedCount()  : self
Sets created_count
setDeletedCount()  : self
Sets deleted_count
setFeature()  : self
Sets feature
setGeoreference()  : self
Sets georeference
setMatchedCount()  : self
Sets matched_count
setMatchedOids()  : self
Sets matched_oids
setOperation()  : self
Sets operation
setStatementIndex()  : self
Sets statement_index
setStatementLines()  : self
Sets statement_lines
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUpdateIndex()  : self
Sets update_index
setValue()  : self
Sets value
setWarnings()  : self
Sets warnings
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

OPERATION_DELETE_OBJECT

public mixed OPERATION_DELETE_OBJECT = 'DELETE_OBJECT'

OPERATION_REMOVE_GEOREFERENCE

public mixed OPERATION_REMOVE_GEOREFERENCE = 'REMOVE_GEOREFERENCE'

OPERATION_SET_GEOREFERENCE

public mixed OPERATION_SET_GEOREFERENCE = 'SET_GEOREFERENCE'

OPERATION_TRANSFORM_OBJECT

public mixed OPERATION_TRANSFORM_OBJECT = 'TRANSFORM_OBJECT'

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 = ['update_index' => 'update_index', 'operation' => 'operation', 'feature' => 'feature', 'georeference' => 'georeference', 'warnings' => 'warnings', 'value' => 'value', 'matched_count' => 'matched_count', 'changed_count' => 'changed_count', 'created_count' => 'created_count', 'deleted_count' => 'deleted_count', 'statement_index' => 'statement_index', 'statement_lines' => 'statement_lines', 'matched_oids' => 'matched_oids', 'changed_oids' => 'changed_oids']

$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 = ['update_index' => 'getUpdateIndex', 'operation' => 'getOperation', 'feature' => 'getFeature', 'georeference' => 'getGeoreference', 'warnings' => 'getWarnings', 'value' => 'getValue', 'matched_count' => 'getMatchedCount', 'changed_count' => 'getChangedCount', 'created_count' => 'getCreatedCount', 'deleted_count' => 'getDeletedCount', 'statement_index' => 'getStatementIndex', 'statement_lines' => 'getStatementLines', 'matched_oids' => 'getMatchedOids', 'changed_oids' => 'getChangedOids']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['update_index' => null, 'operation' => null, 'feature' => null, 'georeference' => null, 'warnings' => null, 'value' => null, 'matched_count' => null, 'changed_count' => null, 'created_count' => null, 'deleted_count' => null, 'statement_index' => null, 'statement_lines' => null, 'matched_oids' => null, 'changed_oids' => 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 = 'TransactionUpdate'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['update_index' => false, 'operation' => false, 'feature' => false, 'georeference' => false, 'warnings' => false, 'value' => false, 'matched_count' => false, 'changed_count' => false, 'created_count' => false, 'deleted_count' => false, 'statement_index' => false, 'statement_lines' => false, 'matched_oids' => false, 'changed_oids' => 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 = ['update_index' => 'int', 'operation' => 'string', 'feature' => 'string', 'georeference' => 'array<string,mixed>', 'warnings' => 'string[]', 'value' => 'string', 'matched_count' => 'int', 'changed_count' => 'int', 'created_count' => 'int', 'deleted_count' => 'int', 'statement_index' => 'int', 'statement_lines' => 'int[]', 'matched_oids' => 'int[]', 'changed_oids' => 'int[]']

$setters

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

protected static array<string|int, string> $setters = ['update_index' => 'setUpdateIndex', 'operation' => 'setOperation', 'feature' => 'setFeature', 'georeference' => 'setGeoreference', 'warnings' => 'setWarnings', 'value' => 'setValue', 'matched_count' => 'setMatchedCount', 'changed_count' => 'setChangedCount', 'created_count' => 'setCreatedCount', 'deleted_count' => 'setDeletedCount', 'statement_index' => 'setStatementIndex', 'statement_lines' => 'setStatementLines', 'matched_oids' => 'setMatchedOids', 'changed_oids' => 'setChangedOids']

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>

getChangedCount()

Gets changed_count

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

getChangedOids()

Gets changed_oids

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

getCreatedCount()

Gets created_count

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

getDeletedCount()

Gets deleted_count

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

getFeature()

Gets feature

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

getGeoreference()

Gets georeference

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

getMatchedCount()

Gets matched_count

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

getMatchedOids()

Gets matched_oids

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOperation()

Gets operation

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

getOperationAllowableValues()

Gets allowable values of the enum

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

getStatementIndex()

Gets statement_index

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

getStatementLines()

Gets statement_lines

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

getUpdateIndex()

Gets update_index

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

getValue()

Gets value

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

getWarnings()

Gets warnings

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

setChangedCount()

Sets changed_count

public setChangedCount(int|null $changed_count) : self
Parameters
$changed_count : int|null

How many of the matched objects actually change(d). A SET to a value an object already has, or a DEL of a feature an object does not have, is matched but not changed

Return values
self

setChangedOids()

Sets changed_oids

public setChangedOids(array<string|int, int>|null $changed_oids) : self
Parameters
$changed_oids : array<string|int, int>|null

Dry run with include_oids only. The objects the update changes, sorted ascending - the matched objects that end up different, plus for TRANSFORM_OBJECT the objects that move with a matched one, and for DELETE_OBJECT the deleted roots. Left out when the result has oids_truncated

Return values
self

setCreatedCount()

Sets created_count

public setCreatedCount(int|null $created_count) : self
Parameters
$created_count : int|null

Commit summary only. How many objects the update created

Return values
self

setDeletedCount()

Sets deleted_count

public setDeletedCount(int|null $deleted_count) : self
Parameters
$deleted_count : int|null

How many objects the update deleted (roots plus emptied relationships and sole-reference cascade, such as property sets and representations)

Return values
self

setFeature()

Sets feature

public setFeature(string|null $feature) : self
Parameters
$feature : string|null

The feature the update applies to (for example attribute.Name or property.Pset_WallCommon.IsExternal). For DELETE_OBJECT this is "object", for TRANSFORM_OBJECT "placement", for SET_GEOREFERENCE and REMOVE_GEOREFERENCE "georeference"

Return values
self

setGeoreference()

Sets georeference

public setGeoreference(array<string, mixed>|null $georeference) : self
Parameters
$georeference : array<string, mixed>|null

Dry run of SET_GEOREFERENCE / REMOVE_GEOREFERENCE only. The raw map conversion before and after (crs, eastings, northings, orthogonal_height in the map unit, x_axis_abscissa, x_axis_ordinate, scale), the Version's stored geo reference before (stored_before) and what the new Version will store (stored_after, WGS 84), and the anchor_point

Return values
self

setMatchedCount()

Sets matched_count

public setMatchedCount(int|null $matched_count) : self
Parameters
$matched_count : int|null

How many objects the WHERE clause matched

Return values
self

setMatchedOids()

Sets matched_oids

public setMatchedOids(array<string|int, int>|null $matched_oids) : self
Parameters
$matched_oids : array<string|int, int>|null

Dry run with include_oids only. The objects the WHERE clause matched, sorted ascending. Left out when the result has oids_truncated

Return values
self

setOperation()

Sets operation

public setOperation(string|null $operation) : self
Parameters
$operation : string|null

operation

Return values
self

setStatementIndex()

Sets statement_index

public setStatementIndex(int|null $statement_index) : self
Parameters
$statement_index : int|null

Dry run with include_oids only. The statement the update comes from, numbering the statements (SET, DEL, DELETE OBJECT, TRANSFORM, GEOREFERENCE) of the transaction from 0, so the updates of one SET with several assignments share it. Absent for drawn objects

Return values
self

setStatementLines()

Sets statement_lines

public setStatementLines(array<string|int, int>|null $statement_lines) : self
Parameters
$statement_lines : array<string|int, int>|null

Dry run with include_oids only. The first and last line (from 1) of that statement within its BUL string

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>

setUpdateIndex()

Sets update_index

public setUpdateIndex(int|null $update_index) : self
Parameters
$update_index : int|null

The index of this update within the transaction, in source order

Return values
self

setValue()

Sets value

public setValue(string|null $value) : self
Parameters
$value : string|null

Dry run only. The new value in BUL literal syntax (strings quoted, numbers with their unit), or the feature path when every object gets its own value (SET ... = calculated.quantity.netVolume)

Return values
self

setWarnings()

Sets warnings

public setWarnings(array<string|int, string>|null $warnings) : self
Parameters
$warnings : array<string|int, string>|null

Dry run only. Advice that does not stop the commit. For SET_GEOREFERENCE / REMOVE_GEOREFERENCE, such as a TrueNorth that disagrees with the conversion or an origin outside the area of use of the CRS; for a SET whose value is a feature, how many matched objects have no value and are left alone

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