Documentation

SchemaConversionSummary
in package
implements ModelInterface, ArrayAccess, JsonSerializable

SchemaConversionSummary Class Doc Comment

Tags
category

Class

description

The numbers of one schema conversion

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

Table of Contents

Interfaces

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Constants

DISCRIMINATOR  : mixed = null
STATUS_COMPLETED  : mixed = 'COMPLETED'
STATUS_COMPLETED_WITH_LOSS  : mixed = 'COMPLETED_WITH_LOSS'
STATUS_FAILED  : mixed = 'FAILED'

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
getAdditions()  : int|null
Gets additions
getByRuleType()  : array<string, int>|null
Gets by_rule_type
getBySeverity()  : array<string, int>|null
Gets by_severity
getDetailLogComplete()  : bool|null
Gets detail_log_complete
getFrom()  : string|null
Gets from
getLosses()  : int|null
Gets losses
getModelName()  : string
The original name of the model.
getObjects()  : SchemaConversionSummaryObjects|null
Gets objects
getRuleSetVersion()  : int|null
Gets rule_set_version
getStatus()  : string|null
Gets status
getStatusAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTo()  : string|null
Gets to
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
setAdditions()  : self
Sets additions
setByRuleType()  : self
Sets by_rule_type
setBySeverity()  : self
Sets by_severity
setDetailLogComplete()  : self
Sets detail_log_complete
setFrom()  : self
Sets from
setLosses()  : self
Sets losses
setObjects()  : self
Sets objects
setRuleSetVersion()  : self
Sets rule_set_version
setStatus()  : self
Sets status
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTo()  : self
Sets to
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 = ['from' => 'from', 'to' => 'to', 'rule_set_version' => 'rule_set_version', 'status' => 'status', 'losses' => 'losses', 'additions' => 'additions', 'by_severity' => 'by_severity', 'by_rule_type' => 'by_rule_type', 'objects' => 'objects', 'detail_log_complete' => 'detail_log_complete']

$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 = ['from' => 'getFrom', 'to' => 'getTo', 'rule_set_version' => 'getRuleSetVersion', 'status' => 'getStatus', 'losses' => 'getLosses', 'additions' => 'getAdditions', 'by_severity' => 'getBySeverity', 'by_rule_type' => 'getByRuleType', 'objects' => 'getObjects', 'detail_log_complete' => 'getDetailLogComplete']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['from' => null, 'to' => null, 'rule_set_version' => null, 'status' => null, 'losses' => 'int64', 'additions' => 'int64', 'by_severity' => 'int64', 'by_rule_type' => 'int64', 'objects' => null, 'detail_log_complete' => 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 = 'SchemaConversionSummary'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['from' => false, 'to' => false, 'rule_set_version' => false, 'status' => false, 'losses' => false, 'additions' => false, 'by_severity' => false, 'by_rule_type' => false, 'objects' => false, 'detail_log_complete' => 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 = ['from' => 'string', 'to' => 'string', 'rule_set_version' => 'int', 'status' => 'string', 'losses' => 'int', 'additions' => 'int', 'by_severity' => 'array<string,int>', 'by_rule_type' => 'array<string,int>', 'objects' => '\BIMworks\Model\SchemaConversionSummaryObjects', 'detail_log_complete' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['from' => 'setFrom', 'to' => 'setTo', 'rule_set_version' => 'setRuleSetVersion', 'status' => 'setStatus', 'losses' => 'setLosses', 'additions' => 'setAdditions', 'by_severity' => 'setBySeverity', 'by_rule_type' => 'setByRuleType', 'objects' => 'setObjects', 'detail_log_complete' => 'setDetailLogComplete']

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>

getByRuleType()

Gets by_rule_type

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

getBySeverity()

Gets by_severity

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

getDetailLogComplete()

Gets detail_log_complete

public getDetailLogComplete() : bool|null
Return values
bool|null

getRuleSetVersion()

Gets rule_set_version

public getRuleSetVersion() : int|null
Return values
int|null

getStatusAllowableValues()

Gets allowable values of the enum

public getStatusAllowableValues() : array<string|int, string>
Return values
array<string|int, 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>

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>

setAdditions()

Sets additions

public setAdditions(int|null $additions) : self
Parameters
$additions : int|null

The number of findings about information that was added

Return values
self

setByRuleType()

Sets by_rule_type

public setByRuleType(array<string, int>|null $by_rule_type) : self
Parameters
$by_rule_type : array<string, int>|null

The number of findings per category, for example schemaconv.loss

Return values
self

setBySeverity()

Sets by_severity

public setBySeverity(array<string, int>|null $by_severity) : self
Parameters
$by_severity : array<string, int>|null

The number of findings per severity

Return values
self

setDetailLogComplete()

Sets detail_log_complete

public setDetailLogComplete(bool|null $detail_log_complete) : self
Parameters
$detail_log_complete : bool|null

Whether the detail log holds every finding

Return values
self

setFrom()

Sets from

public setFrom(string|null $from) : self
Parameters
$from : string|null

The schema of the model

Return values
self

setLosses()

Sets losses

public setLosses(int|null $losses) : self
Parameters
$losses : int|null

The number of findings about information that was lost

Return values
self

setRuleSetVersion()

Sets rule_set_version

public setRuleSetVersion(int|null $rule_set_version) : self
Parameters
$rule_set_version : int|null

The version of the conversion rules

Return values
self

setStatus()

Sets status

public setStatus(string|null $status) : self
Parameters
$status : string|null

status

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>

setTo()

Sets to

public setTo(string|null $to) : self
Parameters
$to : string|null

The schema it was converted to

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