Documentation

DocGenFormField
in package
implements ModelInterface, ArrayAccess

DocGenFormField Class Doc Comment

Tags
category

Class

author

Swagger Codegen team apihelp@docusign.com

license

The DocuSign PHP Client SDK is licensed under the MIT License.

link
https://github.com/swagger-api/swagger-codegen

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
getDescription()  : string|null
Gets description
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
getPredefinedValidation()  : string|null
Gets predefined_validation
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.
setDescription()  : $this
Sets description
setLabel()  : $this
Sets label
setName()  : $this
Sets name
setOptions()  : $this
Sets options
setPredefinedValidation()  : $this
Sets predefined_validation
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

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 = ['description' => 'description', 'label' => 'label', 'name' => 'name', 'options' => 'options', 'predefined_validation' => 'predefinedValidation', '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 = ['description' => 'getDescription', 'label' => 'getLabel', 'name' => 'getName', 'options' => 'getOptions', 'predefined_validation' => 'getPredefinedValidation', '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 = ['description' => 'setDescription', 'label' => 'setLabel', 'name' => 'setName', 'options' => 'setOptions', 'predefined_validation' => 'setPredefinedValidation', '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 = ['description' => null, 'label' => null, 'name' => null, 'options' => null, 'predefined_validation' => 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 = ['description' => '?string', 'label' => '?string', 'name' => '?string', 'options' => '\\DocuSign\\eSign\\Model\\DocGenFormFieldOption[]', 'predefined_validation' => '?string', '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>

getDescription()

Gets description

public getDescription() : string|null
Return values
string|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

getPredefinedValidation()

Gets predefined_validation

public getPredefinedValidation() : string|null
Return values
string|null

getRequired()

Gets required

public getRequired() : 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>

getType()

Gets type

public getType() : string|null
Return values
string|null

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

setDescription()

Sets description

public setDescription(string|null $description) : $this
Parameters
$description : string|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

setPredefinedValidation()

Sets predefined_validation

public setPredefinedValidation(string|null $predefined_validation) : $this
Parameters
$predefined_validation : string|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

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

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

Search results