Page
in package
implements
ModelInterface, ArrayAccess
Page Class Doc Comment
Tags
Interfaces, Classes, Traits and Enums
- ModelInterface
- Interface abstracting model access.
- ArrayAccess
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)
- $setters : array<string|int, string>
- Array of attributes to setter functions (for deserialization of responses)
- $swaggerFormats : array<string|int, string>
- Array of property to format mappings. Used for (de)serialization
- $swaggerModelName : string
- The original name of the model.
- $swaggerTypes : array<string|int, string>
- Array of property to type mappings. Used for (de)serialization
- __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
- getDpi() : string|null
- Gets dpi
- getErrorDetails() : ErrorDetails
- Gets error_details
- getHeight() : string|null
- Gets height
- getImageBytes() : string|null
- Gets image_bytes
- getMimeType() : string|null
- Gets mime_type
- getModelName() : string
- The original name of the model.
- getPageId() : string|null
- Gets page_id
- getSequence() : string|null
- Gets sequence
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWidth() : string|null
- Gets width
- listInvalidProperties() : array<string|int, mixed>
- Show all the invalid properties with reasons.
- offsetExists() : bool
- Returns true if offset exists. False otherwise.
- offsetGet() : mixed
- Gets offset.
- offsetSet() : void
- Sets value based on offset.
- offsetUnset() : void
- Unsets offset.
- setDpi() : $this
- Sets dpi
- setErrorDetails() : $this
- Sets error_details
- setHeight() : $this
- Sets height
- setImageBytes() : $this
- Sets image_bytes
- setMimeType() : $this
- Sets mime_type
- setPageId() : $this
- Sets page_id
- setSequence() : $this
- Sets sequence
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWidth() : $this
- Sets width
- swaggerFormats() : array<string|int, mixed>
- Array of property to format mappings. Used for (de)serialization
- swaggerTypes() : array<string|int, mixed>
- Array of property to type mappings. Used for (de)serialization
- valid() : bool
- Validate all the properties in the model return true if all passed
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
= ['dpi' => 'dpi', 'error_details' => 'errorDetails', 'height' => 'height', 'image_bytes' => 'imageBytes', 'mime_type' => 'mimeType', 'page_id' => 'pageId', 'sequence' => 'sequence', 'width' => 'width']
$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
= ['dpi' => 'getDpi', 'error_details' => 'getErrorDetails', 'height' => 'getHeight', 'image_bytes' => 'getImageBytes', 'mime_type' => 'getMimeType', 'page_id' => 'getPageId', 'sequence' => 'getSequence', 'width' => 'getWidth']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['dpi' => 'setDpi', 'error_details' => 'setErrorDetails', 'height' => 'setHeight', 'image_bytes' => 'setImageBytes', 'mime_type' => 'setMimeType', 'page_id' => 'setPageId', 'sequence' => 'setSequence', 'width' => 'setWidth']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['dpi' => null, 'error_details' => null, 'height' => null, 'image_bytes' => null, 'mime_type' => null, 'page_id' => null, 'sequence' => null, 'width' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'page'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['dpi' => '?string', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'height' => '?string', 'image_bytes' => '?string', 'mime_type' => '?string', 'page_id' => '?string', 'sequence' => '?string', 'width' => '?string']
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> —getDpi()
Gets dpi
public
getDpi() : string|null
Return values
string|null —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getHeight()
Gets height
public
getHeight() : string|null
Return values
string|null —getImageBytes()
Gets image_bytes
public
getImageBytes() : string|null
Return values
string|null —getMimeType()
Gets mime_type
public
getMimeType() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPageId()
Gets page_id
public
getPageId() : string|null
Return values
string|null —getSequence()
Gets sequence
public
getSequence() : string|null
Return values
string|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> —getWidth()
Gets width
public
getWidth() : string|null
Return values
string|null —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
Parameters
- $offset : int
-
Offset
Return values
mixed —offsetSet()
Sets value based on offset.
public
offsetSet(int $offset, mixed $value) : void
Parameters
- $offset : int
-
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 —setDpi()
Sets dpi
public
setDpi(string|null $dpi) : $this
Parameters
- $dpi : string|null
-
The number of dots per inch used for the page image.
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setHeight()
Sets height
public
setHeight(string|null $height) : $this
Parameters
- $height : string|null
-
Height of the tab in pixels.
Return values
$this —setImageBytes()
Sets image_bytes
public
setImageBytes(string|null $image_bytes) : $this
Parameters
- $image_bytes : string|null
Return values
$this —setMimeType()
Sets mime_type
public
setMimeType(string|null $mime_type) : $this
Parameters
- $mime_type : string|null
Return values
$this —setPageId()
Sets page_id
public
setPageId(string|null $page_id) : $this
Parameters
- $page_id : string|null
Return values
$this —setSequence()
Sets sequence
public
setSequence(string|null $sequence) : $this
Parameters
- $sequence : string|null
Return values
$this —setters()
Array of attributes to setter functions (for deserialization of responses)
public
static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —setWidth()
Sets width
public
setWidth(string|null $width) : $this
Parameters
- $width : string|null
-
Width of the tab in pixels.
Return values
$this —swaggerFormats()
Array of property to format mappings. Used for (de)serialization
public
static swaggerFormats() : array<string|int, mixed>
Return values
array<string|int, mixed> —swaggerTypes()
Array of property to type mappings. Used for (de)serialization
public
static swaggerTypes() : 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 —True if all properties are valid