Documentation

VersionChange
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

VersionChange Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null
STATUS_FAILED : mixed = 'failed'
STATUS_FORBIDDEN : mixed = 'forbidden'
STATUS_NONE : mixed = 'none'
STATUS_PENDING : mixed = 'pending'
STATUS_READY : mixed = 'ready'
STATUS_UNKNOWN : mixed = 'unknown'

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
getCounts() : CompareCounts|null: Gets counts
getError() : string|null: Gets error
getModelName() : string: The original name of the model.
getPreviousVersion() : int|null: Gets previous_version
getPreviousVersionUuid() : string|null: Gets previous_version_uuid
getResultUuid() : string|null: Gets result_uuid
getStatus() : string|null: Gets status
getStatusAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getVersion() : int|null: Gets version
getVersionUuid() : string|null: Gets version_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
setCounts() : self: Sets counts
setError() : self: Sets error
setPreviousVersion() : self: Sets previous_version
setPreviousVersionUuid() : self: Sets previous_version_uuid
setResultUuid() : self: Sets result_uuid
setStatus() : self: Sets status
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setVersion() : self: Sets version
setVersionUuid() : self: Sets version_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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

STATUS_FAILED


    public
        mixed
    STATUS_FAILED
    = 'failed'

STATUS_FORBIDDEN


    public
        mixed
    STATUS_FORBIDDEN
    = 'forbidden'

STATUS_NONE


    public
        mixed
    STATUS_NONE
    = 'none'

STATUS_PENDING


    public
        mixed
    STATUS_PENDING
    = 'pending'

STATUS_READY


    public
        mixed
    STATUS_READY
    = 'ready'

STATUS_UNKNOWN


    public
        mixed
    STATUS_UNKNOWN
    = 'unknown'

$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
     = ['version_uuid' => 'version_uuid', 'version' => 'version', 'previous_version_uuid' => 'previous_version_uuid', 'previous_version' => 'previous_version', 'status' => 'status', 'result_uuid' => 'result_uuid', 'counts' => 'counts', 'error' => 'error']

$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
     = ['version_uuid' => 'getVersionUuid', 'version' => 'getVersion', 'previous_version_uuid' => 'getPreviousVersionUuid', 'previous_version' => 'getPreviousVersion', 'status' => 'getStatus', 'result_uuid' => 'getResultUuid', 'counts' => 'getCounts', 'error' => 'getError']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['version_uuid' => 'uuid', 'version' => null, 'previous_version_uuid' => 'uuid', 'previous_version' => null, 'status' => null, 'result_uuid' => 'uuid', 'counts' => null, 'error' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'VersionChange'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['version_uuid' => false, 'version' => false, 'previous_version_uuid' => false, 'previous_version' => false, 'status' => false, 'result_uuid' => false, 'counts' => false, 'error' => 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
     = ['version_uuid' => 'string', 'version' => 'int', 'previous_version_uuid' => 'string', 'previous_version' => 'int', 'status' => 'string', 'result_uuid' => 'string', 'counts' => '\BIMworks\Model\CompareCounts', 'error' => 'string']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['version_uuid' => 'setVersionUuid', 'version' => 'setVersion', 'previous_version_uuid' => 'setPreviousVersionUuid', 'previous_version' => 'setPreviousVersion', 'status' => 'setStatus', 'result_uuid' => 'setResultUuid', 'counts' => 'setCounts', 'error' => 'setError']

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

getCounts()

Gets counts


    public
                    getCounts() : CompareCounts|null

Return values

CompareCounts|null

getError()

Gets error


    public
                    getError() : string|null

Return values

string|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getPreviousVersion()

Gets previous_version


    public
                    getPreviousVersion() : int|null

Return values

int|null

getPreviousVersionUuid()

Gets previous_version_uuid


    public
                    getPreviousVersionUuid() : string|null

Return values

string|null

getResultUuid()

Gets result_uuid


    public
                    getResultUuid() : string|null

Return values

string|null

getStatus()

Gets status


    public
                    getStatus() : string|null

Return values

string|null

getStatusAllowableValues()

Gets allowable values of the enum


    public
                    getStatusAllowableValues() : array<string|int, string>

Return values

array<string|int, string>

getters()

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


    public
            static        getters() : array<string|int, mixed>

Return values

array<string|int, mixed>

getVersion()

Gets version


    public
                    getVersion() : int|null

Return values

int|null

getVersionUuid()

Gets version_uuid


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

jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().


    public
                    jsonSerialize() : mixed

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

bool

offsetGet()

Gets offset.


    public
                    offsetGet(int|string $offset) : mixed|null

Parameters

$offset : int|string: Offset

#[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>

setCounts()

Sets counts


    public
                    setCounts(CompareCounts|null $counts) : self

Parameters

$counts : CompareCounts|null: counts

Return values

self

setError()

Sets error


    public
                    setError(string|null $error) : self

Parameters

$error : string|null: error

Return values

self

setPreviousVersion()

Sets previous_version


    public
                    setPreviousVersion(int|null $previous_version) : self

Parameters

$previous_version : int|null: previous_version

Return values

self

setPreviousVersionUuid()

Sets previous_version_uuid


    public
                    setPreviousVersionUuid(string|null $previous_version_uuid) : self

Parameters

$previous_version_uuid : string|null: previous_version_uuid

Return values

self

setResultUuid()

Sets result_uuid


    public
                    setResultUuid(string|null $result_uuid) : self

Parameters

$result_uuid : string|null: result_uuid

Return values

self

setStatus()

Sets status


    public
                    setStatus(string|null $status) : self

Parameters

$status : string|null: none: a first Version; pending: being compared, ask again; unknown: only_stored and nothing stored; forbidden: no read rights on one of the two Versions

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>

setVersion()

Sets version


    public
                    setVersion(int|null $version) : self

Parameters

$version : int|null: version

Return values

self

setVersionUuid()

Sets version_uuid


    public
                    setVersionUuid(string|null $version_uuid) : self

Parameters

$version_uuid : string|null: version_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>

VersionChange in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

STATUS_FAILED

STATUS_FORBIDDEN

STATUS_NONE

STATUS_PENDING

STATUS_READY

STATUS_UNKNOWN

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getCounts()

Return values

getError()

Return values

getModelName()

Return values

getPreviousVersion()

Return values

getPreviousVersionUuid()

Return values

getResultUuid()

Return values

getStatus()

Return values

getStatusAllowableValues()

Return values

getters()

Return values

getVersion()

Return values

getVersionUuid()

Return values

isNullable()

Parameters

Return values

isNullableSetToNull()

Parameters

Return values

jsonSerialize()

Tags

Attributes

Return values

listInvalidProperties()

Return values

offsetExists()

Parameters

Return values

offsetGet()

Parameters

Attributes

Return values

offsetSet()

Parameters

offsetUnset()

Parameters

openAPIFormats()

Return values

VersionChange
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable