Documentation

ModelInterface

Interface abstracting model access.

Tags
author

OpenAPI Generator team

Table of Contents

attributeMap()  : array<string|int, mixed>
Array of attributes where the key is the local name, and the value is the original name.
getModelName()  : string
The original name of the model.
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests).
isNullable()  : bool
Checks if a property is nullable.
isNullableSetToNull()  : bool
Checks if a nullable property is set to null.
listInvalidProperties()  : array<string|int, mixed>
Show all the invalid properties with reasons.
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.
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses).
valid()  : bool
Validate all the properties in the model return true if all passed.

Methods

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>

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>

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>

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>

setters()

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

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

valid()

Validate all the properties in the model return true if all passed.

public valid() : bool
Return values
bool

Search results