1. class
  2. Ally
  3. \
  4. PetStore
  5. \
  6. Schema
  7. \
  8. ApiResponse

ApiResponse

class ApiResponse implements ModelInterface, ArrayAccess, JsonSerializable

ApiResponse Class Doc Comment

Constants

DISCRIMINATOR

Properties

static protected string $openAPIModelName

The original name of the model.
static protected string[] $openAPITypes

Array of property to type mappings. Used for (de)serialization
static protected string[] $openAPIFormats

Array of property to format mappings. Used for (de)serialization
static protected bool[] $openAPINullables

Array of nullable properties. Used for (de)serialization
protected bool[] $openAPINullablesSetToNull

If a nullable field gets set to null, insert it here
static protected string[] $attributeMap

Array of attributes where the key is the local name, and the value is the original name
static protected string[] $setters

Array of attributes to setter functions (for deserialization of responses)
static protected string[] $getters

Array of attributes to getter functions (for serialization of requests)
protected array $container

Associative array for storing property values

Methods

static array
openAPITypes()

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

static array
openAPIFormats()

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

static array
openAPINullables()

Array of nullable properties

static bool
isNullable(string $property)

Checks if a property is nullable

bool
isNullableSetToNull(string $property)

Checks if a nullable property is set to null.

static array
attributeMap()

Array of attributes where the key is the local name, and the value is the original name

static array
setters()

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

static array
getters()

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

string
getModelName()

The original name of the model.

__construct(array $data = null)

Constructor

array
listInvalidProperties()

Show all the invalid properties with reasons.

bool
valid()

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

int|null
getCode()

Gets code

ApiResponse
setCode(int|null $code)

Sets code

string|null
getType()

Gets type

ApiResponse
setType(string|null $type)

Sets type

string|null
getMessage()

Gets message

ApiResponse
setMessage(string|null $message)

Sets message

bool
offsetExists(int $offset)

Returns true if offset exists. False otherwise.

mixed|null
offsetGet(int $offset)

Gets offset.

void
offsetSet(int|null $offset, mixed $value)

Sets value based on offset.

void
offsetUnset(int $offset)

Unsets offset.

mixed
jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().

string
__toString()

Gets the string presentation of the object

string
toHeaderValue()

Gets a header-safe presentation of the object

Details

at line 102
static array openAPITypes()

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

Return Value

array

at line 112
static array openAPIFormats()

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

Return Value

array

at line 122
static protected array openAPINullables()

Array of nullable properties

Return Value

array

at line 143
static bool isNullable(string $property)

Checks if a property is nullable

Parameters

string $property

Return Value

bool

at line 154
bool isNullableSetToNull(string $property)

Checks if a nullable property is set to null.

Parameters

string $property

Return Value

bool

at line 199
static array attributeMap()

Array of attributes where the key is the local name, and the value is the original name

Return Value

array

at line 209
static array setters()

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

Return Value

array

at line 219
static array getters()

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

Return Value

array

at line 229
string getModelName()

The original name of the model.

Return Value

string

at line 248
__construct(array $data = null)

Constructor

Parameters

array $data

Associated array of property values initializing the model

at line 278
array listInvalidProperties()

Show all the invalid properties with reasons.

Return Value

array

at line 291
bool valid()

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

Return Value

bool

at line 302
int|null getCode()

Gets code

Return Value

int|null

at line 314
ApiResponse setCode(int|null $code)

Sets code

Parameters

int|null $code code

Return Value

ApiResponse

at line 331
string|null getType()

Gets type

Return Value

string|null

at line 343
ApiResponse setType(string|null $type)

Sets type

Parameters

string|null $type type

Return Value

ApiResponse

at line 360
string|null getMessage()

Gets message

Return Value

string|null

at line 372
ApiResponse setMessage(string|null $message)

Sets message

Parameters

string|null $message message

Return Value

ApiResponse

at line 390
bool offsetExists(int $offset)

Returns true if offset exists. False otherwise.

Parameters

int $offset Offset

Return Value

bool

at line 402
mixed|null offsetGet(int $offset)

Gets offset.

Parameters

int $offset Offset

Return Value

mixed|null

at line 416
void offsetSet(int|null $offset, mixed $value)

Sets value based on offset.

Parameters

int|null $offset Offset
mixed $value

Value to be set

Return Value

void

at line 432
void offsetUnset(int $offset)

Unsets offset.

Parameters

int $offset Offset

Return Value

void

at line 444
mixed jsonSerialize()

Serializes the object to a value that can be serialized natively by json_encode().

Return Value

mixed

Returns data which can be serialized by json_encode(), which is a value of any type other than a resource.

at line 455
string __toString()

Gets the string presentation of the object

Return Value

string

at line 468
string toHeaderValue()

Gets a header-safe presentation of the object

Return Value

string