Documentation

AddModelWithUrlRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

AddModelWithUrlRequest Class Doc Comment

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
getFilename() : string|null: Gets filename
getForce() : UploadForce|null: Gets force
getForceReprocessing() : bool|null: Gets force_reprocessing
getFormatSettings() : array<string, mixed>|null: Gets format_settings
getInputFileType() : InputFileType|null: Gets input_file_type
getModelName() : string: The original name of the model.
getNodeUuid() : string|null: Gets node_uuid
getPath() : string|null: Gets path
getTags() : array<string|int, VersionTag>|null: Gets tags
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
getUrl() : string: Gets url
getValidationSettings() : ValidationSettings|null: Gets validation_settings
getWaitMs() : int|null: Gets wait_ms
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
setFilename() : self: Sets filename
setForce() : self: Sets force
setForceReprocessing() : self: Sets force_reprocessing
setFormatSettings() : self: Sets format_settings
setInputFileType() : self: Sets input_file_type
setNodeUuid() : self: Sets node_uuid
setPath() : self: Sets path
setTags() : self: Sets tags
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
setUrl() : self: Sets url
setValidationSettings() : self: Sets validation_settings
setWaitMs() : self: Sets wait_ms
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

$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
     = ['node_uuid' => 'node_uuid', 'path' => 'path', 'filename' => 'filename', 'url' => 'url', 'input_file_type' => 'input_file_type', 'format_settings' => 'format_settings', 'force_reprocessing' => 'force_reprocessing', 'tags' => 'tags', 'validation_settings' => 'validation_settings', 'wait_ms' => 'wait_ms', 'force' => 'force']

$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
     = ['node_uuid' => 'getNodeUuid', 'path' => 'getPath', 'filename' => 'getFilename', 'url' => 'getUrl', 'input_file_type' => 'getInputFileType', 'format_settings' => 'getFormatSettings', 'force_reprocessing' => 'getForceReprocessing', 'tags' => 'getTags', 'validation_settings' => 'getValidationSettings', 'wait_ms' => 'getWaitMs', 'force' => 'getForce']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['node_uuid' => 'uuid', 'path' => null, 'filename' => null, 'url' => null, 'input_file_type' => null, 'format_settings' => null, 'force_reprocessing' => null, 'tags' => null, 'validation_settings' => null, 'wait_ms' => 'int64', 'force' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'AddModelWithUrlRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['node_uuid' => false, 'path' => false, 'filename' => false, 'url' => false, 'input_file_type' => false, 'format_settings' => false, 'force_reprocessing' => false, 'tags' => false, 'validation_settings' => false, 'wait_ms' => false, 'force' => 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
     = ['node_uuid' => 'string', 'path' => 'string', 'filename' => 'string', 'url' => 'string', 'input_file_type' => '\BIMworks\Model\InputFileType', 'format_settings' => 'array<string,mixed>', 'force_reprocessing' => 'bool', 'tags' => '\BIMworks\Model\VersionTag[]', 'validation_settings' => '\BIMworks\Model\ValidationSettings', 'wait_ms' => 'int', 'force' => '\BIMworks\Model\UploadForce']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['node_uuid' => 'setNodeUuid', 'path' => 'setPath', 'filename' => 'setFilename', 'url' => 'setUrl', 'input_file_type' => 'setInputFileType', 'format_settings' => 'setFormatSettings', 'force_reprocessing' => 'setForceReprocessing', 'tags' => 'setTags', 'validation_settings' => 'setValidationSettings', 'wait_ms' => 'setWaitMs', 'force' => 'setForce']

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

getFilename()

Gets filename


    public
                    getFilename() : string|null

Return values

string|null

getForce()

Gets force


    public
                    getForce() : UploadForce|null

Return values

UploadForce|null

getForceReprocessing()

Gets force_reprocessing


    public
                    getForceReprocessing() : bool|null

Return values

bool|null

getFormatSettings()

Gets format_settings


    public
                    getFormatSettings() : array<string, mixed>|null

Return values

array<string, mixed>|null

getInputFileType()

Gets input_file_type


    public
                    getInputFileType() : InputFileType|null

Return values

InputFileType|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getNodeUuid()

Gets node_uuid


    public
                    getNodeUuid() : string|null

Return values

string|null

getPath()

Gets path


    public
                    getPath() : string|null

Return values

string|null

getTags()

Gets tags


    public
                    getTags() : array<string|int, VersionTag>|null

Return values

array<string|int, VersionTag>|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>

getUrl()

Gets url


    public
                    getUrl() : string

Return values

string

getValidationSettings()

Gets validation_settings


    public
                    getValidationSettings() : ValidationSettings|null

Return values

ValidationSettings|null

getWaitMs()

Gets wait_ms


    public
                    getWaitMs() : int|null

Return values

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

setFilename()

Sets filename


    public
                    setFilename(string|null $filename) : self

Parameters

$filename : string|null: Name of the file; the last segment of the URL's path when absent

Return values

self

setForce()

Sets force


    public
                    setForce(UploadForce|null $force) : self

Parameters

$force : UploadForce|null: force

Return values

self

setForceReprocessing()

Sets force_reprocessing


    public
                    setForceReprocessing(bool|null $force_reprocessing) : self

Parameters

$force_reprocessing : bool|null: Process the file again, also when the server has processed the same file before

Return values

self

setFormatSettings()

Sets format_settings


    public
                    setFormatSettings(array<string, mixed>|null $format_settings) : self

Parameters

$format_settings : array<string, mixed>|null: Per-upload options for point cloud formats, applied when the uploaded model is a point cloud (LAS and LAZ share one option table; E57 takes only include_classifications). Every option has a sensible default that detection fills in - pass only what detection got wrong. Unknown keys are rejected. The resolved effective settings (defaults + detection + these overrides, plus detection warnings) are persisted in the model's im_metadata under pointCloud. LAS / LAZ options (LAZ is LASzip-compressed LAS: same header, same records, decoded chunk by chunk; the effective settings additionally record laszip_compressor, laszip_version, laszip_chunk_size, laszip_chunks, laszip_items and, for COPC files, the copc octree parameters): - unit: linear unit of the coordinates after scale/offset - \"mm\", \"cm\", \"m\", \"ft\", \"usft\". Default: from the CRS VLR, else metres. - rgb_source: \"auto\" (RGB if present and non-zero, else intensity, else default_color), \"rgb\", \"intensity\" or \"none\". Default \"auto\". - color_bit_depth: \"auto\" (sample-based), 8 or 16. The LAS spec says RGB is 0-65535 but many writers store 0-255. Default \"auto\". - intensity_range: \"auto\" (sampled min/max maps to 0-255 grayscale) or [min, max]. - exclude_withheld: drop points flagged Withheld. Default true. - include_classifications: array of ASPRS class codes to keep, e.g. [2, 6] (ground, building). Default: all. - default_color: \"#rrggbb\" used when no RGB and no intensity. Default \"#ffffff\". E57 option: - include_classifications: as for LAS, for an E57 whose points carry a classification field (as PDAL's LAS-to-E57 export writes); rejected when no scan has one. The effective settings list the per-point fields and the skipped_fields BIM.works does not use.

