Documentation

DocGenFormFields
in package
implements ModelInterface, ArrayAccess

DocGenFormFields 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
getDocGenDocumentStatus()  : string|null
Gets doc_gen_document_status
getDocGenErrors()  : array<string|int, DocGenSyntaxError>
Gets doc_gen_errors
getDocGenFormFieldList()  : array<string|int, DocGenFormField>
Gets doc_gen_form_field_list
getDocumentId()  : string|null
Gets document_id
getModelName()  : string
The original name of the model.
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.
setDocGenDocumentStatus()  : $this
Sets doc_gen_document_status
setDocGenErrors()  : $this
Sets doc_gen_errors
setDocGenFormFieldList()  : $this
Sets doc_gen_form_field_list
setDocumentId()  : $this
Sets document_id
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

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 = ['doc_gen_document_status' => 'docGenDocumentStatus', 'doc_gen_errors' => 'docGenErrors', 'doc_gen_form_field_list' => 'docGenFormFieldList', 'document_id' => 'documentId']

$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 = ['doc_gen_document_status' => 'getDocGenDocumentStatus', 'doc_gen_errors' => 'getDocGenErrors', 'doc_gen_form_field_list' => 'getDocGenFormFieldList', 'document_id' => 'getDocumentId']

$setters

Array of attributes to setter functions (for deserialization of responses)

protected static array<string|int, string> $setters = ['doc_gen_document_status' => 'setDocGenDocumentStatus', 'doc_gen_errors' => 'setDocGenErrors', 'doc_gen_form_field_list' => 'setDocGenFormFieldList', 'document_id' => 'setDocumentId']

$swaggerFormats

Array of property to format mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerFormats = ['doc_gen_document_status' => null, 'doc_gen_errors' => null, 'doc_gen_form_field_list' => null, 'document_id' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'docGenFormFields'

$swaggerTypes

Array of property to type mappings. Used for (de)serialization

protected static array<string|int, string> $swaggerTypes = ['doc_gen_document_status' => '?string', 'doc_gen_errors' => '\\DocuSign\\eSign\\Model\\DocGenSyntaxError[]', 'doc_gen_form_field_list' => '\\DocuSign\\eSign\\Model\\DocGenFormField[]', 'document_id' => '?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> —

getDocGenDocumentStatus()

Gets doc_gen_document_status

public getDocGenDocumentStatus() : string|null
Return values
string|null —

getDocumentId()

Gets document_id

public getDocumentId() : string|null
Return values
string|null —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

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 —

setDocGenDocumentStatus()

Sets doc_gen_document_status

public setDocGenDocumentStatus(string|null $doc_gen_document_status) : $this
Parameters
$doc_gen_document_status : string|null
Return values
$this —

setDocGenFormFieldList()

Sets doc_gen_form_field_list

public setDocGenFormFieldList(array<string|int, DocGenFormField> $doc_gen_form_field_list) : $this
Parameters
$doc_gen_form_field_list : array<string|int, DocGenFormField>
Return values
$this —

setDocumentId()

Sets document_id

public setDocumentId(string|null $document_id) : $this
Parameters
$document_id : string|null

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

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

Search results