SmartSectionDisplaySettings
in package
implements
ModelInterface, ArrayAccess
SmartSectionDisplaySettings 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
- getCellStyle() : string|null
- Gets cell_style
- getCollapsibleSettings() : SmartSectionCollapsibleDisplaySettings
- Gets collapsible_settings
- getDisplay() : string|null
- Gets display
- getDisplayLabel() : string|null
- Gets display_label
- getDisplayOrder() : int|null
- Gets display_order
- getDisplayPageNumber() : int|null
- Gets display_page_number
- getHideLabelWhenOpened() : bool|null
- Gets hide_label_when_opened
- getInlineOuterStyle() : string|null
- Gets inline_outer_style
- getLabelWhenOpened() : string|null
- Gets label_when_opened
- getModelName() : string
- The original name of the model.
- getPreLabel() : string|null
- Gets pre_label
- getScrollToTopWhenOpened() : bool|null
- Gets scroll_to_top_when_opened
- getTableStyle() : string|null
- Gets table_style
- 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.
- setCellStyle() : $this
- Sets cell_style
- setCollapsibleSettings() : $this
- Sets collapsible_settings
- setDisplay() : $this
- Sets display
- setDisplayLabel() : $this
- Sets display_label
- setDisplayOrder() : $this
- Sets display_order
- setDisplayPageNumber() : $this
- Sets display_page_number
- setHideLabelWhenOpened() : $this
- Sets hide_label_when_opened
- setInlineOuterStyle() : $this
- Sets inline_outer_style
- setLabelWhenOpened() : $this
- Sets label_when_opened
- setPreLabel() : $this
- Sets pre_label
- setScrollToTopWhenOpened() : $this
- Sets scroll_to_top_when_opened
- setTableStyle() : $this
- Sets table_style
- 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
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
= ['cell_style' => 'cellStyle', 'collapsible_settings' => 'collapsibleSettings', 'display' => 'display', 'display_label' => 'displayLabel', 'display_order' => 'displayOrder', 'display_page_number' => 'displayPageNumber', 'hide_label_when_opened' => 'hideLabelWhenOpened', 'inline_outer_style' => 'inlineOuterStyle', 'label_when_opened' => 'labelWhenOpened', 'pre_label' => 'preLabel', 'scroll_to_top_when_opened' => 'scrollToTopWhenOpened', 'table_style' => 'tableStyle']
$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
= ['cell_style' => 'getCellStyle', 'collapsible_settings' => 'getCollapsibleSettings', 'display' => 'getDisplay', 'display_label' => 'getDisplayLabel', 'display_order' => 'getDisplayOrder', 'display_page_number' => 'getDisplayPageNumber', 'hide_label_when_opened' => 'getHideLabelWhenOpened', 'inline_outer_style' => 'getInlineOuterStyle', 'label_when_opened' => 'getLabelWhenOpened', 'pre_label' => 'getPreLabel', 'scroll_to_top_when_opened' => 'getScrollToTopWhenOpened', 'table_style' => 'getTableStyle']
$setters
Array of attributes to setter functions (for deserialization of responses)
protected
static array<string|int, string>
$setters
= ['cell_style' => 'setCellStyle', 'collapsible_settings' => 'setCollapsibleSettings', 'display' => 'setDisplay', 'display_label' => 'setDisplayLabel', 'display_order' => 'setDisplayOrder', 'display_page_number' => 'setDisplayPageNumber', 'hide_label_when_opened' => 'setHideLabelWhenOpened', 'inline_outer_style' => 'setInlineOuterStyle', 'label_when_opened' => 'setLabelWhenOpened', 'pre_label' => 'setPreLabel', 'scroll_to_top_when_opened' => 'setScrollToTopWhenOpened', 'table_style' => 'setTableStyle']
$swaggerFormats
Array of property to format mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerFormats
= ['cell_style' => null, 'collapsible_settings' => null, 'display' => null, 'display_label' => null, 'display_order' => 'int32', 'display_page_number' => 'int32', 'hide_label_when_opened' => null, 'inline_outer_style' => null, 'label_when_opened' => null, 'pre_label' => null, 'scroll_to_top_when_opened' => null, 'table_style' => null]
$swaggerModelName
The original name of the model.
protected
static string
$swaggerModelName
= 'smartSectionDisplaySettings'
$swaggerTypes
Array of property to type mappings. Used for (de)serialization
protected
static array<string|int, string>
$swaggerTypes
= ['cell_style' => '?string', 'collapsible_settings' => '\\DocuSign\\eSign\\Model\\SmartSectionCollapsibleDisplaySettings', 'display' => '?string', 'display_label' => '?string', 'display_order' => '?int', 'display_page_number' => '?int', 'hide_label_when_opened' => '?bool', 'inline_outer_style' => '?string', 'label_when_opened' => '?string', 'pre_label' => '?string', 'scroll_to_top_when_opened' => '?bool', 'table_style' => '?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> —getCellStyle()
Gets cell_style
public
getCellStyle() : string|null
Return values
string|null —getCollapsibleSettings()
Gets collapsible_settings
public
getCollapsibleSettings() : SmartSectionCollapsibleDisplaySettings
Return values
SmartSectionCollapsibleDisplaySettings —getDisplay()
Gets display
public
getDisplay() : string|null
Return values
string|null —getDisplayLabel()
Gets display_label
public
getDisplayLabel() : string|null
Return values
string|null —getDisplayOrder()
Gets display_order
public
getDisplayOrder() : int|null
Return values
int|null —getDisplayPageNumber()
Gets display_page_number
public
getDisplayPageNumber() : int|null
Return values
int|null —getHideLabelWhenOpened()
Gets hide_label_when_opened
public
getHideLabelWhenOpened() : bool|null
Return values
bool|null —getInlineOuterStyle()
Gets inline_outer_style
public
getInlineOuterStyle() : string|null
Return values
string|null —getLabelWhenOpened()
Gets label_when_opened
public
getLabelWhenOpened() : string|null
Return values
string|null —getModelName()
The original name of the model.
public
getModelName() : string
Return values
string —getPreLabel()
Gets pre_label
public
getPreLabel() : string|null
Return values
string|null —getScrollToTopWhenOpened()
Gets scroll_to_top_when_opened
public
getScrollToTopWhenOpened() : bool|null
Return values
bool|null —getTableStyle()
Gets table_style
public
getTableStyle() : 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 —setCellStyle()
Sets cell_style
public
setCellStyle(string|null $cell_style) : $this
Parameters
- $cell_style : string|null
Return values
$this —setCollapsibleSettings()
Sets collapsible_settings
public
setCollapsibleSettings(SmartSectionCollapsibleDisplaySettings $collapsible_settings) : $this
Parameters
- $collapsible_settings : SmartSectionCollapsibleDisplaySettings
-
This object defines the appearance and function of a collapsible section or item.
Return values
$this —setDisplay()
Sets display
public
setDisplay(string|null $display) : $this
Parameters
- $display : string|null
Return values
$this —setDisplayLabel()
Sets display_label
public
setDisplayLabel(string|null $display_label) : $this
Parameters
- $display_label : string|null
Return values
$this —setDisplayOrder()
Sets display_order
public
setDisplayOrder(int|null $display_order) : $this
Parameters
- $display_order : int|null
Return values
$this —setDisplayPageNumber()
Sets display_page_number
public
setDisplayPageNumber(int|null $display_page_number) : $this
Parameters
- $display_page_number : int|null
Return values
$this —setHideLabelWhenOpened()
Sets hide_label_when_opened
public
setHideLabelWhenOpened(bool|null $hide_label_when_opened) : $this
Parameters
- $hide_label_when_opened : bool|null
Return values
$this —setInlineOuterStyle()
Sets inline_outer_style
public
setInlineOuterStyle(string|null $inline_outer_style) : $this
Parameters
- $inline_outer_style : string|null
Return values
$this —setLabelWhenOpened()
Sets label_when_opened
public
setLabelWhenOpened(string|null $label_when_opened) : $this
Parameters
- $label_when_opened : string|null
Return values
$this —setPreLabel()
Sets pre_label
public
setPreLabel(string|null $pre_label) : $this
Parameters
- $pre_label : string|null
Return values
$this —setScrollToTopWhenOpened()
Sets scroll_to_top_when_opened
public
setScrollToTopWhenOpened(bool|null $scroll_to_top_when_opened) : $this
Parameters
- $scroll_to_top_when_opened : bool|null
Return values
$this —setTableStyle()
Sets table_style
public
setTableStyle(string|null $table_style) : $this
Parameters
- $table_style : string|null
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