Documentation

ListItem
in package
implements ModelInterface, ArrayAccess

ListItem Class Doc Comment

Tags
category

Class

description

One of the selectable items in the `listItems` property of a `list` tab.

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
getModelName()  : string
The original name of the model.
getSelected()  : string|null
Gets selected
getSelectedMetadata()  : PropertyMetadata
Gets selected_metadata
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getText()  : string|null
Gets text
getTextMetadata()  : PropertyMetadata
Gets text_metadata
getValue()  : string|null
Gets value
getValueMetadata()  : PropertyMetadata
Gets value_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.
setSelected()  : $this
Sets selected
setSelectedMetadata()  : $this
Sets selected_metadata
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setText()  : $this
Sets text
setTextMetadata()  : $this
Sets text_metadata
setValue()  : $this
Sets value
setValueMetadata()  : $this
Sets value_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 = ['selected' => 'selected', 'selected_metadata' => 'selectedMetadata', 'text' => 'text', 'text_metadata' => 'textMetadata', 'value' => 'value', 'value_metadata' => 'valueMetadata']

$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 = ['selected' => 'getSelected', 'selected_metadata' => 'getSelectedMetadata', 'text' => 'getText', 'text_metadata' => 'getTextMetadata', 'value' => 'getValue', 'value_metadata' => 'getValueMetadata']

$setters

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

protected static array<string|int, string> $setters = ['selected' => 'setSelected', 'selected_metadata' => 'setSelectedMetadata', 'text' => 'setText', 'text_metadata' => 'setTextMetadata', 'value' => 'setValue', 'value_metadata' => 'setValueMetadata']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['selected' => null, 'selected_metadata' => null, 'text' => null, 'text_metadata' => null, 'value' => null, 'value_metadata' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'listItem'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['selected' => '?string', 'selected_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'text' => '?string', 'text_metadata' => '\\DocuSign\\eSign\\Model\\PropertyMetadata', 'value' => '?string', 'value_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> —

getModelName()

The original name of the model.

public getModelName() : string
Return values
string —

getSelected()

Gets selected

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

getText()

Gets text

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

setSelected()

Sets selected

public setSelected(string|null $selected) : $this
Parameters
$selected : string|null

When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.

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 —

setters()

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

public static setters() : array<string|int, mixed>
Return values
array<string|int, mixed> —

setText()

Sets text

public setText(string|null $text) : $this
Parameters
$text : string|null

Specifies the text that is shown in the dropdown list.

Return values
$this —

setValue()

Sets value

public setValue(string|null $value) : $this
Parameters
$value : string|null

Specifies the value that is used when the list item is selected.

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 —

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