Documentation

SettingsMetadata
in package
implements ModelInterface, ArrayAccess

SettingsMetadata Class Doc Comment

Tags
category

Class

description

Metadata that indicates whether a property is editable and describes setting-specific options.

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
getIs21CfrPart11()  : string|null
Gets is21_cfr_part11
getModelName()  : string
The original name of the model.
getOptions()  : array<string|int, ?string>
Gets options
getRights()  : string|null
Gets rights
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUiHint()  : string|null
Gets ui_hint
getUiOrder()  : string|null
Gets ui_order
getUiType()  : string|null
Gets ui_type
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.
setIs21CfrPart11()  : $this
Sets is21_cfr_part11
setOptions()  : $this
Sets options
setRights()  : $this
Sets rights
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUiHint()  : $this
Sets ui_hint
setUiOrder()  : $this
Sets ui_order
setUiType()  : $this
Sets ui_type
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 = ['is21_cfr_part11' => 'is21CFRPart11', 'options' => 'options', 'rights' => 'rights', 'ui_hint' => 'uiHint', 'ui_order' => 'uiOrder', 'ui_type' => 'uiType']

$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 = ['is21_cfr_part11' => 'getIs21CfrPart11', 'options' => 'getOptions', 'rights' => 'getRights', 'ui_hint' => 'getUiHint', 'ui_order' => 'getUiOrder', 'ui_type' => 'getUiType']

$setters

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

protected static array<string|int, string> $setters = ['is21_cfr_part11' => 'setIs21CfrPart11', 'options' => 'setOptions', 'rights' => 'setRights', 'ui_hint' => 'setUiHint', 'ui_order' => 'setUiOrder', 'ui_type' => 'setUiType']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['is21_cfr_part11' => null, 'options' => null, 'rights' => null, 'ui_hint' => null, 'ui_order' => null, 'ui_type' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'settingsMetadata'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['is21_cfr_part11' => '?string', 'options' => '?string[]', 'rights' => '?string', 'ui_hint' => '?string', 'ui_order' => '?string', 'ui_type' => '?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>

getIs21CfrPart11()

Gets is21_cfr_part11

public getIs21CfrPart11() : string|null
Return values
string|null

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getOptions()

Gets options

public getOptions() : array<string|int, ?string>
Return values
array<string|int, ?string>

getRights()

Gets rights

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

getUiHint()

Gets ui_hint

public getUiHint() : string|null
Return values
string|null

getUiOrder()

Gets ui_order

public getUiOrder() : string|null
Return values
string|null

getUiType()

Gets ui_type

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

setIs21CfrPart11()

Sets is21_cfr_part11

public setIs21CfrPart11(string|null $is21_cfr_part11) : $this
Parameters
$is21_cfr_part11 : string|null

When set to true, indicates that this module is enabled on the account.

Return values
$this

setOptions()

Sets options

public setOptions(array<string|int, ?string> $options) : $this
Parameters
$options : array<string|int, ?string>
Return values
$this

setRights()

Sets rights

public setRights(string|null $rights) : $this
Parameters
$rights : 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>

setUiHint()

Sets ui_hint

public setUiHint(string|null $ui_hint) : $this
Parameters
$ui_hint : string|null
Return values
$this

setUiOrder()

Sets ui_order

public setUiOrder(string|null $ui_order) : $this
Parameters
$ui_order : string|null
Return values
$this

setUiType()

Sets ui_type

public setUiType(string|null $ui_type) : $this
Parameters
$ui_type : string|null
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