class AttachmentsDelete extends AbstractAttachments

Delete an existing attachments record

Methods

getControlId()

Get control ID

setControlId($controlId = null)

Set control ID

__construct(string $controlId = null)

Initializes the class with the given parameters.

writeXml(XMLWriter $xml)

Write the function block XML

string
getAttachmentsId()

Get attachments ID

setAttachmentsId(string $attachmentsId)

Set attachments ID

string
getAttachmentsName()

Get attachments name

setAttachmentsName(string $attachmentsName)

Set attachments name

string
getAttachmentFolderName()

Get attachment folder name

setAttachmentFolderName(string $attachmentFolderName)

Set attachment folder name

string
getDescription()

Get description

setDescription(string $description)

Set description

setFiles(array $files)

Set files

Details

in AbstractFunction at line line 35
getControlId()

Get control ID

in AbstractFunction at line line 46
setControlId($controlId = null)

Set control ID

Parameters

$controlId

Exceptions

InvalidArgumentException

in AbstractFunction at line line 67
__construct(string $controlId = null)

Initializes the class with the given parameters.

Parameters

string $controlId Control ID, default=random UUID

at line line 35
writeXml(XMLWriter $xml)

Write the function block XML

Parameters

XMLWriter $xml

in AbstractAttachments at line line 45
string getAttachmentsId()

Get attachments ID

Return Value

string

in AbstractAttachments at line line 55
setAttachmentsId(string $attachmentsId)

Set attachments ID

Parameters

string $attachmentsId

in AbstractAttachments at line line 65
string getAttachmentsName()

Get attachments name

Return Value

string

in AbstractAttachments at line line 75
setAttachmentsName(string $attachmentsName)

Set attachments name

Parameters

string $attachmentsName

in AbstractAttachments at line line 85
string getAttachmentFolderName()

Get attachment folder name

Return Value

string

in AbstractAttachments at line line 95
setAttachmentFolderName(string $attachmentFolderName)

Set attachment folder name

Parameters

string $attachmentFolderName

in AbstractAttachments at line line 105
string getDescription()

Get description

Return Value

string

in AbstractAttachments at line line 115
setDescription(string $description)

Set description

Parameters

string $description

in AbstractAttachments at line line 125
AttachmentInterface[] getFiles()

Get files

Return Value

AttachmentInterface[]

in AbstractAttachments at line line 135
setFiles(array $files)

Set files

Parameters

array $files