Documentation

ExternalFile
in package
implements ModelInterface, ArrayAccess

ExternalFile Class Doc Comment

Tags
category

Class

description

This object contains information about a file or folder in cloud storage.

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
getDate()  : string|null
Gets date
getHasCompositeTemplate()  : string|null
Gets has_composite_template
getId()  : string|null
Gets id
getImg()  : string|null
Gets img
getModelName()  : string
The original name of the model.
getName()  : string|null
Gets name
getOwnerName()  : string|null
Gets owner_name
getSize()  : string|null
Gets size
getSupported()  : string|null
Gets supported
getters()  : array<string|int, mixed>
Array of attributes to getter functions (for serialization of requests)
getType()  : string|null
Gets type
getUri()  : string|null
Gets uri
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.
setDate()  : $this
Sets date
setHasCompositeTemplate()  : $this
Sets has_composite_template
setId()  : $this
Sets id
setImg()  : $this
Sets img
setName()  : $this
Sets name
setOwnerName()  : $this
Sets owner_name
setSize()  : $this
Sets size
setSupported()  : $this
Sets supported
setters()  : array<string|int, mixed>
Array of attributes to setter functions (for deserialization of responses)
setType()  : $this
Sets type
setUri()  : $this
Sets uri
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 = ['date' => 'date', 'has_composite_template' => 'hasCompositeTemplate', 'id' => 'id', 'img' => 'img', 'name' => 'name', 'owner_name' => 'ownerName', 'size' => 'size', 'supported' => 'supported', 'type' => 'type', 'uri' => 'uri']

$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 = ['date' => 'getDate', 'has_composite_template' => 'getHasCompositeTemplate', 'id' => 'getId', 'img' => 'getImg', 'name' => 'getName', 'owner_name' => 'getOwnerName', 'size' => 'getSize', 'supported' => 'getSupported', 'type' => 'getType', 'uri' => 'getUri']

$setters

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

protected static array<string|int, string> $setters = ['date' => 'setDate', 'has_composite_template' => 'setHasCompositeTemplate', 'id' => 'setId', 'img' => 'setImg', 'name' => 'setName', 'owner_name' => 'setOwnerName', 'size' => 'setSize', 'supported' => 'setSupported', 'type' => 'setType', 'uri' => 'setUri']

$swaggerFormats

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

protected static array<string|int, string> $swaggerFormats = ['date' => null, 'has_composite_template' => null, 'id' => null, 'img' => null, 'name' => null, 'owner_name' => null, 'size' => null, 'supported' => null, 'type' => null, 'uri' => null]

$swaggerModelName

The original name of the model.

protected static string $swaggerModelName = 'externalFile'

$swaggerTypes

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

protected static array<string|int, string> $swaggerTypes = ['date' => '?string', 'has_composite_template' => '?string', 'id' => '?string', 'img' => '?string', 'name' => '?string', 'owner_name' => '?string', 'size' => '?string', 'supported' => '?string', 'type' => '?string', 'uri' => '?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>

getDate()

Gets date

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

getHasCompositeTemplate()

Gets has_composite_template

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

getId()

Gets id

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

getImg()

Gets img

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

getModelName()

The original name of the model.

public getModelName() : string
Return values
string

getName()

Gets name

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

getOwnerName()

Gets owner_name

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

getSize()

Gets size

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

getSupported()

Gets supported

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

getType()

Gets type

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

getUri()

Gets uri

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

setDate()

Sets date

public setDate(string|null $date) : $this
Parameters
$date : string|null
Return values
$this

setHasCompositeTemplate()

Sets has_composite_template

public setHasCompositeTemplate(string|null $has_composite_template) : $this
Parameters
$has_composite_template : string|null
Return values
$this

setId()

Sets id

public setId(string|null $id) : $this
Parameters
$id : string|null
Return values
$this

setImg()

Sets img

public setImg(string|null $img) : $this
Parameters
$img : string|null
Return values
$this

setName()

Sets name

public setName(string|null $name) : $this
Parameters
$name : string|null
Return values
$this

setOwnerName()

Sets owner_name

public setOwnerName(string|null $owner_name) : $this
Parameters
$owner_name : string|null
Return values
$this

setSize()

Sets size

public setSize(string|null $size) : $this
Parameters
$size : string|null

Reserved: TBD

Return values
$this

setSupported()

Sets supported

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

setType()

Sets type

public setType(string|null $type) : $this
Parameters
$type : string|null
Return values
$this

setUri()

Sets uri

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