Documentation

CompareOptions
in package
implements ModelInterface, ArrayAccess, JsonSerializable

CompareOptions 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

ALIGN_AUTO  : mixed = 'auto'
ALIGN_NONE  : mixed = 'none'
DETAILS_CHANGES  : mixed = 'changes'
DETAILS_FULL  : mixed = 'full'
DETAILS_OBJECTS  : mixed = 'objects'
DETAILS_SUMMARY  : mixed = 'summary'
DISCRIMINATOR  : mixed = 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
getAlign()  : string|null
Gets align
getAlignAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getCategory()  : string|null
Gets category
getDetails()  : string|null
Gets details
getDetailsAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getForce()  : bool|null
Gets force
getLayers()  : bool|null
Gets layers
getLimit()  : int|null
Gets limit
getModelName()  : string
The original name of the model.
getOffset()  : int|null
Gets offset
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getWaitMs()  : int|null
Gets wait_ms
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
setAlign()  : self
Sets align
setCategory()  : self
Sets category
setDetails()  : self
Sets details
setForce()  : self
Sets force
setLayers()  : self
Sets layers
setLimit()  : self
Sets limit
setOffset()  : self
Sets offset
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setWaitMs()  : self
Sets wait_ms
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 = ['details' => 'details', 'layers' => 'layers', 'force' => 'force', 'wait_ms' => 'wait_ms', 'category' => 'category', 'offset' => 'offset', 'limit' => 'limit', 'align' => 'align']

$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 = ['details' => 'getDetails', 'layers' => 'getLayers', 'force' => 'getForce', 'wait_ms' => 'getWaitMs', 'category' => 'getCategory', 'offset' => 'getOffset', 'limit' => 'getLimit', 'align' => 'getAlign']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['details' => null, 'layers' => null, 'force' => null, 'wait_ms' => 'int64', 'category' => null, 'offset' => null, 'limit' => null, 'align' => 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 = 'CompareOptions'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['details' => false, 'layers' => false, 'force' => false, 'wait_ms' => false, 'category' => false, 'offset' => false, 'limit' => false, 'align' => 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 = ['details' => 'string', 'layers' => 'bool', 'force' => 'bool', 'wait_ms' => 'int', 'category' => 'string', 'offset' => 'int', 'limit' => 'int', 'align' => 'string']

$setters

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

protected static array<string|int, string> $setters = ['details' => 'setDetails', 'layers' => 'setLayers', 'force' => 'setForce', 'wait_ms' => 'setWaitMs', 'category' => 'setCategory', 'offset' => 'setOffset', 'limit' => 'setLimit', 'align' => 'setAlign']

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>

getAlign()

Gets align

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

getAlignAllowableValues()

Gets allowable values of the enum

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

getCategory()

Gets category

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

getDetails()

Gets details

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

getDetailsAllowableValues()

Gets allowable values of the enum

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

getForce()

Gets force

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

getLayers()

Gets layers

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

getLimit()

Gets limit

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOffset()

Gets offset

public getOffset() : int|null
Return values
int|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>

getWaitMs()

Gets wait_ms

public getWaitMs() : int|null
Return values
int|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

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>

setAlign()

Sets align

public setAlign(string|null $align) : self
Parameters
$align : string|null

Overrides the definition's align statement: auto judges the right side with the move most objects share undone (see alignment in the result), none counts that move

Return values
self

setCategory()

Sets category

public setCategory(string|null $category) : self
Parameters
$category : string|null

Only the records of this category (an id from summary.categories)

Return values
self

setDetails()

Sets details

public setDetails(string|null $details) : self
Parameters
$details : string|null

How much of the result to return: summary the counts per category, the statistics and the warnings; objects adds the object sets per category; changes adds the records of the added, removed and changed objects with what changed; full adds what every record reports, and the layers

Return values
self

setForce()

Sets force

public setForce(bool|null $force) : self
Parameters
$force : bool|null

Compute again even when a stored result answers the request

Return values
self

setLayers()

Sets layers

public setLayers(bool|null $layers) : self
Parameters
$layers : bool|null

Whether full includes the layers

Return values
self

setLimit()

Sets limit

public setLimit(int|null $limit) : self
Parameters
$limit : int|null

The number of records in the page

Return values
self

setOffset()

Sets offset

public setOffset(int|null $offset) : self
Parameters
$offset : int|null

The first record of the page

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>

setWaitMs()

Sets wait_ms

public setWaitMs(int|null $wait_ms) : self
Parameters
$wait_ms : int|null

Wait at most this long. A compare still running then answers 202 with result_uuid and status RUNNING and goes on in the background. Without it the call waits until the compare is done

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