MatchBox
in package
implements
ModelInterface, ArrayAccess
MatchBox 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
- getHeight() : string|null
- Gets height
- getModelName() : string
- The original name of the model.
- getPageNumber() : string|null
- Gets page_number
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getWidth() : string|null
- Gets width
- getXPosition() : string|null
- Gets x_position
- getYPosition() : string|null
- Gets y_position
- 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.
- setHeight() : $this
- Sets height
- setPageNumber() : $this
- Sets page_number
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setWidth() : $this
- Sets width
- setXPosition() : $this
- Sets x_position
- setYPosition() : $this
- Sets y_position
- 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
= ['height' => 'height', 'page_number' => 'pageNumber', 'width' => 'width', 'x_position' => 'xPosition', 'y_position' => 'yPosition']
$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
= ['height' => 'getHeight', 'page_number' => 'getPageNumber', 'width' => 'getWidth', 'x_position' => 'getXPosition', 'y_position' => 'getYPosition']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['height' => 'setHeight', 'page_number' => 'setPageNumber', 'width' => 'setWidth', 'x_position' => 'setXPosition', 'y_position' => 'setYPosition']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['height' => null, 'page_number' => null, 'width' => null, 'x_position' => null, 'y_position' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'matchBox'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['height' => '?string', 'page_number' => '?string', 'width' => '?string', 'x_position' => '?string', 'y_position' => '?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> —getHeight()
Gets height
public
getHeight() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPageNumber()
Gets page_number
public
getPageNumber() : 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 —getXPosition()
Gets x_position
public
getXPosition() : string|null
Return values
string|null —getYPosition()
Gets y_position
public
getYPosition() : 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 —setHeight()
Sets height
public
setHeight(string|null $height) : $this
Parameters
- $height : string|null
-
Height of the tab in pixels.
Return values
$this —setPageNumber()
Sets page_number
public
setPageNumber(string|null $page_number) : $this
Parameters
- $page_number : string|null
-
Specifies the page number on which the tab is located.
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 —setXPosition()
Sets x_position
public
setXPosition(string|null $x_position) : $this
Parameters
- $x_position : string|null
-
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
Return values
$this —setYPosition()
Sets y_position
public
setYPosition(string|null $y_position) : $this
Parameters
- $y_position : string|null
-
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
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