Version
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
Version Class Doc Comment
Tags
Table of Contents
Interfaces
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
- JsonSerializable
Constants
- DISCRIMINATOR : mixed = null
- ORIGIN_BRANCH : mixed = 'BRANCH'
- ORIGIN_CONVERSION : mixed = 'CONVERSION'
- ORIGIN_TRANSACTION : mixed = 'TRANSACTION'
- ORIGIN_UPLOAD : mixed = 'UPLOAD'
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
- getAlignment() : array<string|int, float>|null
- Gets alignment
- getBimContext() : string|null
- Gets bim_context
- getComment() : string|null
- Gets comment
- getCreatedBy() : string|null
- Gets created_by
- getCreatedOn() : DateTime|null
- Gets created_on
- getDeletedStatus() : RecordStatus|null
- Gets deleted_status
- getDiscipline() : Discipline|null
- Gets discipline
- getDisciplines() : array<string|int, Discipline>|null
- Gets disciplines
- getDisciplineSource() : DisciplineSource|null
- Gets discipline_source
- getFilename() : string|null
- Gets filename
- getGeoReference() : GeoReference|null
- Gets geo_reference
- getImMetadata() : ImMetadata|null
- Gets im_metadata
- getInputFileType() : InputFileType|null
- Gets input_file_type
- getMetadata() : object|null
- Gets metadata
- getModelName() : string
- The original name of the model.
- getModelUuid() : string|null
- Gets model_uuid
- getNodeName() : string|null
- Gets node_name
- getNodeUuid() : string|null
- Gets node_uuid
- getOrigin() : string|null
- Gets origin
- getOriginAllowableValues() : array<string|int, string>
- Gets allowable values of the enum
- getStatus() : VersionStatus|null
- Gets status
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getTransactionUuid() : string|null
- Gets transaction_uuid
- getUniqueModelUuid() : string|null
- Gets unique_model_uuid
- getUserData() : array<string, mixed>|null
- Gets user_data
- getUuid() : string|null
- Gets uuid
- getVersion() : int|null
- Gets version
- 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
- setAlignment() : self
- Sets alignment
- setBimContext() : self
- Sets bim_context
- setComment() : self
- Sets comment
- setCreatedBy() : self
- Sets created_by
- setCreatedOn() : self
- Sets created_on
- setDeletedStatus() : self
- Sets deleted_status
- setDiscipline() : self
- Sets discipline
- setDisciplines() : self
- Sets disciplines
- setDisciplineSource() : self
- Sets discipline_source
- setFilename() : self
- Sets filename
- setGeoReference() : self
- Sets geo_reference
- setImMetadata() : self
- Sets im_metadata
- setInputFileType() : self
- Sets input_file_type
- setMetadata() : self
- Sets metadata
- setModelUuid() : self
- Sets model_uuid
- setNodeName() : self
- Sets node_name
- setNodeUuid() : self
- Sets node_uuid
- setOrigin() : self
- Sets origin
- setStatus() : self
- Sets status
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setTransactionUuid() : self
- Sets transaction_uuid
- setUniqueModelUuid() : self
- Sets unique_model_uuid
- setUserData() : self
- Sets user_data
- setUuid() : self
- Sets uuid
- setVersion() : self
- Sets version
- 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
ORIGIN_BRANCH
public
mixed
ORIGIN_BRANCH
= 'BRANCH'
ORIGIN_CONVERSION
public
mixed
ORIGIN_CONVERSION
= 'CONVERSION'
ORIGIN_TRANSACTION
public
mixed
ORIGIN_TRANSACTION
= 'TRANSACTION'
ORIGIN_UPLOAD
public
mixed
ORIGIN_UPLOAD
= 'UPLOAD'
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', 'node_uuid' => 'node_uuid', 'version' => 'version', 'discipline' => 'discipline', 'disciplines' => 'disciplines', 'discipline_source' => 'discipline_source', 'metadata' => 'metadata', 'node_name' => 'node_name', 'created_on' => 'created_on', 'created_by' => 'created_by', 'status' => 'status', 'deleted_status' => 'deleted_status', 'bim_context' => 'bim_context', 'input_file_type' => 'input_file_type', 'filename' => 'filename', 'origin' => 'origin', 'transaction_uuid' => 'transaction_uuid', 'comment' => 'comment', 'model_uuid' => 'model_uuid', 'unique_model_uuid' => 'unique_model_uuid', 'alignment' => 'alignment', 'geo_reference' => 'geo_reference', 'im_metadata' => 'im_metadata', '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', 'node_uuid' => 'getNodeUuid', 'version' => 'getVersion', 'discipline' => 'getDiscipline', 'disciplines' => 'getDisciplines', 'discipline_source' => 'getDisciplineSource', 'metadata' => 'getMetadata', 'node_name' => 'getNodeName', 'created_on' => 'getCreatedOn', 'created_by' => 'getCreatedBy', 'status' => 'getStatus', 'deleted_status' => 'getDeletedStatus', 'bim_context' => 'getBimContext', 'input_file_type' => 'getInputFileType', 'filename' => 'getFilename', 'origin' => 'getOrigin', 'transaction_uuid' => 'getTransactionUuid', 'comment' => 'getComment', 'model_uuid' => 'getModelUuid', 'unique_model_uuid' => 'getUniqueModelUuid', 'alignment' => 'getAlignment', 'geo_reference' => 'getGeoReference', 'im_metadata' => 'getImMetadata', 'user_data' => 'getUserData']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['uuid' => 'uuid', 'node_uuid' => 'uuid', 'version' => null, 'discipline' => null, 'disciplines' => null, 'discipline_source' => null, 'metadata' => null, 'node_name' => null, 'created_on' => 'date-time', 'created_by' => null, 'status' => null, 'deleted_status' => null, 'bim_context' => null, 'input_file_type' => null, 'filename' => null, 'origin' => null, 'transaction_uuid' => 'uuid', 'comment' => null, 'model_uuid' => 'uuid', 'unique_model_uuid' => 'uuid', 'alignment' => null, 'geo_reference' => null, 'im_metadata' => null, 'user_data' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'Version'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, bool>
$openAPINullables
= ['uuid' => false, 'node_uuid' => false, 'version' => false, 'discipline' => false, 'disciplines' => false, 'discipline_source' => false, 'metadata' => false, 'node_name' => false, 'created_on' => false, 'created_by' => false, 'status' => false, 'deleted_status' => false, 'bim_context' => false, 'input_file_type' => false, 'filename' => false, 'origin' => false, 'transaction_uuid' => false, 'comment' => false, 'model_uuid' => false, 'unique_model_uuid' => false, 'alignment' => false, 'geo_reference' => false, 'im_metadata' => false, 'user_data' => 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', 'node_uuid' => 'string', 'version' => 'int', 'discipline' => '\BIMworks\Model\Discipline', 'disciplines' => '\BIMworks\Model\Discipline[]', 'discipline_source' => '\BIMworks\Model\DisciplineSource', 'metadata' => 'object', 'node_name' => 'string', 'created_on' => '\DateTime', 'created_by' => 'string', 'status' => '\BIMworks\Model\VersionStatus', 'deleted_status' => '\BIMworks\Model\RecordStatus', 'bim_context' => 'string', 'input_file_type' => '\BIMworks\Model\InputFileType', 'filename' => 'string', 'origin' => 'string', 'transaction_uuid' => 'string', 'comment' => 'string', 'model_uuid' => 'string', 'unique_model_uuid' => 'string', 'alignment' => 'float[]', 'geo_reference' => '\BIMworks\Model\GeoReference', 'im_metadata' => '\BIMworks\Model\ImMetadata', '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', 'node_uuid' => 'setNodeUuid', 'version' => 'setVersion', 'discipline' => 'setDiscipline', 'disciplines' => 'setDisciplines', 'discipline_source' => 'setDisciplineSource', 'metadata' => 'setMetadata', 'node_name' => 'setNodeName', 'created_on' => 'setCreatedOn', 'created_by' => 'setCreatedBy', 'status' => 'setStatus', 'deleted_status' => 'setDeletedStatus', 'bim_context' => 'setBimContext', 'input_file_type' => 'setInputFileType', 'filename' => 'setFilename', 'origin' => 'setOrigin', 'transaction_uuid' => 'setTransactionUuid', 'comment' => 'setComment', 'model_uuid' => 'setModelUuid', 'unique_model_uuid' => 'setUniqueModelUuid', 'alignment' => 'setAlignment', 'geo_reference' => 'setGeoReference', 'im_metadata' => 'setImMetadata', '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
stringattributeMap()
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>getAlignment()
Gets alignment
public
getAlignment() : array<string|int, float>|null
Return values
array<string|int, float>|nullgetBimContext()
Gets bim_context
public
getBimContext() : string|null
Return values
string|nullgetComment()
Gets comment
public
getComment() : string|null
Return values
string|nullgetCreatedBy()
Gets created_by
public
getCreatedBy() : string|null
Return values
string|nullgetCreatedOn()
Gets created_on
public
getCreatedOn() : DateTime|null
Return values
DateTime|nullgetDeletedStatus()
Gets deleted_status
public
getDeletedStatus() : RecordStatus|null
Return values
RecordStatus|nullgetDiscipline()
Gets discipline
public
getDiscipline() : Discipline|null
Return values
Discipline|nullgetDisciplines()
Gets disciplines
public
getDisciplines() : array<string|int, Discipline>|null
Return values
array<string|int, Discipline>|nullgetDisciplineSource()
Gets discipline_source
public
getDisciplineSource() : DisciplineSource|null
Return values
DisciplineSource|nullgetFilename()
Gets filename
public
getFilename() : string|null
Return values
string|nullgetGeoReference()
Gets geo_reference
public
getGeoReference() : GeoReference|null
Return values
GeoReference|nullgetImMetadata()
Gets im_metadata
public
getImMetadata() : ImMetadata|null
Return values
ImMetadata|nullgetInputFileType()
Gets input_file_type
public
getInputFileType() : InputFileType|null
Return values
InputFileType|nullgetMetadata()
Gets metadata
public
getMetadata() : object|null
Return values
object|nullgetModelName()
The original name of the model.
public
getModelName() : string
Return values
stringgetModelUuid()
Gets model_uuid
public
getModelUuid() : string|null
Return values
string|nullgetNodeName()
Gets node_name
public
getNodeName() : string|null
Return values
string|nullgetNodeUuid()
Gets node_uuid
public
getNodeUuid() : string|null
Return values
string|nullgetOrigin()
Gets origin
public
getOrigin() : string|null
Return values
string|nullgetOriginAllowableValues()
Gets allowable values of the enum
public
getOriginAllowableValues() : array<string|int, string>
Return values
array<string|int, string>getStatus()
Gets status
public
getStatus() : VersionStatus|null
Return values
VersionStatus|nullgetters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed>getTransactionUuid()
Gets transaction_uuid
public
getTransactionUuid() : string|null
Return values
string|nullgetUniqueModelUuid()
Gets unique_model_uuid
public
getUniqueModelUuid() : string|null
Return values
string|nullgetUserData()
Gets user_data
public
getUserData() : array<string, mixed>|null
Return values
array<string, mixed>|nullgetUuid()
Gets uuid
public
getUuid() : string|null
Return values
string|nullgetVersion()
Gets version
public
getVersion() : int|null
Return values
int|nullisNullable()
Checks if a property is nullable
public
static isNullable(string $property) : bool
Parameters
- $property : string
Return values
boolisNullableSetToNull()
Checks if a nullable property is set to null.
public
isNullableSetToNull(string $property) : bool
Parameters
- $property : string
Return values
booljsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
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
booloffsetGet()
Gets offset.
public
offsetGet(int|string $offset) : mixed|null
Parameters
- $offset : int|string
-
Offset
Attributes
- #[ReturnTypeWillChange]
Return values
mixed|nulloffsetSet()
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>setAlignment()
Sets alignment
public
setAlignment(array<string|int, float>|null $alignment) : self
Parameters
- $alignment : array<string|int, float>|null
-
The Version's alignment, a 4x4 transformation as 16 numbers in column-major order (translation at 12, 13, 14, in metres); absent when it has none
Return values
selfsetBimContext()
Sets bim_context
public
setBimContext(string|null $bim_context) : self
Parameters
- $bim_context : string|null
-
Deprecated
Return values
selfsetComment()
Sets comment
public
setComment(string|null $comment) : self
Parameters
- $comment : string|null
-
For origin TRANSACTION, the comment of that transaction
Return values
selfsetCreatedBy()
Sets created_by
public
setCreatedBy(string|null $created_by) : self
Parameters
- $created_by : string|null
-
The username of the user that created this Version
Return values
selfsetCreatedOn()
Sets created_on
public
setCreatedOn(DateTime|null $created_on) : self
Parameters
- $created_on : DateTime|null
-
When this Version was created
Return values
selfsetDeletedStatus()
Sets deleted_status
public
setDeletedStatus(RecordStatus|null $deleted_status) : self
Parameters
- $deleted_status : RecordStatus|null
-
deleted_status
Return values
selfsetDiscipline()
Sets discipline
public
setDiscipline(Discipline|null $discipline) : self
Parameters
- $discipline : Discipline|null
-
discipline
Return values
selfsetDisciplines()
Sets disciplines
public
setDisciplines(array<string|int, Discipline>|null $disciplines) : self
Parameters
- $disciplines : array<string|int, Discipline>|null
-
Multi-label disciplines ordered by classification share, primary first; the single discipline field stays the primary for backwards compatibility
Return values
selfsetDisciplineSource()
Sets discipline_source
public
setDisciplineSource(DisciplineSource|null $discipline_source) : self
Parameters
- $discipline_source : DisciplineSource|null
-
discipline_source
Return values
selfsetFilename()
Sets filename
public
setFilename(string|null $filename) : self
Parameters
- $filename : string|null
-
The name of the uploaded file; absent for a Version made by a transaction
Return values
selfsetGeoReference()
Sets geo_reference
public
setGeoReference(GeoReference|null $geo_reference) : self
Parameters
- $geo_reference : GeoReference|null
-
geo_reference
Return values
selfsetImMetadata()
Sets im_metadata
public
setImMetadata(ImMetadata|null $im_metadata) : self
Parameters
- $im_metadata : ImMetadata|null
-
im_metadata
Return values
selfsetInputFileType()
Sets input_file_type
public
setInputFileType(InputFileType|null $input_file_type) : self
Parameters
- $input_file_type : InputFileType|null
-
input_file_type
Return values
selfsetMetadata()
Sets metadata
public
setMetadata(object|null $metadata) : self
Parameters
- $metadata : object|null
-
Untyped metadata for internal use
Return values
selfsetModelUuid()
Sets model_uuid
public
setModelUuid(string|null $model_uuid) : self
Parameters
- $model_uuid : string|null
-
The UUID of the model record behind this Version, for internal use
Return values
selfsetNodeName()
Sets node_name
public
setNodeName(string|null $node_name) : self
Parameters
- $node_name : string|null
-
The name of the Node this version belongs to. Redundant but for convenience.
Return values
selfsetNodeUuid()
Sets node_uuid
public
setNodeUuid(string|null $node_uuid) : self
Parameters
- $node_uuid : string|null
-
The UUID of the Node this Version belongs to
Return values
selfsetOrigin()
Sets origin
public
setOrigin(string|null $origin) : self
Parameters
- $origin : string|null
-
How the Version came into existence:
UPLOADan uploaded file,TRANSACTIONa BUL transaction applied to another Version,CONVERSIONa conversion to another IFC schema;BRANCHis reserved
Return values
selfsetStatus()
Sets status
public
setStatus(VersionStatus|null $status) : self
Parameters
- $status : VersionStatus|null
-
status
Return values
selfsetters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed>setTransactionUuid()
Sets transaction_uuid
public
setTransactionUuid(string|null $transaction_uuid) : self
Parameters
- $transaction_uuid : string|null
-
For origin TRANSACTION, the transaction that made this Version
Return values
selfsetUniqueModelUuid()
Sets unique_model_uuid
public
setUniqueModelUuid(string|null $unique_model_uuid) : self
Parameters
- $unique_model_uuid : string|null
-
The UUID of the Unique Model, for internal use
Return values
selfsetUserData()
Sets user_data
public
setUserData(array<string, mixed>|null $user_data) : self
Parameters
- $user_data : array<string, mixed>|null
-
user_data
Return values
selfsetUuid()
Sets uuid
public
setUuid(string|null $uuid) : self
Parameters
- $uuid : string|null
-
The UUID of this Version
Return values
selfsetVersion()
Sets version
public
setVersion(int|null $version) : self
Parameters
- $version : int|null
-
The version (incremental)
Return values
selftoHeaderValue()
Gets a header-safe presentation of the object
public
toHeaderValue() : string
Return values
stringvalid()
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>