Documentation

CompositeTemplate
in package
implements ModelInterface, ArrayAccess

CompositeTemplate Class Doc Comment

Tags
category

Class

description

This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/

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
getCompositeTemplateId()  : string|null
Gets composite_template_id
getDocument()  : Document
Gets document
getInlineTemplates()  : array<string|int, InlineTemplate>
Gets inline_templates
getModelName()  : string
The original name of the model.
getPdfMetaDataTemplateSequence()  : string|null
Gets pdf_meta_data_template_sequence
getServerTemplates()  : array<string|int, ServerTemplate>
Gets server_templates
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.
setCompositeTemplateId()  : $this
Sets composite_template_id
setDocument()  : $this
Sets document
setInlineTemplates()  : $this
Sets inline_templates
setPdfMetaDataTemplateSequence()  : $this
Sets pdf_meta_data_template_sequence
setServerTemplates()  : $this
Sets server_templates
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 = ['composite_template_id' => 'compositeTemplateId', 'document' => 'document', 'inline_templates' => 'inlineTemplates', 'pdf_meta_data_template_sequence' => 'pdfMetaDataTemplateSequence', 'server_templates' => 'serverTemplates']

$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 = ['composite_template_id' => 'getCompositeTemplateId', 'document' => 'getDocument', 'inline_templates' => 'getInlineTemplates', 'pdf_meta_data_template_sequence' => 'getPdfMetaDataTemplateSequence', 'server_templates' => 'getServerTemplates']

$setters

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

protected static array<string|int, string> $setters = ['composite_template_id' => 'setCompositeTemplateId', 'document' => 'setDocument', 'inline_templates' => 'setInlineTemplates', 'pdf_meta_data_template_sequence' => 'setPdfMetaDataTemplateSequence', 'server_templates' => 'setServerTemplates']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['composite_template_id' => null, 'document' => null, 'inline_templates' => null, 'pdf_meta_data_template_sequence' => null, 'server_templates' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'compositeTemplate'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['composite_template_id' => '?string', 'document' => '\\DocuSign\\eSign\\Model\\Document', 'inline_templates' => '\\DocuSign\\eSign\\Model\\InlineTemplate[]', 'pdf_meta_data_template_sequence' => '?string', 'server_templates' => '\\DocuSign\\eSign\\Model\\ServerTemplate[]']

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> —

getCompositeTemplateId()

Gets composite_template_id

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getPdfMetaDataTemplateSequence()

Gets pdf_meta_data_template_sequence

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

setCompositeTemplateId()

Sets composite_template_id

public setCompositeTemplateId(string|null $composite_template_id) : $this
Parameters
$composite_template_id : string|null

The identify of this composite template. It is used as a reference when adding document object information. If used, the document's content-disposition must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the documentId property only. If no document object is specified, the composite template inherits the first document.

Return values
$this —

setDocument()

Sets document

public setDocument(Document $document) : $this
Parameters
$document : Document

An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.

Return values
$this —

setInlineTemplates()

Sets inline_templates

public setInlineTemplates(array<string|int, InlineTemplate> $inline_templates) : $this
Parameters
$inline_templates : array<string|int, InlineTemplate>

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

Return values
$this —

setPdfMetaDataTemplateSequence()

Sets pdf_meta_data_template_sequence

public setPdfMetaDataTemplateSequence(string|null $pdf_meta_data_template_sequence) : $this
Parameters
$pdf_meta_data_template_sequence : string|null
Return values
$this —

setServerTemplates()

Sets server_templates

public setServerTemplates(array<string|int, ServerTemplate> $server_templates) : $this
Parameters
$server_templates : array<string|int, ServerTemplate>

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

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