Documentation

CheckResults
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CheckResults 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
TYPE_CHECK_RESULTS  = 'CheckResults'

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
getCheckLogic()  : array<string|int, mixed>
Gets check_logic
getCheckResult()  : CheckResultStatus
Gets check_result
getDescriptionEn()  : string
Gets description_en
getId()  : int
Gets id
getKey()  : string
Gets key
getModelName()  : string
The original name of the model.
getResolvedActions()  : ResolvedActions
Gets resolved_actions
getResults()  : array<string|int, ObjectCheckResult>
Gets results
getSummary()  : CheckSummary
Gets summary
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTitleEn()  : string
Gets title_en
getType()  : string
Gets type
getTypeAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getUuid()  : string
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
setCheckLogic()  : self
Sets check_logic
setCheckResult()  : self
Sets check_result
setDescriptionEn()  : self
Sets description_en
setId()  : self
Sets id
setKey()  : self
Sets key
setResolvedActions()  : self
Sets resolved_actions
setResults()  : self
Sets results
setSummary()  : self
Sets summary
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTitleEn()  : self
Sets title_en
setType()  : self
Sets type
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

TYPE_CHECK_RESULTS

public mixed TYPE_CHECK_RESULTS = 'CheckResults'

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 = ['type' => 'type', 'id' => 'id', 'uuid' => 'uuid', 'description_en' => 'descriptionEn', 'check_result' => 'checkResult', 'title_en' => 'titleEn', 'check_logic' => 'checkLogic', 'key' => 'key', 'resolved_actions' => 'resolvedActions', 'summary' => 'summary', 'results' => 'results']

$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 = ['type' => 'getType', 'id' => 'getId', 'uuid' => 'getUuid', 'description_en' => 'getDescriptionEn', 'check_result' => 'getCheckResult', 'title_en' => 'getTitleEn', 'check_logic' => 'getCheckLogic', 'key' => 'getKey', 'resolved_actions' => 'getResolvedActions', 'summary' => 'getSummary', 'results' => 'getResults']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['type' => null, 'id' => null, 'uuid' => 'uuid', 'description_en' => null, 'check_result' => null, 'title_en' => null, 'check_logic' => null, 'key' => null, 'resolved_actions' => null, 'summary' => null, 'results' => 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 = 'CheckResults'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['type' => false, 'id' => false, 'uuid' => false, 'description_en' => false, 'check_result' => false, 'title_en' => false, 'check_logic' => false, 'key' => false, 'resolved_actions' => false, 'summary' => false, 'results' => 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 = ['type' => 'string', 'id' => 'int', 'uuid' => 'string', 'description_en' => 'string', 'check_result' => '\BIMworks\Model\CheckResultStatus', 'title_en' => 'string', 'check_logic' => 'mixed[]', 'key' => 'string', 'resolved_actions' => '\BIMworks\Model\ResolvedActions', 'summary' => '\BIMworks\Model\CheckSummary', 'results' => '\BIMworks\Model\ObjectCheckResult[]']

$setters

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

protected static array<string|int, string> $setters = ['type' => 'setType', 'id' => 'setId', 'uuid' => 'setUuid', 'description_en' => 'setDescriptionEn', 'check_result' => 'setCheckResult', 'title_en' => 'setTitleEn', 'check_logic' => 'setCheckLogic', 'key' => 'setKey', 'resolved_actions' => 'setResolvedActions', 'summary' => 'setSummary', 'results' => 'setResults']

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>

getCheckLogic()

Gets check_logic

public getCheckLogic() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDescriptionEn()

Gets description_en

public getDescriptionEn() : string
Return values
string

getKey()

Gets key

public getKey() : string
Return values
string

getModelName()

The original name of the model.

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

getTitleEn()

Gets title_en

public getTitleEn() : string
Return values
string

getType()

Gets type

public getType() : string
Return values
string

getTypeAllowableValues()

Gets allowable values of the enum

public getTypeAllowableValues() : array<string|int, string>
Return values
array<string|int, string>

getUuid()

Gets uuid

public getUuid() : string
Return values
string

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

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>

setCheckLogic()

Sets check_logic

public setCheckLogic(array<string|int, mixed> $check_logic) : self
Parameters
$check_logic : array<string|int, mixed>

Array of check logic entries (not detailed in the sample).

Return values
self

setDescriptionEn()

Sets description_en

public setDescriptionEn(string $description_en) : self
Parameters
$description_en : string

description_en

Return values
self

setId()

Sets id

public setId(int $id) : self
Parameters
$id : int

id

Return values
self

setKey()

Sets key

public setKey(string $key) : self
Parameters
$key : string

key

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>

setTitleEn()

Sets title_en

public setTitleEn(string $title_en) : self
Parameters
$title_en : string

title_en

Return values
self

setType()

Sets type

public setType(string $type) : self
Parameters
$type : string

type

Return values
self

setUuid()

Sets uuid

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

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> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results