Return values

self

setInputFileType()

Sets input_file_type


    public
                    setInputFileType(InputFileType|null $input_file_type) : self

Parameters

$input_file_type : InputFileType|null: The type of the model. When present and not UNKNOWN it wins over the filename extension - the route for correcting misnamed files or extension-less URLs

Return values

self

setNodeUuid()

Sets node_uuid


    public
                    setNodeUuid(string|null $node_uuid) : self

Parameters

$node_uuid : string|null: The UUID of the Node to which to add the model

Return values

self

setPath()

Sets path


    public
                    setPath(string|null $path) : self

Parameters

$path : string|null: Instead of node_uuid, the path of the folder, from the caller's root

Return values

self

setTags()

Sets tags


    public
                    setTags(array<string|int, VersionTag>|null $tags) : self

Parameters

$tags : array<string|int, VersionTag>|null: Tags of the new Version

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>

setUrl()

Sets url


    public
                    setUrl(string $url) : self

Parameters

$url : string: URL to get the model

Return values

self

setValidationSettings()

Sets validation_settings


    public
                    setValidationSettings(ValidationSettings|null $validation_settings) : self

Parameters

$validation_settings : ValidationSettings|null: validation_settings

Return values

self

setWaitMs()

Sets wait_ms


    public
                    setWaitMs(int|null $wait_ms) : self

Parameters

$wait_ms : int|null: Answer 202 with the checkin's status when the checkin takes longer than this

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>

AddModelWithUrlRequest in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getFilename()

Return values

getForce()

Return values

getForceReprocessing()

Return values

getFormatSettings()

Return values

getInputFileType()

Return values

getModelName()

Return values

getNodeUuid()

Return values

getPath()

Return values

getTags()

Return values

getters()

Return values

getUrl()

Return values

getValidationSettings()

Return values

getWaitMs()

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

openAPITypes()

Return values

AddModelWithUrlRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable