Documentation

CheckRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable

CheckRequest Class Doc Comment

Interfaces

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR : mixed = null
FORMAT_BCF : mixed = 'bcf'
FORMAT_JSON : mixed = 'json'
FORMAT_SUMMARY : mixed = 'summary'

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
getActionUuid() : string|null: Gets action_uuid
getActionVersion() : int|null: Gets action_version
getBcl() : string|null: Gets bcl
getFormat() : string|null: Gets format
getFormatAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getIds() : string|null: Gets ids
getModelName() : string: The original name of the model.
getModels() : array<string|int, ModelIdentifier>: Gets models
getParameters() : array<string, mixed>|null: Gets parameters
getters() : array<string|int, mixed>: Array of attributes to getter functions (for serialization of requests)
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
setActionUuid() : self: Sets action_uuid
setActionVersion() : self: Sets action_version
setBcl() : self: Sets bcl
setFormat() : self: Sets format
setIds() : self: Sets ids
setModels() : self: Sets models
setParameters() : self: Sets parameters
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
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

FORMAT_BCF


    public
        mixed
    FORMAT_BCF
    = 'bcf'

FORMAT_JSON


    public
        mixed
    FORMAT_JSON
    = 'json'

FORMAT_SUMMARY


    public
        mixed
    FORMAT_SUMMARY
    = 'summary'

$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
     = ['models' => 'models', 'ids' => 'ids', 'bcl' => 'bcl', 'action_uuid' => 'action_uuid', 'action_version' => 'action_version', 'format' => 'format', 'parameters' => 'parameters']

$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
     = ['models' => 'getModels', 'ids' => 'getIds', 'bcl' => 'getBcl', 'action_uuid' => 'getActionUuid', 'action_version' => 'getActionVersion', 'format' => 'getFormat', 'parameters' => 'getParameters']

$openAPIFormats

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


        protected
        static    array<string|int, string>
    $openAPIFormats
     = ['models' => null, 'ids' => null, 'bcl' => null, 'action_uuid' => 'uuid', 'action_version' => null, 'format' => null, 'parameters' => null]

$openAPIModelName

The original name of the model.


        protected
        static    string
    $openAPIModelName
     = 'CheckRequest'

$openAPINullables

Array of nullable properties. Used for (de)serialization


        protected
        static    array<string|int, bool>
    $openAPINullables
     = ['models' => false, 'ids' => false, 'bcl' => false, 'action_uuid' => false, 'action_version' => false, 'format' => false, 'parameters' => 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
     = ['models' => '\BIMworks\Model\ModelIdentifier[]', 'ids' => 'string', 'bcl' => 'string', 'action_uuid' => 'string', 'action_version' => 'int', 'format' => 'string', 'parameters' => 'array<string,mixed>']

$setters

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


        protected
        static    array<string|int, string>
    $setters
     = ['models' => 'setModels', 'ids' => 'setIds', 'bcl' => 'setBcl', 'action_uuid' => 'setActionUuid', 'action_version' => 'setActionVersion', 'format' => 'setFormat', 'parameters' => 'setParameters']

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

getActionUuid()

Gets action_uuid


    public
                    getActionUuid() : string|null

Return values

string|null

getActionVersion()

Gets action_version


    public
                    getActionVersion() : int|null

Return values

int|null

getBcl()

Gets bcl


    public
                    getBcl() : string|null

Return values

string|null

getFormat()

Gets format


    public
                    getFormat() : string|null

Return values

string|null

getFormatAllowableValues()

Gets allowable values of the enum


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

Return values

array<string|int, string>

getIds()

Gets ids


    public
                    getIds() : string|null

Return values

string|null

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string

getModels()

Gets models


    public
                    getModels() : array<string|int, ModelIdentifier>

Return values

array<string|int, ModelIdentifier>

getParameters()

Gets parameters


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

Return values

array<string, mixed>|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

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>

setActionUuid()

Sets action_uuid


    public
                    setActionUuid(string|null $action_uuid) : self

Parameters

$action_uuid : string|null: A stored IDS or BCL check action to run instead of ids or bcl

Return values

self

setActionVersion()

Sets action_version


    public
                    setActionVersion(int|null $action_version) : self

Parameters

$action_version : int|null: The version of the stored action to run; its current version when absent

Return values

self

setBcl()

Sets bcl


    public
                    setBcl(string|null $bcl) : self

Parameters

$bcl : string|null: A BIM.works Checking Language (BCL) definition

Return values

self

setFormat()

Sets format


    public
                    setFormat(string|null $format) : self

Parameters

$format : string|null: Absent, the Accept header decides, and json when it names none of these. json: the model mapping and every checked object with its result (application/json); summary: the model mapping and the counts per result (application/json); bcf: the results as a BCF ZIP file (application/bcf)

Return values

self

setIds()

Sets ids


    public
                    setIds(string|null $ids) : self

Parameters

$ids : string|null: An IDS definition (XML)

Return values

self

setModels()

Sets models


    public
                    setModels(array<string|int, ModelIdentifier> $models) : self

Parameters

$models : array<string|int, ModelIdentifier>: Models to check. Passing an empty model set is also valid, and allows you to validate your model check definition

Return values

self

setParameters()

Sets parameters


    public
                    setParameters(array<string, mixed>|null $parameters) : self

Parameters

$parameters : array<string, mixed>|null: Values for the $name parameters of a BCL check (bcl, or a stored BCL action), by name. Every parameter of the check then needs a value. Not for an IDS

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>

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>

CheckRequest in package BIMworks implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

DISCRIMINATOR

FORMAT_BCF

FORMAT_JSON

FORMAT_SUMMARY

Properties

$attributeMap

$container

$getters

$openAPIFormats

Tags

$openAPIModelName

$openAPINullables

$openAPINullablesSetToNull

$openAPITypes

$setters

Methods

__construct()

Parameters

__toString()

Return values

attributeMap()

Return values

getActionUuid()

Return values

getActionVersion()

Return values

getBcl()

Return values

getFormat()

Return values

getFormatAllowableValues()

Return values

getIds()

Return values

getModelName()

Return values

getModels()

Return values

getParameters()

Return values

getters()

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

setActionUuid()

Parameters

Return values

CheckRequest
in package

BIMworks

implements ModelInterface, ArrayAccess, JsonSerializable