DocGenFormField
in package
implements
ModelInterface, ArrayAccess
DocGenFormField 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
- getConnectedObjectDetails() : ConnectedObjectDetails
- Gets connected_object_details
- getDefaultValue() : string|null
- Gets default_value
- getDescription() : string|null
- Gets description
- getFilter() : object
- Gets filter
- getFormat() : DocGenFormat
- Gets format
- getFullyQualifiedPath() : string|null
- Gets fully_qualified_path
- getHidden() : bool|null
- Gets hidden
- getLabel() : string|null
- Gets label
- getModelName() : string
- The original name of the model.
- getName() : string|null
- Gets name
- getOptions() : array<string|int, DocGenFormFieldOption>
- Gets options
- getOrder() : string|null
- Gets order
- getPredefinedValidation() : string|null
- Gets predefined_validation
- getReadOnly() : bool|null
- Gets read_only
- getRequired() : string|null
- Gets required
- getRowValues() : array<string|int, DocGenFormFieldRowValue>
- Gets row_values
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getType() : string|null
- Gets type
- getValidation() : DocGenFormFieldValidation
- Gets validation
- getValue() : string|null
- Gets value
- 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.
- setConnectedObjectDetails() : $this
- Sets connected_object_details
- setDefaultValue() : $this
- Sets default_value
- setDescription() : $this
- Sets description
- setFilter() : $this
- Sets filter
- setFormat() : $this
- Sets format
- setFullyQualifiedPath() : $this
- Sets fully_qualified_path
- setHidden() : $this
- Sets hidden
- setLabel() : $this
- Sets label
- setName() : $this
- Sets name
- setOptions() : $this
- Sets options
- setOrder() : $this
- Sets order
- setPredefinedValidation() : $this
- Sets predefined_validation
- setReadOnly() : $this
- Sets read_only
- setRequired() : $this
- Sets required
- setRowValues() : $this
- Sets row_values
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setType() : $this
- Sets type
- setValidation() : $this
- Sets validation
- setValue() : $this
- Sets value
- 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
= ['connected_object_details' => 'connectedObjectDetails', 'default_value' => 'defaultValue', 'description' => 'description', 'filter' => 'filter', 'format' => 'format', 'fully_qualified_path' => 'fullyQualifiedPath', 'hidden' => 'hidden', 'label' => 'label', 'name' => 'name', 'options' => 'options', 'order' => 'order', 'predefined_validation' => 'predefinedValidation', 'read_only' => 'readOnly', 'required' => 'required', 'row_values' => 'rowValues', 'type' => 'type', 'validation' => 'validation', 'value' => 'value']
$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
= ['connected_object_details' => 'getConnectedObjectDetails', 'default_value' => 'getDefaultValue', 'description' => 'getDescription', 'filter' => 'getFilter', 'format' => 'getFormat', 'fully_qualified_path' => 'getFullyQualifiedPath', 'hidden' => 'getHidden', 'label' => 'getLabel', 'name' => 'getName', 'options' => 'getOptions', 'order' => 'getOrder', 'predefined_validation' => 'getPredefinedValidation', 'read_only' => 'getReadOnly', 'required' => 'getRequired', 'row_values' => 'getRowValues', 'type' => 'getType', 'validation' => 'getValidation', 'value' => 'getValue']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['connected_object_details' => 'setConnectedObjectDetails', 'default_value' => 'setDefaultValue', 'description' => 'setDescription', 'filter' => 'setFilter', 'format' => 'setFormat', 'fully_qualified_path' => 'setFullyQualifiedPath', 'hidden' => 'setHidden', 'label' => 'setLabel', 'name' => 'setName', 'options' => 'setOptions', 'order' => 'setOrder', 'predefined_validation' => 'setPredefinedValidation', 'read_only' => 'setReadOnly', 'required' => 'setRequired', 'row_values' => 'setRowValues', 'type' => 'setType', 'validation' => 'setValidation', 'value' => 'setValue']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['connected_object_details' => null, 'default_value' => null, 'description' => null, 'filter' => null, 'format' => null, 'fully_qualified_path' => null, 'hidden' => null, 'label' => null, 'name' => null, 'options' => null, 'order' => null, 'predefined_validation' => null, 'read_only' => null, 'required' => null, 'row_values' => null, 'type' => null, 'validation' => null, 'value' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'docGenFormField'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['connected_object_details' => '\\DocuSign\\eSign\\Model\\ConnectedObjectDetails', 'default_value' => '?string', 'description' => '?string', 'filter' => 'object', 'format' => '\\DocuSign\\eSign\\Model\\DocGenFormat', 'fully_qualified_path' => '?string', 'hidden' => '?bool', 'label' => '?string', 'name' => '?string', 'options' => '\\DocuSign\\eSign\\Model\\DocGenFormFieldOption[]', 'order' => '?string', 'predefined_validation' => '?string', 'read_only' => '?bool', 'required' => '?string', 'row_values' => '\\DocuSign\\eSign\\Model\\DocGenFormFieldRowValue[]', 'type' => '?string', 'validation' => '\\DocuSign\\eSign\\Model\\DocGenFormFieldValidation', 'value' => '?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> —getConnectedObjectDetails()
Gets connected_object_details
public
getConnectedObjectDetails() : ConnectedObjectDetails
Return values
ConnectedObjectDetails —getDefaultValue()
Gets default_value
public
getDefaultValue() : string|null
Return values
string|null —getDescription()
Gets description
public
getDescription() : string|null
Return values
string|null —getFilter()
Gets filter
public
getFilter() : object
Return values
object —getFormat()
Gets format
public
getFormat() : DocGenFormat
Return values
DocGenFormat —getFullyQualifiedPath()
Gets fully_qualified_path
public
getFullyQualifiedPath() : string|null
Return values
string|null —getHidden()
Gets hidden
public
getHidden() : bool|null
Return values
bool|null —getLabel()
Gets label
public
getLabel() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getName()
Gets name
public
getName() : string|null
Return values
string|null —getOptions()
Gets options
public
getOptions() : array<string|int, DocGenFormFieldOption>
Return values
array<string|int, DocGenFormFieldOption> —getOrder()
Gets order
public
getOrder() : string|null
Return values
string|null —getPredefinedValidation()
Gets predefined_validation
public
getPredefinedValidation() : string|null
Return values
string|null —getReadOnly()
Gets read_only
public
getReadOnly() : bool|null
Return values
bool|null —getRequired()
Gets required
public
getRequired() : string|null
Return values
string|null —getRowValues()
Gets row_values
public
getRowValues() : array<string|int, DocGenFormFieldRowValue>
Return values
array<string|int, DocGenFormFieldRowValue> —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getType()
Gets type
public
getType() : string|null
Return values
string|null —getValidation()
Gets validation
public
getValidation() : DocGenFormFieldValidation
Return values
DocGenFormFieldValidation —getValue()
Gets value
public
getValue() : 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 —setConnectedObjectDetails()
Sets connected_object_details
public
setConnectedObjectDetails(ConnectedObjectDetails $connected_object_details) : $this
Parameters
- $connected_object_details : ConnectedObjectDetails
Return values
$this —setDefaultValue()
Sets default_value
public
setDefaultValue(string|null $default_value) : $this
Parameters
- $default_value : string|null
Return values
$this —setDescription()
Sets description
public
setDescription(string|null $description) : $this
Parameters
- $description : string|null
Return values
$this —setFilter()
Sets filter
public
setFilter(object $filter) : $this
Parameters
- $filter : object
Return values
$this —setFormat()
Sets format
public
setFormat(DocGenFormat $format) : $this
Parameters
- $format : DocGenFormat
Return values
$this —setFullyQualifiedPath()
Sets fully_qualified_path
public
setFullyQualifiedPath(string|null $fully_qualified_path) : $this
Parameters
- $fully_qualified_path : string|null
Return values
$this —setHidden()
Sets hidden
public
setHidden(bool|null $hidden) : $this
Parameters
- $hidden : bool|null
Return values
$this —setLabel()
Sets label
public
setLabel(string|null $label) : $this
Parameters
- $label : string|null
Return values
$this —setName()
Sets name
public
setName(string|null $name) : $this
Parameters
- $name : string|null
Return values
$this —setOptions()
Sets options
public
setOptions(array<string|int, DocGenFormFieldOption> $options) : $this
Parameters
- $options : array<string|int, DocGenFormFieldOption>
Return values
$this —setOrder()
Sets order
public
setOrder(string|null $order) : $this
Parameters
- $order : string|null
Return values
$this —setPredefinedValidation()
Sets predefined_validation
public
setPredefinedValidation(string|null $predefined_validation) : $this
Parameters
- $predefined_validation : string|null
Return values
$this —setReadOnly()
Sets read_only
public
setReadOnly(bool|null $read_only) : $this
Parameters
- $read_only : bool|null
Return values
$this —setRequired()
Sets required
public
setRequired(string|null $required) : $this
Parameters
- $required : string|null
-
When set to true, the signer is required to fill out this tab
Return values
$this —setRowValues()
Sets row_values
public
setRowValues(array<string|int, DocGenFormFieldRowValue> $row_values) : $this
Parameters
- $row_values : array<string|int, DocGenFormFieldRowValue>
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> —setType()
Sets type
public
setType(string|null $type) : $this
Parameters
- $type : string|null
Return values
$this —setValidation()
Sets validation
public
setValidation(DocGenFormFieldValidation $validation) : $this
Parameters
- $validation : DocGenFormFieldValidation
Return values
$this —setValue()
Sets value
public
setValue(string|null $value) : $this
Parameters
- $value : string|null
-
Specifies the value of the tab.
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