\Hpolthof\DocmailDocmailTemplateFile

Class DocmailTemplateFile

Summary

Methods

Properties

Constants

offsetExists()
offsetGet()
offsetSet()
offsetUnset()
toArray()
loadFromFile()
getTemplateName()
setTemplateName()
getFileName()
setFileName()
getFileData()
setFileData()
getDocumentType()
setDocumentType()
getAddressedDocument()
setAddressedDocument()
getAddressFontCode()
setAddressFontCode()
getTemplateType()
setTemplateType()
getBackgroundName()
setBackgroundName()
isCanBeginOnBack()
setCanBeginOnBack()
isNextTemplateCanBeginOnBack()
setNextTemplateCanBeginOnBack()
getProtectedAreaPassword()
setProtectedAreaPassword()
getEncryptionPassword()
setEncryptionPassword()
isBleedSupplied()
setBleedSupplied()
getCopies()
setCopies()
getInstances()
setInstances()
getInstancePageNumbers()
setInstancePageNumbers()
isCycleInstancesOnCopies()
setCycleInstancesOnCopies()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

No private methods found

No private properties found

N/A

File: DocmailTemplateFile.php
Package: Hpolthof\Docmail
Class hierarchy: \Hpolthof\Docmail\DocmailTemplateFile
Implements
Uses traits: \Hpolthof\Docmail\DocmailArrayAccessTrait

Methods

offsetExists()

offsetExists(  $offset)

Parameters

$offset

offsetGet()

offsetGet(  $offset)

Parameters

$offset

offsetSet()

offsetSet(  $offset,   $value)

Parameters

	$offset
	$value

offsetUnset()

offsetUnset(  $offset)

Parameters

$offset

toArray()

toArray()

loadFromFile()

loadFromFile(  $filename) : static

Create an DocmailTemplateFile object with an specific file already loaded.

Parameters

$filename

Throws

\Hpolthof\Docmail\DocmailException

Returns

static

getTemplateName()

getTemplateName() : string

Returns

string

setTemplateName()

setTemplateName(string  $TemplateName) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$TemplateName

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getFileName()

getFileName() : string

Returns

string

setFileName()

setFileName(string  $FileName) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$FileName

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getFileData()

getFileData() : string

Returns

string

setFileData()

setFileData(string  $FileData) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$FileData

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getDocumentType()

getDocumentType() : mixed

Returns

mixed

setDocumentType()

setDocumentType(  $DocumentType)

Parameters

$DocumentType

getAddressedDocument()

getAddressedDocument() : mixed

Returns

mixed

setAddressedDocument()

setAddressedDocument(mixed  $AddressedDocument) : \Hpolthof\Docmail\DocmailTemplateFile

Add the address panel to the document. The first template uploaded onto a mail pack will be automatically set as an addressed document.

Parameters

mixed

$AddressedDocument

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getAddressFontCode()

getAddressFontCode() : mixed

Returns

mixed

setAddressFontCode()

setAddressFontCode(  $AddressFontCode)

Parameters

$AddressFontCode

getTemplateType()

getTemplateType() : string

Returns

string

setTemplateType()

setTemplateType(string  $TemplateType) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$TemplateType

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getBackgroundName()

getBackgroundName() : string

Returns

string

setBackgroundName()

setBackgroundName(string  $BackgroundName) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$BackgroundName

Returns

\Hpolthof\Docmail\DocmailTemplateFile

isCanBeginOnBack()

isCanBeginOnBack() : boolean

Returns

boolean

setCanBeginOnBack()

setCanBeginOnBack(boolean  $CanBeginOnBack) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

boolean

$CanBeginOnBack

Returns

\Hpolthof\Docmail\DocmailTemplateFile

isNextTemplateCanBeginOnBack()

isNextTemplateCanBeginOnBack() : boolean

Returns

boolean

setNextTemplateCanBeginOnBack()

setNextTemplateCanBeginOnBack(boolean  $NextTemplateCanBeginOnBack) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

boolean

$NextTemplateCanBeginOnBack

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getProtectedAreaPassword()

getProtectedAreaPassword() : string

Returns

string

setProtectedAreaPassword()

setProtectedAreaPassword(string  $ProtectedAreaPassword) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$ProtectedAreaPassword

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getEncryptionPassword()

getEncryptionPassword() : string

Returns

string

setEncryptionPassword()

setEncryptionPassword(string  $EncryptionPassword) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$EncryptionPassword

Returns

\Hpolthof\Docmail\DocmailTemplateFile

isBleedSupplied()

isBleedSupplied() : boolean

Returns

boolean

setBleedSupplied()

setBleedSupplied(boolean  $BleedSupplied) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

boolean

$BleedSupplied

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getCopies()

getCopies() : integer

Returns

integer

setCopies()

setCopies(integer  $Copies) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

integer

$Copies

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getInstances()

getInstances() : integer

Returns

integer

setInstances()

setInstances(integer  $Instances) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

integer

$Instances

Returns

\Hpolthof\Docmail\DocmailTemplateFile

getInstancePageNumbers()

getInstancePageNumbers() : string

Returns

string

setInstancePageNumbers()

setInstancePageNumbers(string  $InstancePageNumbers) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

string

$InstancePageNumbers

Returns

\Hpolthof\Docmail\DocmailTemplateFile

isCycleInstancesOnCopies()

isCycleInstancesOnCopies() : boolean

Returns

boolean

setCycleInstancesOnCopies()

setCycleInstancesOnCopies(boolean  $CycleInstancesOnCopies) : \Hpolthof\Docmail\DocmailTemplateFile

Parameters

boolean

$CycleInstancesOnCopies

Returns

\Hpolthof\Docmail\DocmailTemplateFile