Documentation

SliceSettings
in package
implements ModelInterface, ArrayAccess, JsonSerializable

SliceSettings Class Doc Comment

Tags
category

Class

description

For type SLICE

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
REFERENCE_ABSOLUTE  : mixed = 'ABSOLUTE'
REFERENCE_LOWEST  : mixed = 'LOWEST'
REFERENCE_SITE  : mixed = 'SITE'
SELECTION_ALL  : mixed = 'ALL'
SELECTION_ENVELOPE  : mixed = 'ENVELOPE'

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
getFillHoles()  : bool|null
Gets fill_holes
getHeightMm()  : float|null
Gets height_mm
getMendDistanceMm()  : float|null
Gets mend_distance_mm
getModelName()  : string
The original name of the model.
getReference()  : string|null
Gets reference
getReferenceAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSelection()  : string|null
Gets selection
getSelectionAllowableValues()  : array<string|int, string>
Gets allowable values of the enum
getSimplify()  : bool|null
Gets simplify
getSkipExternalSpaces()  : bool|null
Gets skip_external_spaces
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getToleranceMm()  : float|null
Gets tolerance_mm
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
setFillHoles()  : self
Sets fill_holes
setHeightMm()  : self
Sets height_mm
setMendDistanceMm()  : self
Sets mend_distance_mm
setReference()  : self
Sets reference
setSelection()  : self
Sets selection
setSimplify()  : self
Sets simplify
setSkipExternalSpaces()  : self
Sets skip_external_spaces
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setToleranceMm()  : self
Sets tolerance_mm
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

REFERENCE_ABSOLUTE

public mixed REFERENCE_ABSOLUTE = 'ABSOLUTE'

SELECTION_ENVELOPE

public mixed SELECTION_ENVELOPE = 'ENVELOPE'

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 = ['height_mm' => 'height_mm', 'reference' => 'reference', 'tolerance_mm' => 'tolerance_mm', 'mend_distance_mm' => 'mend_distance_mm', 'selection' => 'selection', 'fill_holes' => 'fill_holes', 'simplify' => 'simplify', 'skip_external_spaces' => 'skip_external_spaces']

$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 = ['height_mm' => 'getHeightMm', 'reference' => 'getReference', 'tolerance_mm' => 'getToleranceMm', 'mend_distance_mm' => 'getMendDistanceMm', 'selection' => 'getSelection', 'fill_holes' => 'getFillHoles', 'simplify' => 'getSimplify', 'skip_external_spaces' => 'getSkipExternalSpaces']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['height_mm' => null, 'reference' => null, 'tolerance_mm' => null, 'mend_distance_mm' => null, 'selection' => null, 'fill_holes' => null, 'simplify' => null, 'skip_external_spaces' => 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 = 'SliceSettings'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, bool> $openAPINullables = ['height_mm' => false, 'reference' => false, 'tolerance_mm' => false, 'mend_distance_mm' => false, 'selection' => false, 'fill_holes' => false, 'simplify' => false, 'skip_external_spaces' => 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 = ['height_mm' => 'float', 'reference' => 'string', 'tolerance_mm' => 'float', 'mend_distance_mm' => 'float', 'selection' => 'string', 'fill_holes' => 'bool', 'simplify' => 'bool', 'skip_external_spaces' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['height_mm' => 'setHeightMm', 'reference' => 'setReference', 'tolerance_mm' => 'setToleranceMm', 'mend_distance_mm' => 'setMendDistanceMm', 'selection' => 'setSelection', 'fill_holes' => 'setFillHoles', 'simplify' => 'setSimplify', 'skip_external_spaces' => 'setSkipExternalSpaces']

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>

getFillHoles()

Gets fill_holes

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

getHeightMm()

Gets height_mm

public getHeightMm() : float|null
Return values
float|null

getMendDistanceMm()

Gets mend_distance_mm

public getMendDistanceMm() : float|null
Return values
float|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getReference()

Gets reference

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

getReferenceAllowableValues()

Gets allowable values of the enum

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

getSelection()

Gets selection

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

getSelectionAllowableValues()

Gets allowable values of the enum

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

getSimplify()

Gets simplify

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

getSkipExternalSpaces()

Gets skip_external_spaces

public getSkipExternalSpaces() : bool|null
Return values
bool|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>

getToleranceMm()

Gets tolerance_mm

public getToleranceMm() : float|null
Return values
float|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>

setFillHoles()

Sets fill_holes

public setFillHoles(bool|null $fill_holes) : self
Parameters
$fill_holes : bool|null

fill_holes

Return values
self

setHeightMm()

Sets height_mm

public setHeightMm(float|null $height_mm) : self
Parameters
$height_mm : float|null

The height of the cut, in mm above the reference

Return values
self

setMendDistanceMm()

Sets mend_distance_mm

public setMendDistanceMm(float|null $mend_distance_mm) : self
Parameters
$mend_distance_mm : float|null

Gaps closed; tolerance_mm when absent

Return values
self

setReference()

Sets reference

public setReference(string|null $reference) : self
Parameters
$reference : string|null

reference

Return values
self

setSelection()

Sets selection

public setSelection(string|null $selection) : self
Parameters
$selection : string|null

selection

Return values
self

setSimplify()

Sets simplify

public setSimplify(bool|null $simplify) : self
Parameters
$simplify : bool|null

simplify

Return values
self

setSkipExternalSpaces()

Sets skip_external_spaces

public setSkipExternalSpaces(bool|null $skip_external_spaces) : self
Parameters
$skip_external_spaces : bool|null

skip_external_spaces

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>

setToleranceMm()

Sets tolerance_mm

public setToleranceMm(float|null $tolerance_mm) : self
Parameters
$tolerance_mm : float|null

tolerance_mm

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