Radio
in package
implements
ModelInterface, ArrayAccess
Radio 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
- getAnchorAllowWhiteSpaceInCharacters() : string|null
- Gets anchor_allow_white_space_in_characters
- getAnchorAllowWhiteSpaceInCharactersMetadata() : PropertyMetadata
- Gets anchor_allow_white_space_in_characters_metadata
- getAnchorCaseSensitive() : string|null
- Gets anchor_case_sensitive
- getAnchorCaseSensitiveMetadata() : PropertyMetadata
- Gets anchor_case_sensitive_metadata
- getAnchorHorizontalAlignment() : string|null
- Gets anchor_horizontal_alignment
- getAnchorHorizontalAlignmentMetadata() : PropertyMetadata
- Gets anchor_horizontal_alignment_metadata
- getAnchorIgnoreIfNotPresent() : string|null
- Gets anchor_ignore_if_not_present
- getAnchorIgnoreIfNotPresentMetadata() : PropertyMetadata
- Gets anchor_ignore_if_not_present_metadata
- getAnchorMatchWholeWord() : string|null
- Gets anchor_match_whole_word
- getAnchorMatchWholeWordMetadata() : PropertyMetadata
- Gets anchor_match_whole_word_metadata
- getAnchorString() : string|null
- Gets anchor_string
- getAnchorStringMetadata() : PropertyMetadata
- Gets anchor_string_metadata
- getAnchorTabProcessorVersion() : string|null
- Gets anchor_tab_processor_version
- getAnchorTabProcessorVersionMetadata() : PropertyMetadata
- Gets anchor_tab_processor_version_metadata
- getAnchorUnits() : string|null
- Gets anchor_units
- getAnchorUnitsMetadata() : PropertyMetadata
- Gets anchor_units_metadata
- getAnchorXOffset() : string|null
- Gets anchor_x_offset
- getAnchorXOffsetMetadata() : PropertyMetadata
- Gets anchor_x_offset_metadata
- getAnchorYOffset() : string|null
- Gets anchor_y_offset
- getAnchorYOffsetMetadata() : PropertyMetadata
- Gets anchor_y_offset_metadata
- getBold() : string|null
- Gets bold
- getBoldMetadata() : PropertyMetadata
- Gets bold_metadata
- getCaption() : string|null
- Gets caption
- getCaptionMetadata() : PropertyMetadata
- Gets caption_metadata
- getErrorDetails() : ErrorDetails
- Gets error_details
- getFont() : string|null
- Gets font
- getFontColor() : string|null
- Gets font_color
- getFontColorMetadata() : PropertyMetadata
- Gets font_color_metadata
- getFontMetadata() : PropertyMetadata
- Gets font_metadata
- getFontSize() : string|null
- Gets font_size
- getFontSizeMetadata() : PropertyMetadata
- Gets font_size_metadata
- getItalic() : string|null
- Gets italic
- getItalicMetadata() : PropertyMetadata
- Gets italic_metadata
- getLocked() : string|null
- Gets locked
- getLockedMetadata() : PropertyMetadata
- Gets locked_metadata
- getMergeFieldXml() : string|null
- Gets merge_field_xml
- getModelName() : string
- The original name of the model.
- getPageNumber() : string|null
- Gets page_number
- getPageNumberMetadata() : PropertyMetadata
- Gets page_number_metadata
- getRequired() : string|null
- Gets required
- getRequiredMetadata() : PropertyMetadata
- Gets required_metadata
- getSelected() : string|null
- Gets selected
- getSelectedMetadata() : PropertyMetadata
- Gets selected_metadata
- getStatus() : string|null
- Gets status
- getStatusMetadata() : PropertyMetadata
- Gets status_metadata
- getTabId() : string|null
- Gets tab_id
- getTabIdMetadata() : PropertyMetadata
- Gets tab_id_metadata
- getTabOrder() : string|null
- Gets tab_order
- getTabOrderMetadata() : PropertyMetadata
- Gets tab_order_metadata
- getters() : array<string|int, mixed>
- Array of attributes to getter functions (for serialization of requests)
- getUnderline() : string|null
- Gets underline
- getUnderlineMetadata() : PropertyMetadata
- Gets underline_metadata
- getValue() : string|null
- Gets value
- getValueMetadata() : PropertyMetadata
- Gets value_metadata
- getXPosition() : string|null
- Gets x_position
- getXPositionMetadata() : PropertyMetadata
- Gets x_position_metadata
- getYPosition() : string|null
- Gets y_position
- getYPositionMetadata() : PropertyMetadata
- Gets y_position_metadata
- 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.
- setAnchorAllowWhiteSpaceInCharacters() : $this
- Sets anchor_allow_white_space_in_characters
- setAnchorAllowWhiteSpaceInCharactersMetadata() : $this
- Sets anchor_allow_white_space_in_characters_metadata
- setAnchorCaseSensitive() : $this
- Sets anchor_case_sensitive
- setAnchorCaseSensitiveMetadata() : $this
- Sets anchor_case_sensitive_metadata
- setAnchorHorizontalAlignment() : $this
- Sets anchor_horizontal_alignment
- setAnchorHorizontalAlignmentMetadata() : $this
- Sets anchor_horizontal_alignment_metadata
- setAnchorIgnoreIfNotPresent() : $this
- Sets anchor_ignore_if_not_present
- setAnchorIgnoreIfNotPresentMetadata() : $this
- Sets anchor_ignore_if_not_present_metadata
- setAnchorMatchWholeWord() : $this
- Sets anchor_match_whole_word
- setAnchorMatchWholeWordMetadata() : $this
- Sets anchor_match_whole_word_metadata
- setAnchorString() : $this
- Sets anchor_string
- setAnchorStringMetadata() : $this
- Sets anchor_string_metadata
- setAnchorTabProcessorVersion() : $this
- Sets anchor_tab_processor_version
- setAnchorTabProcessorVersionMetadata() : $this
- Sets anchor_tab_processor_version_metadata
- setAnchorUnits() : $this
- Sets anchor_units
- setAnchorUnitsMetadata() : $this
- Sets anchor_units_metadata
- setAnchorXOffset() : $this
- Sets anchor_x_offset
- setAnchorXOffsetMetadata() : $this
- Sets anchor_x_offset_metadata
- setAnchorYOffset() : $this
- Sets anchor_y_offset
- setAnchorYOffsetMetadata() : $this
- Sets anchor_y_offset_metadata
- setBold() : $this
- Sets bold
- setBoldMetadata() : $this
- Sets bold_metadata
- setCaption() : $this
- Sets caption
- setCaptionMetadata() : $this
- Sets caption_metadata
- setErrorDetails() : $this
- Sets error_details
- setFont() : $this
- Sets font
- setFontColor() : $this
- Sets font_color
- setFontColorMetadata() : $this
- Sets font_color_metadata
- setFontMetadata() : $this
- Sets font_metadata
- setFontSize() : $this
- Sets font_size
- setFontSizeMetadata() : $this
- Sets font_size_metadata
- setItalic() : $this
- Sets italic
- setItalicMetadata() : $this
- Sets italic_metadata
- setLocked() : $this
- Sets locked
- setLockedMetadata() : $this
- Sets locked_metadata
- setMergeFieldXml() : $this
- Sets merge_field_xml
- setPageNumber() : $this
- Sets page_number
- setPageNumberMetadata() : $this
- Sets page_number_metadata
- setRequired() : $this
- Sets required
- setRequiredMetadata() : $this
- Sets required_metadata
- setSelected() : $this
- Sets selected
- setSelectedMetadata() : $this
- Sets selected_metadata
- setStatus() : $this
- Sets status
- setStatusMetadata() : $this
- Sets status_metadata
- setTabId() : $this
- Sets tab_id
- setTabIdMetadata() : $this
- Sets tab_id_metadata
- setTabOrder() : $this
- Sets tab_order
- setTabOrderMetadata() : $this
- Sets tab_order_metadata
- setters() : array<string|int, mixed>
- Array of attributes to setter functions (for deserialization of responses)
- setUnderline() : $this
- Sets underline
- setUnderlineMetadata() : $this
- Sets underline_metadata
- setValue() : $this
- Sets value
- setValueMetadata() : $this
- Sets value_metadata
- setXPosition() : $this
- Sets x_position
- setXPositionMetadata() : $this
- Sets x_position_metadata
- setYPosition() : $this
- Sets y_position
- setYPositionMetadata() : $this
- Sets y_position_metadata
- 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
= ['anchor_allow_white_space_in_characters' => 'anchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'anchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'anchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'anchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'anchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'anchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'anchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'anchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'anchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'anchorMatchWholeWordMetadata', 'anchor_string' => 'anchorString', 'anchor_string_metadata' => 'anchorStringMetadata', 'anchor_tab_processor_version' => 'anchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'anchorTabProcessorVersionMetadata', 'anchor_units' => 'anchorUnits', 'anchor_units_metadata' => 'anchorUnitsMetadata', 'anchor_x_offset' => 'anchorXOffset', 'anchor_x_offset_metadata' => 'anchorXOffsetMetadata', 'anchor_y_offset' => 'anchorYOffset', 'anchor_y_offset_metadata' => 'anchorYOffsetMetadata', 'bold' => 'bold', 'bold_metadata' => 'boldMetadata', 'caption' => 'caption', 'caption_metadata' => 'captionMetadata', 'error_details' => 'errorDetails', 'font' => 'font', 'font_color' => 'fontColor', 'font_color_metadata' => 'fontColorMetadata', 'font_metadata' => 'fontMetadata', 'font_size' => 'fontSize', 'font_size_metadata' => 'fontSizeMetadata', 'italic' => 'italic', 'italic_metadata' => 'italicMetadata', 'locked' => 'locked', 'locked_metadata' => 'lockedMetadata', 'merge_field_xml' => 'mergeFieldXml', 'page_number' => 'pageNumber', 'page_number_metadata' => 'pageNumberMetadata', 'required' => 'required', 'required_metadata' => 'requiredMetadata', 'selected' => 'selected', 'selected_metadata' => 'selectedMetadata', 'status' => 'status', 'status_metadata' => 'statusMetadata', 'tab_id' => 'tabId', 'tab_id_metadata' => 'tabIdMetadata', 'tab_order' => 'tabOrder', 'tab_order_metadata' => 'tabOrderMetadata', 'underline' => 'underline', 'underline_metadata' => 'underlineMetadata', 'value' => 'value', 'value_metadata' => 'valueMetadata', 'x_position' => 'xPosition', 'x_position_metadata' => 'xPositionMetadata', 'y_position' => 'yPosition', 'y_position_metadata' => 'yPositionMetadata']
$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
= ['anchor_allow_white_space_in_characters' => 'getAnchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'getAnchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'getAnchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'getAnchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'getAnchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'getAnchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'getAnchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'getAnchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'getAnchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'getAnchorMatchWholeWordMetadata', 'anchor_string' => 'getAnchorString', 'anchor_string_metadata' => 'getAnchorStringMetadata', 'anchor_tab_processor_version' => 'getAnchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'getAnchorTabProcessorVersionMetadata', 'anchor_units' => 'getAnchorUnits', 'anchor_units_metadata' => 'getAnchorUnitsMetadata', 'anchor_x_offset' => 'getAnchorXOffset', 'anchor_x_offset_metadata' => 'getAnchorXOffsetMetadata', 'anchor_y_offset' => 'getAnchorYOffset', 'anchor_y_offset_metadata' => 'getAnchorYOffsetMetadata', 'bold' => 'getBold', 'bold_metadata' => 'getBoldMetadata', 'caption' => 'getCaption', 'caption_metadata' => 'getCaptionMetadata', 'error_details' => 'getErrorDetails', 'font' => 'getFont', 'font_color' => 'getFontColor', 'font_color_metadata' => 'getFontColorMetadata', 'font_metadata' => 'getFontMetadata', 'font_size' => 'getFontSize', 'font_size_metadata' => 'getFontSizeMetadata', 'italic' => 'getItalic', 'italic_metadata' => 'getItalicMetadata', 'locked' => 'getLocked', 'locked_metadata' => 'getLockedMetadata', 'merge_field_xml' => 'getMergeFieldXml', 'page_number' => 'getPageNumber', 'page_number_metadata' => 'getPageNumberMetadata', 'required' => 'getRequired', 'required_metadata' => 'getRequiredMetadata', 'selected' => 'getSelected', 'selected_metadata' => 'getSelectedMetadata', 'status' => 'getStatus', 'status_metadata' => 'getStatusMetadata', 'tab_id' => 'getTabId', 'tab_id_metadata' => 'getTabIdMetadata', 'tab_order' => 'getTabOrder', 'tab_order_metadata' => 'getTabOrderMetadata', 'underline' => 'getUnderline', 'underline_metadata' => 'getUnderlineMetadata', 'value' => 'getValue', 'value_metadata' => 'getValueMetadata', 'x_position' => 'getXPosition', 'x_position_metadata' => 'getXPositionMetadata', 'y_position' => 'getYPosition', 'y_position_metadata' => 'getYPositionMetadata']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['anchor_allow_white_space_in_characters' => 'setAnchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata' => 'setAnchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive' => 'setAnchorCaseSensitive', 'anchor_case_sensitive_metadata' => 'setAnchorCaseSensitiveMetadata', 'anchor_horizontal_alignment' => 'setAnchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata' => 'setAnchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present' => 'setAnchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata' => 'setAnchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word' => 'setAnchorMatchWholeWord', 'anchor_match_whole_word_metadata' => 'setAnchorMatchWholeWordMetadata', 'anchor_string' => 'setAnchorString', 'anchor_string_metadata' => 'setAnchorStringMetadata', 'anchor_tab_processor_version' => 'setAnchorTabProcessorVersion', 'anchor_tab_processor_version_metadata' => 'setAnchorTabProcessorVersionMetadata', 'anchor_units' => 'setAnchorUnits', 'anchor_units_metadata' => 'setAnchorUnitsMetadata', 'anchor_x_offset' => 'setAnchorXOffset', 'anchor_x_offset_metadata' => 'setAnchorXOffsetMetadata', 'anchor_y_offset' => 'setAnchorYOffset', 'anchor_y_offset_metadata' => 'setAnchorYOffsetMetadata', 'bold' => 'setBold', 'bold_metadata' => 'setBoldMetadata', 'caption' => 'setCaption', 'caption_metadata' => 'setCaptionMetadata', 'error_details' => 'setErrorDetails', 'font' => 'setFont', 'font_color' => 'setFontColor', 'font_color_metadata' => 'setFontColorMetadata', 'font_metadata' => 'setFontMetadata', 'font_size' => 'setFontSize', 'font_size_metadata' => 'setFontSizeMetadata', 'italic' => 'setItalic', 'italic_metadata' => 'setItalicMetadata', 'locked' => 'setLocked', 'locked_metadata' => 'setLockedMetadata', 'merge_field_xml' => 'setMergeFieldXml', 'page_number' => 'setPageNumber', 'page_number_metadata' => 'setPageNumberMetadata', 'required' => 'setRequired', 'required_metadata' => 'setRequiredMetadata', 'selected' => 'setSelected', 'selected_metadata' => 'setSelectedMetadata', 'status' => 'setStatus', 'status_metadata' => 'setStatusMetadata', 'tab_id' => 'setTabId', 'tab_id_metadata' => 'setTabIdMetadata', 'tab_order' => 'setTabOrder', 'tab_order_metadata' => 'setTabOrderMetadata', 'underline' => 'setUnderline', 'underline_metadata' => 'setUnderlineMetadata', 'value' => 'setValue', 'value_metadata' => 'setValueMetadata', 'x_position' => 'setXPosition', 'x_position_metadata' => 'setXPositionMetadata', 'y_position' => 'setYPosition', 'y_position_metadata' => 'setYPositionMetadata']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['anchor_allow_white_space_in_characters' => null, 'anchor_allow_white_space_in_characters_metadata' => null, 'anchor_case_sensitive' => null, 'anchor_case_sensitive_metadata' => null, 'anchor_horizontal_alignment' => null, 'anchor_horizontal_alignment_metadata' => null, 'anchor_ignore_if_not_present' => null, 'anchor_ignore_if_not_present_metadata' => null, 'anchor_match_whole_word' => null, 'anchor_match_whole_word_metadata' => null, 'anchor_string' => null, 'anchor_string_metadata' => null, 'anchor_tab_processor_version' => null, 'anchor_tab_processor_version_metadata' => null, 'anchor_units' => null, 'anchor_units_metadata' => null, 'anchor_x_offset' => null, 'anchor_x_offset_metadata' => null, 'anchor_y_offset' => null, 'anchor_y_offset_metadata' => null, 'bold' => null, 'bold_metadata' => null, 'caption' => null, 'caption_metadata' => null, 'error_details' => null, 'font' => null, 'font_color' => null, 'font_color_metadata' => null, 'font_metadata' => null, 'font_size' => null, 'font_size_metadata' => null, 'italic' => null, 'italic_metadata' => null, 'locked' => null, 'locked_metadata' => null, 'merge_field_xml' => null, 'page_number' => null, 'page_number_metadata' => null, 'required' => null, 'required_metadata' => null, 'selected' => null, 'selected_metadata' => null, 'status' => null, 'status_metadata' => null, 'tab_id' => null, 'tab_id_metadata' => null, 'tab_order' => null, 'tab_order_metadata' => null, 'underline' => null, 'underline_metadata' => null, 'value' => null, 'value_metadata' => null, 'x_position' => null, 'x_position_metadata' => null, 'y_position' => null, 'y_position_metadata' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'radio'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['anchor_allow_white_space_in_characters' => '?string', 'anchor_allow_white_space_in_characters_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_case_sensitive' => '?string', 'anchor_case_sensitive_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_horizontal_alignment' => '?string', 'anchor_horizontal_alignment_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_ignore_if_not_present' => '?string', 'anchor_ignore_if_not_present_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_match_whole_word' => '?string', 'anchor_match_whole_word_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_string' => '?string', 'anchor_string_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_tab_processor_version' => '?string', 'anchor_tab_processor_version_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_units' => '?string', 'anchor_units_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_x_offset' => '?string', 'anchor_x_offset_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'anchor_y_offset' => '?string', 'anchor_y_offset_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'bold' => '?string', 'bold_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'caption' => '?string', 'caption_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'error_details' => '\\DocuSign\\eSign\\Model\\ErrorDetails', 'font' => '?string', 'font_color' => '?string', 'font_color_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'font_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'font_size' => '?string', 'font_size_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'italic' => '?string', 'italic_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'locked' => '?string', 'locked_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'merge_field_xml' => '?string', 'page_number' => '?string', 'page_number_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'required' => '?string', 'required_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'selected' => '?string', 'selected_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'status' => '?string', 'status_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_id' => '?string', 'tab_id_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'tab_order' => '?string', 'tab_order_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'underline' => '?string', 'underline_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'value' => '?string', 'value_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'x_position' => '?string', 'x_position_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'y_position' => '?string', 'y_position_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata']
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> —getAnchorAllowWhiteSpaceInCharacters()
Gets anchor_allow_white_space_in_characters
public
getAnchorAllowWhiteSpaceInCharacters() : string|null
Return values
string|null —getAnchorAllowWhiteSpaceInCharactersMetadata()
Gets anchor_allow_white_space_in_characters_metadata
public
getAnchorAllowWhiteSpaceInCharactersMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorCaseSensitive()
Gets anchor_case_sensitive
public
getAnchorCaseSensitive() : string|null
Return values
string|null —getAnchorCaseSensitiveMetadata()
Gets anchor_case_sensitive_metadata
public
getAnchorCaseSensitiveMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorHorizontalAlignment()
Gets anchor_horizontal_alignment
public
getAnchorHorizontalAlignment() : string|null
Return values
string|null —getAnchorHorizontalAlignmentMetadata()
Gets anchor_horizontal_alignment_metadata
public
getAnchorHorizontalAlignmentMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorIgnoreIfNotPresent()
Gets anchor_ignore_if_not_present
public
getAnchorIgnoreIfNotPresent() : string|null
Return values
string|null —getAnchorIgnoreIfNotPresentMetadata()
Gets anchor_ignore_if_not_present_metadata
public
getAnchorIgnoreIfNotPresentMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorMatchWholeWord()
Gets anchor_match_whole_word
public
getAnchorMatchWholeWord() : string|null
Return values
string|null —getAnchorMatchWholeWordMetadata()
Gets anchor_match_whole_word_metadata
public
getAnchorMatchWholeWordMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorString()
Gets anchor_string
public
getAnchorString() : string|null
Return values
string|null —getAnchorStringMetadata()
Gets anchor_string_metadata
public
getAnchorStringMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorTabProcessorVersion()
Gets anchor_tab_processor_version
public
getAnchorTabProcessorVersion() : string|null
Return values
string|null —getAnchorTabProcessorVersionMetadata()
Gets anchor_tab_processor_version_metadata
public
getAnchorTabProcessorVersionMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorUnits()
Gets anchor_units
public
getAnchorUnits() : string|null
Return values
string|null —getAnchorUnitsMetadata()
Gets anchor_units_metadata
public
getAnchorUnitsMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorXOffset()
Gets anchor_x_offset
public
getAnchorXOffset() : string|null
Return values
string|null —getAnchorXOffsetMetadata()
Gets anchor_x_offset_metadata
public
getAnchorXOffsetMetadata() : PropertyMetadata
Return values
PropertyMetadata —getAnchorYOffset()
Gets anchor_y_offset
public
getAnchorYOffset() : string|null
Return values
string|null —getAnchorYOffsetMetadata()
Gets anchor_y_offset_metadata
public
getAnchorYOffsetMetadata() : PropertyMetadata
Return values
PropertyMetadata —getBold()
Gets bold
public
getBold() : string|null
Return values
string|null —getBoldMetadata()
Gets bold_metadata
public
getBoldMetadata() : PropertyMetadata
Return values
PropertyMetadata —getCaption()
Gets caption
public
getCaption() : string|null
Return values
string|null —getCaptionMetadata()
Gets caption_metadata
public
getCaptionMetadata() : PropertyMetadata
Return values
PropertyMetadata —getErrorDetails()
Gets error_details
public
getErrorDetails() : ErrorDetails
Return values
ErrorDetails —getFont()
Gets font
public
getFont() : string|null
Return values
string|null —getFontColor()
Gets font_color
public
getFontColor() : string|null
Return values
string|null —getFontColorMetadata()
Gets font_color_metadata
public
getFontColorMetadata() : PropertyMetadata
Return values
PropertyMetadata —getFontMetadata()
Gets font_metadata
public
getFontMetadata() : PropertyMetadata
Return values
PropertyMetadata —getFontSize()
Gets font_size
public
getFontSize() : string|null
Return values
string|null —getFontSizeMetadata()
Gets font_size_metadata
public
getFontSizeMetadata() : PropertyMetadata
Return values
PropertyMetadata —getItalic()
Gets italic
public
getItalic() : string|null
Return values
string|null —getItalicMetadata()
Gets italic_metadata
public
getItalicMetadata() : PropertyMetadata
Return values
PropertyMetadata —getLocked()
Gets locked
public
getLocked() : string|null
Return values
string|null —getLockedMetadata()
Gets locked_metadata
public
getLockedMetadata() : PropertyMetadata
Return values
PropertyMetadata —getMergeFieldXml()
Gets merge_field_xml
public
getMergeFieldXml() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPageNumber()
Gets page_number
public
getPageNumber() : string|null
Return values
string|null —getPageNumberMetadata()
Gets page_number_metadata
public
getPageNumberMetadata() : PropertyMetadata
Return values
PropertyMetadata —getRequired()
Gets required
public
getRequired() : string|null
Return values
string|null —getRequiredMetadata()
Gets required_metadata
public
getRequiredMetadata() : PropertyMetadata
Return values
PropertyMetadata —getSelected()
Gets selected
public
getSelected() : string|null
Return values
string|null —getSelectedMetadata()
Gets selected_metadata
public
getSelectedMetadata() : PropertyMetadata
Return values
PropertyMetadata —getStatus()
Gets status
public
getStatus() : string|null
Return values
string|null —getStatusMetadata()
Gets status_metadata
public
getStatusMetadata() : PropertyMetadata
Return values
PropertyMetadata —getTabId()
Gets tab_id
public
getTabId() : string|null
Return values
string|null —getTabIdMetadata()
Gets tab_id_metadata
public
getTabIdMetadata() : PropertyMetadata
Return values
PropertyMetadata —getTabOrder()
Gets tab_order
public
getTabOrder() : string|null
Return values
string|null —getTabOrderMetadata()
Gets tab_order_metadata
public
getTabOrderMetadata() : PropertyMetadata
Return values
PropertyMetadata —getters()
Array of attributes to getter functions (for serialization of requests)
public
static getters() : array<string|int, mixed>
Return values
array<string|int, mixed> —getUnderline()
Gets underline
public
getUnderline() : string|null
Return values
string|null —getUnderlineMetadata()
Gets underline_metadata
public
getUnderlineMetadata() : PropertyMetadata
Return values
PropertyMetadata —getValue()
Gets value
public
getValue() : string|null
Return values
string|null —getValueMetadata()
Gets value_metadata
public
getValueMetadata() : PropertyMetadata
Return values
PropertyMetadata —getXPosition()
Gets x_position
public
getXPosition() : string|null
Return values
string|null —getXPositionMetadata()
Gets x_position_metadata
public
getXPositionMetadata() : PropertyMetadata
Return values
PropertyMetadata —getYPosition()
Gets y_position
public
getYPosition() : string|null
Return values
string|null —getYPositionMetadata()
Gets y_position_metadata
public
getYPositionMetadata() : PropertyMetadata
Return values
PropertyMetadata —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 —setAnchorAllowWhiteSpaceInCharacters()
Sets anchor_allow_white_space_in_characters
public
setAnchorAllowWhiteSpaceInCharacters(string|null $anchor_allow_white_space_in_characters) : $this
Parameters
- $anchor_allow_white_space_in_characters : string|null
Return values
$this —setAnchorAllowWhiteSpaceInCharactersMetadata()
Sets anchor_allow_white_space_in_characters_metadata
public
setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata $anchor_allow_white_space_in_characters_metadata) : $this
Parameters
- $anchor_allow_white_space_in_characters_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorAllowWhiteSpaceInCharacters
property is editable.
Return values
$this —setAnchorCaseSensitive()
Sets anchor_case_sensitive
public
setAnchorCaseSensitive(string|null $anchor_case_sensitive) : $this
Parameters
- $anchor_case_sensitive : string|null
-
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
Return values
$this —setAnchorCaseSensitiveMetadata()
Sets anchor_case_sensitive_metadata
public
setAnchorCaseSensitiveMetadata(PropertyMetadata $anchor_case_sensitive_metadata) : $this
Parameters
- $anchor_case_sensitive_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorCaseSensitive
property is editable.
Return values
$this —setAnchorHorizontalAlignment()
Sets anchor_horizontal_alignment
public
setAnchorHorizontalAlignment(string|null $anchor_horizontal_alignment) : $this
Parameters
- $anchor_horizontal_alignment : string|null
-
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
Return values
$this —setAnchorHorizontalAlignmentMetadata()
Sets anchor_horizontal_alignment_metadata
public
setAnchorHorizontalAlignmentMetadata(PropertyMetadata $anchor_horizontal_alignment_metadata) : $this
Parameters
- $anchor_horizontal_alignment_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorHorizontalAlignment
property is editable.
Return values
$this —setAnchorIgnoreIfNotPresent()
Sets anchor_ignore_if_not_present
public
setAnchorIgnoreIfNotPresent(string|null $anchor_ignore_if_not_present) : $this
Parameters
- $anchor_ignore_if_not_present : string|null
-
When set to true, this tab is ignored if anchorString is not found in the document.
Return values
$this —setAnchorIgnoreIfNotPresentMetadata()
Sets anchor_ignore_if_not_present_metadata
public
setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata $anchor_ignore_if_not_present_metadata) : $this
Parameters
- $anchor_ignore_if_not_present_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorIgnoreIfNotPresent
property is editable.
Return values
$this —setAnchorMatchWholeWord()
Sets anchor_match_whole_word
public
setAnchorMatchWholeWord(string|null $anchor_match_whole_word) : $this
Parameters
- $anchor_match_whole_word : string|null
-
When set to true, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is true.
Return values
$this —setAnchorMatchWholeWordMetadata()
Sets anchor_match_whole_word_metadata
public
setAnchorMatchWholeWordMetadata(PropertyMetadata $anchor_match_whole_word_metadata) : $this
Parameters
- $anchor_match_whole_word_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorMatchWholeWord
property is editable.
Return values
$this —setAnchorString()
Sets anchor_string
public
setAnchorString(string|null $anchor_string) : $this
Parameters
- $anchor_string : string|null
-
Anchor text information for a radio button.
Return values
$this —setAnchorStringMetadata()
Sets anchor_string_metadata
public
setAnchorStringMetadata(PropertyMetadata $anchor_string_metadata) : $this
Parameters
- $anchor_string_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorString
property is editable.
Return values
$this —setAnchorTabProcessorVersion()
Sets anchor_tab_processor_version
public
setAnchorTabProcessorVersion(string|null $anchor_tab_processor_version) : $this
Parameters
- $anchor_tab_processor_version : string|null
Return values
$this —setAnchorTabProcessorVersionMetadata()
Sets anchor_tab_processor_version_metadata
public
setAnchorTabProcessorVersionMetadata(PropertyMetadata $anchor_tab_processor_version_metadata) : $this
Parameters
- $anchor_tab_processor_version_metadata : PropertyMetadata
-
Reserved for DocuSign.
Return values
$this —setAnchorUnits()
Sets anchor_units
public
setAnchorUnits(string|null $anchor_units) : $this
Parameters
- $anchor_units : string|null
-
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
Return values
$this —setAnchorUnitsMetadata()
Sets anchor_units_metadata
public
setAnchorUnitsMetadata(PropertyMetadata $anchor_units_metadata) : $this
Parameters
- $anchor_units_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorUnits
property is editable.
Return values
$this —setAnchorXOffset()
Sets anchor_x_offset
public
setAnchorXOffset(string|null $anchor_x_offset) : $this
Parameters
- $anchor_x_offset : string|null
-
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
Return values
$this —setAnchorXOffsetMetadata()
Sets anchor_x_offset_metadata
public
setAnchorXOffsetMetadata(PropertyMetadata $anchor_x_offset_metadata) : $this
Parameters
- $anchor_x_offset_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorXOffset
property is editable.
Return values
$this —setAnchorYOffset()
Sets anchor_y_offset
public
setAnchorYOffset(string|null $anchor_y_offset) : $this
Parameters
- $anchor_y_offset : string|null
-
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
Return values
$this —setAnchorYOffsetMetadata()
Sets anchor_y_offset_metadata
public
setAnchorYOffsetMetadata(PropertyMetadata $anchor_y_offset_metadata) : $this
Parameters
- $anchor_y_offset_metadata : PropertyMetadata
-
Metadata that indicates whether the
anchorYOffset
property is editable.
Return values
$this —setBold()
Sets bold
public
setBold(string|null $bold) : $this
Parameters
- $bold : string|null
-
When set to true, the information in the tab is bold.
Return values
$this —setBoldMetadata()
Sets bold_metadata
public
setBoldMetadata(PropertyMetadata $bold_metadata) : $this
Parameters
- $bold_metadata : PropertyMetadata
-
Metadata that indicates whether the
bold
property is editable.
Return values
$this —setCaption()
Sets caption
public
setCaption(string|null $caption) : $this
Parameters
- $caption : string|null
Return values
$this —setCaptionMetadata()
Sets caption_metadata
public
setCaptionMetadata(PropertyMetadata $caption_metadata) : $this
Parameters
- $caption_metadata : PropertyMetadata
Return values
$this —setErrorDetails()
Sets error_details
public
setErrorDetails(ErrorDetails $error_details) : $this
Parameters
- $error_details : ErrorDetails
-
Array or errors.
Return values
$this —setFont()
Sets font
public
setFont(string|null $font) : $this
Parameters
- $font : string|null
-
The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.
Return values
$this —setFontColor()
Sets font_color
public
setFontColor(string|null $font_color) : $this
Parameters
- $font_color : string|null
-
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
Return values
$this —setFontColorMetadata()
Sets font_color_metadata
public
setFontColorMetadata(PropertyMetadata $font_color_metadata) : $this
Parameters
- $font_color_metadata : PropertyMetadata
-
Metadata that indicates whether the
fontColor
property is editable.
Return values
$this —setFontMetadata()
Sets font_metadata
public
setFontMetadata(PropertyMetadata $font_metadata) : $this
Parameters
- $font_metadata : PropertyMetadata
-
Metadata that indicates whether the
font
property is editable.
Return values
$this —setFontSize()
Sets font_size
public
setFontSize(string|null $font_size) : $this
Parameters
- $font_size : string|null
-
The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
Return values
$this —setFontSizeMetadata()
Sets font_size_metadata
public
setFontSizeMetadata(PropertyMetadata $font_size_metadata) : $this
Parameters
- $font_size_metadata : PropertyMetadata
-
Metadata that indicates whether the
fontSize
property is editable.
Return values
$this —setItalic()
Sets italic
public
setItalic(string|null $italic) : $this
Parameters
- $italic : string|null
-
When set to true, the information in the tab is italic.
Return values
$this —setItalicMetadata()
Sets italic_metadata
public
setItalicMetadata(PropertyMetadata $italic_metadata) : $this
Parameters
- $italic_metadata : PropertyMetadata
-
Metadata that indicates whether the
italic
property is editable.
Return values
$this —setLocked()
Sets locked
public
setLocked(string|null $locked) : $this
Parameters
- $locked : string|null
-
When set to true, the signer cannot change the data of the custom tab.
Return values
$this —setLockedMetadata()
Sets locked_metadata
public
setLockedMetadata(PropertyMetadata $locked_metadata) : $this
Parameters
- $locked_metadata : PropertyMetadata
-
Metadata that indicates whether the
locked
property is editable.
Return values
$this —setMergeFieldXml()
Sets merge_field_xml
public
setMergeFieldXml(string|null $merge_field_xml) : $this
Parameters
- $merge_field_xml : string|null
Return values
$this —setPageNumber()
Sets page_number
public
setPageNumber(string|null $page_number) : $this
Parameters
- $page_number : string|null
-
Specifies the page number on which the tab is located.
Return values
$this —setPageNumberMetadata()
Sets page_number_metadata
public
setPageNumberMetadata(PropertyMetadata $page_number_metadata) : $this
Parameters
- $page_number_metadata : PropertyMetadata
-
Metadata that indicates whether the
pageNumber
property is editable.
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 —setRequiredMetadata()
Sets required_metadata
public
setRequiredMetadata(PropertyMetadata $required_metadata) : $this
Parameters
- $required_metadata : PropertyMetadata
-
Metadata that indicates whether the
required
property is editable.
Return values
$this —setSelected()
Sets selected
public
setSelected(string|null $selected) : $this
Parameters
- $selected : string|null
-
When set to true, the radio button is selected.
Return values
$this —setSelectedMetadata()
Sets selected_metadata
public
setSelectedMetadata(PropertyMetadata $selected_metadata) : $this
Parameters
- $selected_metadata : PropertyMetadata
-
Metadata that indicates whether the
selected
property is editable.
Return values
$this —setStatus()
Sets status
public
setStatus(string|null $status) : $this
Parameters
- $status : string|null
-
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.
Return values
$this —setStatusMetadata()
Sets status_metadata
public
setStatusMetadata(PropertyMetadata $status_metadata) : $this
Parameters
- $status_metadata : PropertyMetadata
-
Metadata that indicates whether the
status
property is editable.
Return values
$this —setTabId()
Sets tab_id
public
setTabId(string|null $tab_id) : $this
Parameters
- $tab_id : string|null
-
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
Return values
$this —setTabIdMetadata()
Sets tab_id_metadata
public
setTabIdMetadata(PropertyMetadata $tab_id_metadata) : $this
Parameters
- $tab_id_metadata : PropertyMetadata
-
Metadata that indicates whether the
tabId
property is editable.
Return values
$this —setTabOrder()
Sets tab_order
public
setTabOrder(string|null $tab_order) : $this
Parameters
- $tab_order : string|null
Return values
$this —setTabOrderMetadata()
Sets tab_order_metadata
public
setTabOrderMetadata(PropertyMetadata $tab_order_metadata) : $this
Parameters
- $tab_order_metadata : PropertyMetadata
-
Metadata that indicates whether the
tabOrder
property is editable.
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> —setUnderline()
Sets underline
public
setUnderline(string|null $underline) : $this
Parameters
- $underline : string|null
-
When set to true, the information in the tab is underlined.
Return values
$this —setUnderlineMetadata()
Sets underline_metadata
public
setUnderlineMetadata(PropertyMetadata $underline_metadata) : $this
Parameters
- $underline_metadata : PropertyMetadata
-
Metadata that indicates whether the
underline
property is editable.
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 —setValueMetadata()
Sets value_metadata
public
setValueMetadata(PropertyMetadata $value_metadata) : $this
Parameters
- $value_metadata : PropertyMetadata
-
Metadata that indicates whether the
value
property is editable.
Return values
$this —setXPosition()
Sets x_position
public
setXPosition(string|null $x_position) : $this
Parameters
- $x_position : string|null
-
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
Return values
$this —setXPositionMetadata()
Sets x_position_metadata
public
setXPositionMetadata(PropertyMetadata $x_position_metadata) : $this
Parameters
- $x_position_metadata : PropertyMetadata
-
Metadata that indicates whether the
xPosition
property is editable.
Return values
$this —setYPosition()
Sets y_position
public
setYPosition(string|null $y_position) : $this
Parameters
- $y_position : string|null
-
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.
Return values
$this —setYPositionMetadata()
Sets y_position_metadata
public
setYPositionMetadata(PropertyMetadata $y_position_metadata) : $this
Parameters
- $y_position_metadata : PropertyMetadata
-
Metadata that indicates whether the
yPosition
property is editable.
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