Ally's PetStore API

Pet
in package

Ally

PetStore

implements ModelInterface, ArrayAccess, JsonSerializable

Pet Class Doc Comment

Interfaces, Classes, Traits and Enums

ModelInterface: Interface abstracting model access.
ArrayAccess
JsonSerializable

DISCRIMINATOR = null
STATUS_AVAILABLE = 'available'
STATUS_PENDING = 'pending'
STATUS_SOLD = 'sold'
$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)
__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
getCategory() : Category|null: Gets category
getId() : int|null: Gets id
getModelName() : string: The original name of the model.
getName() : string: Gets name
getPhotoUrls() : array<string|int, string>: Gets photo_urls
getStatus() : string|null: Gets status
getStatusAllowableValues() : array<string|int, string>: Gets allowable values of the enum
getTags() : array<string|int, Tag>|null: Gets tags
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.
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
setCategory() : self: Sets category
setId() : self: Sets id
setName() : self: Sets name
setPhotoUrls() : self: Sets photo_urls
setStatus() : self: Sets status
setTags() : self: Sets tags
setters() : array<string|int, mixed>: Array of attributes to setter functions (for deserialization of responses)
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

DISCRIMINATOR


    public
        mixed
    DISCRIMINATOR
    = null

STATUS_AVAILABLE


    public
        mixed
    STATUS_AVAILABLE
    = 'available'

STATUS_PENDING


    public
        mixed
    STATUS_PENDING
    = 'pending'

STATUS_SOLD


    public
        mixed
    STATUS_SOLD
    = 'sold'

$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
     = ['id' => 'id', 'category' => 'category', 'name' => 'name', 'photo_urls' => 'photoUrls', 'tags' => 'tags', 'status' => 'status']

$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
     = ['id' => 'getId', 'category' => 'getCategory', 'name' => 'getName', 'photo_urls' => 'getPhotoUrls', 'tags' => 'getTags', 'status' => 'getStatus']

$openAPIFormats

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


    protected
    static    array<string|int, string>
    $openAPIFormats
     = ['id' => 'int64', 'category' => null, 'name' => null, 'photo_urls' => null, 'tags' => null, 'status' => null]

$openAPIModelName

The original name of the model.


    protected
    static    string
    $openAPIModelName
     = 'Pet'

$openAPINullables

Array of nullable properties. Used for (de)serialization


    protected
    static    array<string|int, bool>
    $openAPINullables
     = ['id' => false, 'category' => false, 'name' => false, 'photo_urls' => false, 'tags' => false, 'status' => 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
     = ['id' => 'int', 'category' => '\\Ally\\PetStore\\Schema\\Category', 'name' => 'string', 'photo_urls' => 'string[]', 'tags' => '\\Ally\\PetStore\\Schema\\Tag[]', 'status' => 'string']

$setters

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


    protected
    static    array<string|int, string>
    $setters
     = ['id' => 'setId', 'category' => 'setCategory', 'name' => 'setName', 'photo_urls' => 'setPhotoUrls', 'tags' => 'setTags', 'status' => 'setStatus']

__construct()

Constructor


    public
                    __construct([array<string|int, mixed> $data = null ]) : mixed

Parameters

$data : array<string|int, mixed> = null: Associated array of property values initializing the model

Return values

mixed —

__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> —

getCategory()

Gets category


    public
                    getCategory() : Category|null

Return values

Category|null —

getId()

Gets id


    public
                    getId() : int|null

Return values

int|null —

getModelName()

The original name of the model.


    public
                    getModelName() : string

Return values

string —

getName()

Gets name


    public
                    getName() : string

Return values

string —

getPhotoUrls()

Gets photo_urls


    public
                    getPhotoUrls() : array<string|int, string>

Return values

array<string|int, string> —

getStatus()

Gets status


    public
                    getStatus() : string|null

Return values

string|null —

getStatusAllowableValues()

Gets allowable values of the enum


    public
                    getStatusAllowableValues() : array<string|int, string>

Return values

array<string|int, string> —

getTags()

Gets tags


    public
                    getTags() : array<string|int, Tag>|null

Return values

array<string|int, Tag>|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> —

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 —

jsonSerialize()

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


    public
                    jsonSerialize() : mixed

Return values

mixed —

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

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 $offset) : bool

Parameters

$offset : int: Offset

Return values

bool —

offsetGet()

Gets offset.


    public
                    offsetGet(int $offset) : mixed|null

Parameters

$offset : int: Offset

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

Return values

void —

offsetUnset()

Unsets offset.


    public
                    offsetUnset(int $offset) : void

Parameters

$offset : int: Offset

Return values

void —

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> —

setCategory()

Sets category


    public
                    setCategory(Category|null $category) : self

Parameters

$category : Category|null: category

Return values

self —

setId()

Sets id


    public
                    setId(int|null $id) : self

Parameters

$id : int|null: id

Return values

self —

setName()

Sets name


    public
                    setName(string $name) : self

Parameters

$name : string: name

Return values

self —

setPhotoUrls()

Sets photo_urls


    public
                    setPhotoUrls(array<string|int, string> $photo_urls) : self

Parameters

$photo_urls : array<string|int, string>: photo_urls

Return values

self —

setStatus()

Sets status


    public
                    setStatus(string|null $status) : self

Parameters

$status : string|null: pet status in the store

Return values

self —

setTags()

Sets tags


    public
                    setTags(array<string|int, Tag>|null $tags) : self

Parameters

$tags : array<string|int, Tag>|null: tags

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> —

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

Return values

void —

Pet in package Ally PetStore implements ModelInterface, ArrayAccess, JsonSerializable

Tags

Interfaces, Classes, Traits and Enums

Table of Contents

Constants

DISCRIMINATOR

Tags

STATUS_AVAILABLE

Tags

STATUS_PENDING

Tags

STATUS_SOLD

Tags

Properties

$attributeMap

Tags

$container

Tags

$getters

Tags

$openAPIFormats

Tags

$openAPIModelName

Tags

$openAPINullables

Tags

$openAPINullablesSetToNull

Tags

$openAPITypes

Tags

$setters

Tags

Methods

__construct()

Parameters

Tags

Return values

__toString()

Tags

Return values

attributeMap()

Return values

getCategory()

Tags

Return values

getId()

Tags

Return values

getModelName()

Tags

Return values

getName()

Tags

Return values

getPhotoUrls()

Tags

Return values

getStatus()

Tags

Return values

getStatusAllowableValues()

Tags

Return values

getTags()

Tags

Return values

getters()

Return values

isNullable()

Parameters

Tags

Return values

isNullableSetToNull()

Parameters

Tags

Return values

jsonSerialize()

Tags

Return values

listInvalidProperties()

Pet
in package

Ally

PetStore

implements ModelInterface, ArrayAccess, JsonSerializable