LDAP Account Manager

PdfStructurePersistenceManager
in package

Manages the persistence of PDF structures.

Table of Contents

$strategy  : PdfStructurePersistenceStrategy
__construct()  : mixed
Constructor
deletePdfLogo()  : void
Deletes a PDF logo.
deletePdfStructure()  : void
Deletes a PDF structure.
deletePdfStructureTemplate()  : void
Deletes an PDF structure template.
deletePdfTemplateLogo()  : void
Deletes a logo in global templates.
getPdfLogoBinary()  : string
Reads a PDF logo.
getPdfLogos()  : array<string|int, PdfLogo>
Returns the list of available PDF logos.
getPDFStructures()  : array<string|int, string>
Returns all available PDF structure definitions for the submitted account type.
getPdfStructureTemplateNames()  : array<string|int, mixed>
Returns the names of existing PDF structure templates.
getPdfTemplateLogoBinary()  : string
Returns the binary data for the given template logo.
getPdfTemplateLogoNames()  : array<string|int, string>
Returns a list of template logo file names.
installPDFTemplates()  : mixed
Installs template structures to the given server profile.
readPdfStructure()  : PDFStructure
Reads a PDF structure.
readPdfStructureTemplate()  : PDFStructure
Reads a PDF structure template.
savePdfLogo()  : void
Saves a PDF logo.
savePdfStructure()  : void
Saves the PDF structure.
savePdfStructureTemplate()  : void
Saves the PDF structure.
savePdfTemplateLogo()  : void
Saves the template logo.
isValidLogoFileName()  : bool
Returns if the given logo file name is valid.
isValidPDFStructureName()  : bool
Returns if the give structure name is valid.

Properties

Methods

__construct()

Constructor

public __construct() : mixed
Return values
mixed —

Deletes a PDF logo.

public deletePdfLogo(string $confName, string $name) : void
Parameters
$confName : string

server profile name

$name : string

logo name

Tags
throws
LAMException

error deleting logo

Return values
void —

deletePdfStructure()

Deletes a PDF structure.

public deletePdfStructure(string $confName, string $typeId, string $name) : void
Parameters
$confName : string

server profile name

$typeId : string

user/group/host

$name : string

structure name

Tags
throws
LAMException

error deleting structure

Return values
void —

deletePdfStructureTemplate()

Deletes an PDF structure template.

public deletePdfStructureTemplate(string $scope, string $name) : void
Parameters
$scope : string

user/group/host

$name : string

PDF structure name

Tags
throws
LAMException

error deleting template

Return values
void —

Deletes a logo in global templates.

public deletePdfTemplateLogo(string $name) : void
Parameters
$name : string

logo name

Tags
throws
LAMException

error during deletion

Return values
void —

getPdfLogoBinary()

Reads a PDF logo.

public getPdfLogoBinary(string $confName, string $name) : string
Parameters
$confName : string

server profile name

$name : string

file name

Tags
throws
LAMException

error reading logo

Return values
string —

binary data

getPdfLogos()

Returns the list of available PDF logos.

public getPdfLogos(string $confName[, bool $readDimensions = false ]) : array<string|int, PdfLogo>
Parameters
$confName : string

server profile name

$readDimensions : bool = false

reads the image dimensions

Tags
throws
LAMException

error reading logos

Return values
array<string|int, PdfLogo> —

logos

getPDFStructures()

Returns all available PDF structure definitions for the submitted account type.

public getPDFStructures(string $confName, string $typeId) : array<string|int, string>
Parameters
$confName : string

server profile name

$typeId : string

the account type

Tags
throws
LAMException

error reading structures

Return values
array<string|int, string> —

structure names

getPdfStructureTemplateNames()

Returns the names of existing PDF structure templates.

public getPdfStructureTemplateNames() : array<string|int, mixed>
Tags
throws
LAMException

error reading templates

Return values
array<string|int, mixed> —

scope => names (e.g. array('user' => array('default')))

getPdfTemplateLogoBinary()

Returns the binary data for the given template logo.

public getPdfTemplateLogoBinary(string $name) : string
Parameters
$name : string

file name

Tags
throws
LAMException

error reading file

Return values
string —

binary

getPdfTemplateLogoNames()

Returns a list of template logo file names.

public getPdfTemplateLogoNames() : array<string|int, string>
Return values
array<string|int, string> —

logo file names

installPDFTemplates()

Installs template structures to the given server profile.

public installPDFTemplates(string $confName) : mixed
Parameters
$confName : string

server profile name

Tags
throws
LAMException

error during installation

Return values
mixed —

readPdfStructure()

Reads a PDF structure.

public readPdfStructure(string $confName, string $typeId, string $name) : PDFStructure
Parameters
$confName : string

server profile name

$typeId : string

user/group/host

$name : string

structure name

Tags
throws
LAMException

error deleting structure

Return values
PDFStructure —

PDF structure

readPdfStructureTemplate()

Reads a PDF structure template.

public readPdfStructureTemplate(string $scope, string $name) : PDFStructure
Parameters
$scope : string

user/group/host

$name : string

structure name

Tags
throws
LAMException

error deleting structure

Return values
PDFStructure —

PDF structure

Saves a PDF logo.

public savePdfLogo(string $confName, string $name, string $data) : void
Parameters
$confName : string

server profile name

$name : string

logo name

$data : string

binary

Tags
throws
LAMException

error saving logo

Return values
void —

savePdfStructure()

Saves the PDF structure.

public savePdfStructure(string $confName, string $typeId, string $name, PDFStructure $structure) : void
Parameters
$confName : string

server profile name

$typeId : string

user/group/host

$name : string

structure name

$structure : PDFStructure

structure

Tags
throws
LAMException

error saving structure

Return values
void —

savePdfStructureTemplate()

Saves the PDF structure.

public savePdfStructureTemplate(string $scope, string $name, PDFStructure $structure) : void
Parameters
$scope : string

user/group/host

$name : string

structure name

$structure : PDFStructure

structure

Tags
throws
LAMException

error saving structure

Return values
void —

Saves the template logo.

public savePdfTemplateLogo(string $name, string $data) : void
Parameters
$name : string

file name

$data : string

binary data

Tags
throws
LAMException

error during save

Return values
void —

isValidLogoFileName()

Returns if the given logo file name is valid.

private isValidLogoFileName(string $fileName) : bool
Parameters
$fileName : string

file name

Return values
bool —

valid

isValidPDFStructureName()

Returns if the give structure name is valid.

private isValidPDFStructureName(string $name) : bool
Parameters
$name : string

structure name

Return values
bool —

is valid

Search results