Documentation

BrandLink
in package
implements ModelInterface, ArrayAccess

BrandLink Class Doc Comment

Tags
category

Class

description

Information about a link that a brand uses.

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
getLinkText()  : string|null
Gets link_text
getLinkType()  : string|null
Gets link_type
getModelName()  : string
The original name of the model.
getShowLink()  : string|null
Gets show_link
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getUrlOrMailTo()  : string|null
Gets url_or_mail_to
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.
setLinkText()  : $this
Sets link_text
setLinkType()  : $this
Sets link_type
setShowLink()  : $this
Sets show_link
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setUrlOrMailTo()  : $this
Sets url_or_mail_to
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 = ['link_text' => 'linkText', 'link_type' => 'linkType', 'show_link' => 'showLink', 'url_or_mail_to' => 'urlOrMailTo']

$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 = ['link_text' => 'getLinkText', 'link_type' => 'getLinkType', 'show_link' => 'getShowLink', 'url_or_mail_to' => 'getUrlOrMailTo']

$setters

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

protected static array<string|int, string> $setters = ['link_text' => 'setLinkText', 'link_type' => 'setLinkType', 'show_link' => 'setShowLink', 'url_or_mail_to' => 'setUrlOrMailTo']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['link_text' => null, 'link_type' => null, 'show_link' => null, 'url_or_mail_to' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'brandLink'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['link_text' => '?string', 'link_type' => '?string', 'show_link' => '?string', 'url_or_mail_to' => '?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>

getLinkText()

Gets link_text

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

getLinkType()

Gets link_type

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

Gets show_link

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

getUrlOrMailTo()

Gets url_or_mail_to

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

setLinkText()

Sets link_text

public setLinkText(string|null $link_text) : $this
Parameters
$link_text : string|null
Return values
$this

setLinkType()

Sets link_type

public setLinkType(string|null $link_type) : $this
Parameters
$link_type : string|null
Return values
$this

Sets show_link

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

setUrlOrMailTo()

Sets url_or_mail_to

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