PageableObject
in package
implements
ModelInterface, ArrayAccess, JsonSerializable
PageableObject Class Doc Comment
Tags
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
- getModelName() : string
- The original name of the model.
- getOffset() : int|null
- Gets offset
- getPaged() : bool|null
- Gets paged
- getPageNumber() : int|null
- Gets page_number
- getPageSize() : int|null
- Gets page_size
- getSort() : SortObject|null
- Gets sort
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnpaged() : bool|null
- Gets unpaged
- 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
- setOffset() : self
- Sets offset
- setPaged() : self
- Sets paged
- setPageNumber() : self
- Sets page_number
- setPageSize() : self
- Sets page_size
- setSort() : self
- Sets sort
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnpaged() : self
- Sets unpaged
- 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
DISCRIMINATOR
public
mixed
DISCRIMINATOR
= null
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
= ['page_number' => 'pageNumber', 'page_size' => 'pageSize', 'unpaged' => 'unpaged', 'paged' => 'paged', 'offset' => 'offset', 'sort' => 'sort']
$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
= ['page_number' => 'getPageNumber', 'page_size' => 'getPageSize', 'unpaged' => 'getUnpaged', 'paged' => 'getPaged', 'offset' => 'getOffset', 'sort' => 'getSort']
$openAPIFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$openAPIFormats
= ['page_number' => 'int32', 'page_size' => 'int32', 'unpaged' => null, 'paged' => null, 'offset' => 'int64', 'sort' => null]
Tags
$openAPIModelName
The original name of the model.
protected
static string
$openAPIModelName
= 'PageableObject'
$openAPINullables
Array of nullable properties. Used for (de)serialization
protected
static array<string|int, mixed>
$openAPINullables
= ['page_number' => false, 'page_size' => false, 'unpaged' => false, 'paged' => false, 'offset' => false, 'sort' => 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
= ['page_number' => 'int', 'page_size' => 'int', 'unpaged' => 'bool', 'paged' => 'bool', 'offset' => 'int', 'sort' => '\\MailSlurp\\Models\\SortObject']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['page_number' => 'setPageNumber', 'page_size' => 'setPageSize', 'unpaged' => 'setUnpaged', 'paged' => 'setPaged', 'offset' => 'setOffset', 'sort' => 'setSort']
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 —getOffset()
Gets offset
public
getOffset() : int|null
Return values
int|null —getPaged()
Gets paged
public
getPaged() : bool|null
Return values
bool|null —getPageNumber()
Gets page_number
public
getPageNumber() : int|null
Return values
int|null —getPageSize()
Gets page_size
public
getPageSize() : int|null
Return values
int|null —getSort()
Gets sort
public
getSort() : SortObject|null
Return values
SortObject|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> —getUnpaged()
Gets unpaged
public
getUnpaged() : bool|null
Return values
bool|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 —jsonSerialize()
Serializes the object to a value that can be serialized natively by json_encode().
public
jsonSerialize() : mixed
Tags
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> —setOffset()
Sets offset
public
setOffset(int|null $offset) : self
Parameters
- $offset : int|null
-
offset
Return values
self —setPaged()
Sets paged
public
setPaged(bool|null $paged) : self
Parameters
- $paged : bool|null
-
paged
Return values
self —setPageNumber()
Sets page_number
public
setPageNumber(int|null $page_number) : self
Parameters
- $page_number : int|null
-
page_number
Return values
self —setPageSize()
Sets page_size
public
setPageSize(int|null $page_size) : self
Parameters
- $page_size : int|null
-
page_size
Return values
self —setSort()
Sets sort
public
setSort(SortObject|null $sort) : self
Parameters
- $sort : SortObject|null
-
sort
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> —setUnpaged()
Sets unpaged
public
setUnpaged(bool|null $unpaged) : self
Parameters
- $unpaged : bool|null
-
unpaged
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>