DocumentHtmlDisplayAnchor
in package
implements
ModelInterface, ArrayAccess
DocumentHtmlDisplayAnchor 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
- getCaseSensitive() : bool|null
- Gets case_sensitive
- getDisplaySettings() : DocumentHtmlDisplaySettings
- Gets display_settings
- getEndAnchor() : string|null
- Gets end_anchor
- getModelName() : string
- The original name of the model.
- getRemoveEndAnchor() : bool|null
- Gets remove_end_anchor
- getRemoveStartAnchor() : bool|null
- Gets remove_start_anchor
- getStartAnchor() : string|null
- Gets start_anchor
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- 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.
- setCaseSensitive() : $this
- Sets case_sensitive
- setDisplaySettings() : $this
- Sets display_settings
- setEndAnchor() : $this
- Sets end_anchor
- setRemoveEndAnchor() : $this
- Sets remove_end_anchor
- setRemoveStartAnchor() : $this
- Sets remove_start_anchor
- setStartAnchor() : $this
- Sets start_anchor
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- 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
= ['case_sensitive' => 'caseSensitive', 'display_settings' => 'displaySettings', 'end_anchor' => 'endAnchor', 'remove_end_anchor' => 'removeEndAnchor', 'remove_start_anchor' => 'removeStartAnchor', 'start_anchor' => 'startAnchor']
$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
= ['case_sensitive' => 'getCaseSensitive', 'display_settings' => 'getDisplaySettings', 'end_anchor' => 'getEndAnchor', 'remove_end_anchor' => 'getRemoveEndAnchor', 'remove_start_anchor' => 'getRemoveStartAnchor', 'start_anchor' => 'getStartAnchor']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['case_sensitive' => 'setCaseSensitive', 'display_settings' => 'setDisplaySettings', 'end_anchor' => 'setEndAnchor', 'remove_end_anchor' => 'setRemoveEndAnchor', 'remove_start_anchor' => 'setRemoveStartAnchor', 'start_anchor' => 'setStartAnchor']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['case_sensitive' => null, 'display_settings' => null, 'end_anchor' => null, 'remove_end_anchor' => null, 'remove_start_anchor' => null, 'start_anchor' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'documentHtmlDisplayAnchor'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['case_sensitive' => '?bool', 'display_settings' => '\\DocuSign\\eSign\\Model\\DocumentHtmlDisplaySettings', 'end_anchor' => '?string', 'remove_end_anchor' => '?bool', 'remove_start_anchor' => '?bool', 'start_anchor' => '?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> —getCaseSensitive()
Gets case_sensitive
public
getCaseSensitive() : bool|null
Return values
bool|null —getDisplaySettings()
Gets display_settings
public
getDisplaySettings() : DocumentHtmlDisplaySettings
Return values
DocumentHtmlDisplaySettings —getEndAnchor()
Gets end_anchor
public
getEndAnchor() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getRemoveEndAnchor()
Gets remove_end_anchor
public
getRemoveEndAnchor() : bool|null
Return values
bool|null —getRemoveStartAnchor()
Gets remove_start_anchor
public
getRemoveStartAnchor() : bool|null
Return values
bool|null —getStartAnchor()
Gets start_anchor
public
getStartAnchor() : 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> —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 —setCaseSensitive()
Sets case_sensitive
public
setCaseSensitive(bool|null $case_sensitive) : $this
Parameters
- $case_sensitive : bool|null
Return values
$this —setDisplaySettings()
Sets display_settings
public
setDisplaySettings(DocumentHtmlDisplaySettings $display_settings) : $this
Parameters
- $display_settings : DocumentHtmlDisplaySettings
-
This object defines how the HTML section inside the
startAnchorandendAnchordisplays.
Return values
$this —setEndAnchor()
Sets end_anchor
public
setEndAnchor(string|null $end_anchor) : $this
Parameters
- $end_anchor : string|null
Return values
$this —setRemoveEndAnchor()
Sets remove_end_anchor
public
setRemoveEndAnchor(bool|null $remove_end_anchor) : $this
Parameters
- $remove_end_anchor : bool|null
Return values
$this —setRemoveStartAnchor()
Sets remove_start_anchor
public
setRemoveStartAnchor(bool|null $remove_start_anchor) : $this
Parameters
- $remove_start_anchor : bool|null
Return values
$this —setStartAnchor()
Sets start_anchor
public
setStartAnchor(string|null $start_anchor) : $this
Parameters
- $start_anchor : 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> —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