Documentation

CheckSummary
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CheckSummary 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
getErrors()  : int
Gets errors
getHasAuxiliary2D()  : bool
Gets has_auxiliary2_d
getHasVisualization()  : bool
Gets has_visualization
getInfos()  : int
Gets infos
getModelName()  : string
The original name of the model.
getOverallResult()  : CheckResultStatus
Gets overall_result
getSkipped()  : int
Gets skipped
getSuccesses()  : int
Gets successes
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWarnings()  : int
Gets warnings
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
setErrors()  : self
Sets errors
setHasAuxiliary2D()  : self
Sets has_auxiliary2_d
setHasVisualization()  : self
Sets has_visualization
setInfos()  : self
Sets infos
setOverallResult()  : self
Sets overall_result
setSkipped()  : self
Sets skipped
setSuccesses()  : self
Sets successes
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWarnings()  : self
Sets warnings
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

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 = ['has_auxiliary2_d' => 'hasAuxiliary2D', 'errors' => 'errors', 'successes' => 'successes', 'warnings' => 'warnings', 'infos' => 'infos', 'skipped' => 'skipped', 'overall_result' => 'overallResult', 'has_visualization' => 'hasVisualization']

$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 = ['has_auxiliary2_d' => 'getHasAuxiliary2D', 'errors' => 'getErrors', 'successes' => 'getSuccesses', 'warnings' => 'getWarnings', 'infos' => 'getInfos', 'skipped' => 'getSkipped', 'overall_result' => 'getOverallResult', 'has_visualization' => 'getHasVisualization']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['has_auxiliary2_d' => null, 'errors' => null, 'successes' => null, 'warnings' => null, 'infos' => null, 'skipped' => null, 'overall_result' => null, 'has_visualization' => 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 = 'CheckSummary'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['has_auxiliary2_d' => false, 'errors' => false, 'successes' => false, 'warnings' => false, 'infos' => false, 'skipped' => false, 'overall_result' => false, 'has_visualization' => 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 = ['has_auxiliary2_d' => 'bool', 'errors' => 'int', 'successes' => 'int', 'warnings' => 'int', 'infos' => 'int', 'skipped' => 'int', 'overall_result' => '\BIMworks\Model\CheckResultStatus', 'has_visualization' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['has_auxiliary2_d' => 'setHasAuxiliary2D', 'errors' => 'setErrors', 'successes' => 'setSuccesses', 'warnings' => 'setWarnings', 'infos' => 'setInfos', 'skipped' => 'setSkipped', 'overall_result' => 'setOverallResult', 'has_visualization' => 'setHasVisualization']

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>

getErrors()

Gets errors

public getErrors() : int
Return values
int

getHasAuxiliary2D()

Gets has_auxiliary2_d

public getHasAuxiliary2D() : bool
Return values
bool

getHasVisualization()

Gets has_visualization

public getHasVisualization() : bool
Return values
bool

getInfos()

Gets infos

public getInfos() : int
Return values
int

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getSkipped()

Gets skipped

public getSkipped() : int
Return values
int

getSuccesses()

Gets successes

public getSuccesses() : int
Return values
int

getters()

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

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

getWarnings()

Gets warnings

public getWarnings() : int
Return values
int

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>

setErrors()

Sets errors

public setErrors(int $errors) : self
Parameters
$errors : int

errors

Return values
self

setHasAuxiliary2D()

Sets has_auxiliary2_d

public setHasAuxiliary2D(bool $has_auxiliary2_d) : self
Parameters
$has_auxiliary2_d : bool

has_auxiliary2_d

Return values
self

setHasVisualization()

Sets has_visualization

public setHasVisualization(bool $has_visualization) : self
Parameters
$has_visualization : bool

has_visualization

Return values
self

setInfos()

Sets infos

public setInfos(int $infos) : self
Parameters
$infos : int

infos

Return values
self

setSkipped()

Sets skipped

public setSkipped(int $skipped) : self
Parameters
$skipped : int

skipped

Return values
self

setSuccesses()

Sets successes

public setSuccesses(int $successes) : self
Parameters
$successes : int

successes

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>

setWarnings()

Sets warnings

public setWarnings(int $warnings) : self
Parameters
$warnings : int

warnings

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