Documentation

Error
in package
implements ModelInterface, ArrayAccess, JsonSerializable

Error Class Doc Comment

Tags
category

Class

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  = 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
getCreatedBy()  : string|null
Gets created_by
getCreatedOn()  : DateTime|null
Gets created_on
getDeletedStatus()  : RecordStatus|null
Gets deleted_status
getErrorMessage()  : string|null
Gets error_message
getFilename()  : string|null
Gets filename
getMetadata()  : object|null
Gets metadata
getModelName()  : string
The original name of the model.
getNodeName()  : string|null
Gets node_name
getNodeUuid()  : string|null
Gets node_uuid
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUniqueModelUuid()  : string|null
Gets unique_model_uuid
getUuid()  : string|null
Gets 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
setCreatedBy()  : self
Sets created_by
setCreatedOn()  : self
Sets created_on
setDeletedStatus()  : self
Sets deleted_status
setErrorMessage()  : self
Sets error_message
setFilename()  : self
Sets filename
setMetadata()  : self
Sets metadata
setNodeName()  : self
Sets node_name
setNodeUuid()  : self
Sets node_uuid
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUniqueModelUuid()  : self
Sets unique_model_uuid
setUuid()  : self
Sets 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

Constants

DISCRIMINATOR

public mixed DISCRIMINATOR = null

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', 'metadata' => 'metadata', 'node_name' => 'node_name', 'created_on' => 'created_on', 'created_by' => 'created_by', 'error_message' => 'error_message', 'unique_model_uuid' => 'unique_model_uuid', 'filename' => 'filename', 'deleted_status' => 'deleted_status']

$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', 'metadata' => 'getMetadata', 'node_name' => 'getNodeName', 'created_on' => 'getCreatedOn', 'created_by' => 'getCreatedBy', 'error_message' => 'getErrorMessage', 'unique_model_uuid' => 'getUniqueModelUuid', 'filename' => 'getFilename', 'deleted_status' => 'getDeletedStatus']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['uuid' => 'uuid', 'node_uuid' => 'uuid', 'metadata' => null, 'node_name' => null, 'created_on' => 'date-time', 'created_by' => null, 'error_message' => null, 'unique_model_uuid' => 'uuid', 'filename' => null, 'deleted_status' => 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 = 'Error'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['uuid' => false, 'node_uuid' => false, 'metadata' => false, 'node_name' => false, 'created_on' => false, 'created_by' => false, 'error_message' => false, 'unique_model_uuid' => false, 'filename' => false, 'deleted_status' => 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', 'metadata' => 'object', 'node_name' => 'string', 'created_on' => '\DateTime', 'created_by' => 'string', 'error_message' => 'string', 'unique_model_uuid' => 'string', 'filename' => 'string', 'deleted_status' => '\BIMworks\Model\RecordStatus']

$setters

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

protected static array<string|int, string> $setters = ['uuid' => 'setUuid', 'node_uuid' => 'setNodeUuid', 'metadata' => 'setMetadata', 'node_name' => 'setNodeName', 'created_on' => 'setCreatedOn', 'created_by' => 'setCreatedBy', 'error_message' => 'setErrorMessage', 'unique_model_uuid' => 'setUniqueModelUuid', 'filename' => 'setFilename', 'deleted_status' => 'setDeletedStatus']

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>

getCreatedBy()

Gets created_by

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

getCreatedOn()

Gets created_on

public getCreatedOn() : DateTime|null
Return values
DateTime|null

getErrorMessage()

Gets error_message

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

getFilename()

Gets filename

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

getMetadata()

Gets metadata

public getMetadata() : object|null
Return values
object|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNodeName()

Gets node_name

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

getNodeUuid()

Gets node_uuid

public getNodeUuid() : string|null
Return values
string|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>

getUniqueModelUuid()

Gets unique_model_uuid

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

getUuid()

Gets uuid

public getUuid() : 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
Tags
link
https://www.php.net/manual/en/jsonserializable.jsonserialize.php
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
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>

setCreatedBy()

Sets created_by

public setCreatedBy(string|null $created_by) : self
Parameters
$created_by : string|null

By whom this error was created

Return values
self

setCreatedOn()

Sets created_on

public setCreatedOn(DateTime|null $created_on) : self
Parameters
$created_on : DateTime|null

When this error was created

Return values
self

setDeletedStatus()

Sets deleted_status

public setDeletedStatus(RecordStatus|null $deleted_status) : self
Parameters
$deleted_status : RecordStatus|null

deleted_status

Return values
self

setErrorMessage()

Sets error_message

public setErrorMessage(string|null $error_message) : self
Parameters
$error_message : string|null

Human readable message

Return values
self

setFilename()

Sets filename

public setFilename(string|null $filename) : self
Parameters
$filename : string|null

The name of the model that was uploaded, for debugging purposes only

Return values
self

setMetadata()

Sets metadata

public setMetadata(object|null $metadata) : self
Parameters
$metadata : object|null

Additional untyped metadata for this error

Return values
self

setNodeName()

Sets node_name

public setNodeName(string|null $node_name) : self
Parameters
$node_name : string|null

Name of the Node this error belongs too, redundant but added for convenience

Return values
self

setNodeUuid()

Sets node_uuid

public setNodeUuid(string|null $node_uuid) : self
Parameters
$node_uuid : string|null

The UUID of the Node this error belongs to

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>

setUniqueModelUuid()

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
self

setUuid()

Sets uuid

public setUuid(string|null $uuid) : self
Parameters
$uuid : string|null

UUID of this TreeErrorNode

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