Documentation

PageAttachmentEntity
in package
implements ModelInterface, ArrayAccess, JsonSerializable

PageAttachmentEntity Class Doc Comment

Tags
category

Class

description

Paginated attachment entity results. Page index starts at zero. Projection results may omit larger entity fields. For fetching a full entity use the projection ID with individual method calls.

author

OpenAPI Generator team

link
https://openapi-generator.tech
implements

\ArrayAccess<string, mixed>

Interfaces, Classes, Traits and Enums

ModelInterface
Interface abstracting model access.
ArrayAccess
JsonSerializable

Table of Contents

DISCRIMINATOR  = null
$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, mixed>
Array of nullable properties. Used for (de)serialization
$openAPINullablesSetToNull  : array<string|int, mixed>
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
getContent()  : array<string|int, AttachmentProjection>|null
Gets content
getEmpty()  : bool|null
Gets empty
getFirst()  : bool|null
Gets first
getLast()  : bool|null
Gets last
getModelName()  : string
The original name of the model.
getNumber()  : int|null
Gets number
getNumberOfElements()  : int|null
Gets number_of_elements
getPageable()  : PageableObject|null
Gets pageable
getSize()  : int|null
Gets size
getSort()  : SortObject|null
Gets sort
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getTotalElements()  : int
Gets total_elements
getTotalPages()  : int
Gets total_pages
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
setContent()  : self
Sets content
setEmpty()  : self
Sets empty
setFirst()  : self
Sets first
setLast()  : self
Sets last
setNumber()  : self
Sets number
setNumberOfElements()  : self
Sets number_of_elements
setPageable()  : self
Sets pageable
setSize()  : self
Sets size
setSort()  : self
Sets sort
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setTotalElements()  : self
Sets total_elements
setTotalPages()  : self
Sets total_pages
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 = ['content' => 'content', 'pageable' => 'pageable', 'total_pages' => 'totalPages', 'total_elements' => 'totalElements', 'last' => 'last', 'number_of_elements' => 'numberOfElements', 'size' => 'size', 'number' => 'number', 'sort' => 'sort', 'first' => 'first', 'empty' => 'empty']

$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 = ['content' => 'getContent', 'pageable' => 'getPageable', 'total_pages' => 'getTotalPages', 'total_elements' => 'getTotalElements', 'last' => 'getLast', 'number_of_elements' => 'getNumberOfElements', 'size' => 'getSize', 'number' => 'getNumber', 'sort' => 'getSort', 'first' => 'getFirst', 'empty' => 'getEmpty']

$openAPIFormats

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

protected static array<string|int, string> $openAPIFormats = ['content' => null, 'pageable' => null, 'total_pages' => 'int32', 'total_elements' => 'int64', 'last' => null, 'number_of_elements' => 'int32', 'size' => 'int32', 'number' => 'int32', 'sort' => null, 'first' => null, 'empty' => 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 = 'PageAttachmentEntity'

$openAPINullables

Array of nullable properties. Used for (de)serialization

protected static array<string|int, mixed> $openAPINullables = ['content' => false, 'pageable' => false, 'total_pages' => false, 'total_elements' => false, 'last' => false, 'number_of_elements' => false, 'size' => false, 'number' => false, 'sort' => false, 'first' => false, 'empty' => false]

$openAPINullablesSetToNull

If a nullable field gets set to null, insert it here

protected array<string|int, mixed> $openAPINullablesSetToNull = []

$openAPITypes

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

protected static array<string|int, string> $openAPITypes = ['content' => '\\MailSlurp\\Models\\AttachmentProjection[]', 'pageable' => '\\MailSlurp\\Models\\PageableObject', 'total_pages' => 'int', 'total_elements' => 'int', 'last' => 'bool', 'number_of_elements' => 'int', 'size' => 'int', 'number' => 'int', 'sort' => '\\MailSlurp\\Models\\SortObject', 'first' => 'bool', 'empty' => 'bool']

$setters

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

protected static array<string|int, string> $setters = ['content' => 'setContent', 'pageable' => 'setPageable', 'total_pages' => 'setTotalPages', 'total_elements' => 'setTotalElements', 'last' => 'setLast', 'number_of_elements' => 'setNumberOfElements', 'size' => 'setSize', 'number' => 'setNumber', 'sort' => 'setSort', 'first' => 'setFirst', 'empty' => 'setEmpty']

Methods

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getNumberOfElements()

Gets number_of_elements

public getNumberOfElements() : 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>

getTotalElements()

Gets total_elements

public getTotalElements() : int
Return values
int

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

setEmpty()

Sets empty

public setEmpty(bool|null $empty) : self
Parameters
$empty : bool|null

empty

Return values
self

setFirst()

Sets first

public setFirst(bool|null $first) : self
Parameters
$first : bool|null

first

Return values
self

setLast()

Sets last

public setLast(bool|null $last) : self
Parameters
$last : bool|null

last

Return values
self

setNumber()

Sets number

public setNumber(int|null $number) : self
Parameters
$number : int|null

number

Return values
self

setNumberOfElements()

Sets number_of_elements

public setNumberOfElements(int|null $number_of_elements) : self
Parameters
$number_of_elements : int|null

number_of_elements

Return values
self

setSize()

Sets size

public setSize(int|null $size) : self
Parameters
$size : int|null

size

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>

setTotalElements()

Sets total_elements

public setTotalElements(int $total_elements) : self
Parameters
$total_elements : int

total_elements

Return values
self

setTotalPages()

Sets total_pages

public setTotalPages(int $total_pages) : self
Parameters
$total_pages : int

total_pages

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
Return values
void

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>
Return values
void

Search results