LDAP Account Manager

PDF_EDITOR

Interfaces, Classes, Traits and Enums

toolPDFEditor
PDF editor

Table of Contents

importStructures()  : htmlStatusMessage
Imports the selected PDF structures.
exportStructures()  : htmlStatusMessage
Exports the selected account profile.
translateFieldIDToName()  : string|null
Translates a given field ID (e.g. inetOrgPerson_givenName) to its descriptive name.
updateBasicSettings()  : void
Updates basic settings such as logo and head line.
updateSectionTitles()  : void
Updates section titles.
addSection()  : void
Adds a new section if requested.
addSectionEntry()  : void
Adds a new entry to a section if requested.
removeItem()  : void
Removes a section or entry if requested.
moveUp()  : void
Moves up a section or entry if requested.
moveDown()  : void
Moves down a section or entry if requested.

Functions

importStructures()

Imports the selected PDF structures.

importStructures(string $typeId, array<string|int, mixed> $options, array<string|int, LAMConfig&$serverProfiles, TypeManager &$typeManager) : htmlStatusMessage
Parameters
$typeId : string

type id

$options : array<string|int, mixed>

options

$serverProfiles : array<string|int, LAMConfig>

server profiles (name => profile object)

$typeManager : TypeManager

type manager

Return values
htmlStatusMessage

message or null

exportStructures()

Exports the selected account profile.

exportStructures(string $typeId, string $name, array<string|int, mixed> $options, array<string|int, LAMConfig&$serverProfiles, TypeManager &$typeManager) : htmlStatusMessage
Parameters
$typeId : string

source type id

$name : string

profile name

$options : array<string|int, mixed>

options

$serverProfiles : array<string|int, LAMConfig>

server profiles (name => profile object)

$typeManager : TypeManager

type manager

Return values
htmlStatusMessage

message or null

translateFieldIDToName()

Translates a given field ID (e.g. inetOrgPerson_givenName) to its descriptive name.

translateFieldIDToName(string $id, string $scope, array<string|int, mixed> $availablePDFFields) : string|null
Parameters
$id : string

field ID

$scope : string

account type

$availablePDFFields : array<string|int, mixed>

available PDF fields

Return values
string|null

field label or null if no matching module found

updateBasicSettings()

Updates basic settings such as logo and head line.

updateBasicSettings(PDFStructure &$structure, array<string|int, PdfLogo$logoFiles) : void
Parameters
$structure : PDFStructure

PDF structure

$logoFiles : array<string|int, PdfLogo>

logos

Return values
void

updateSectionTitles()

Updates section titles.

updateSectionTitles(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

addSection()

Adds a new section if requested.

addSection(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

addSectionEntry()

Adds a new entry to a section if requested.

addSectionEntry(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

removeItem()

Removes a section or entry if requested.

removeItem(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

moveUp()

Moves up a section or entry if requested.

moveUp(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

moveDown()

Moves down a section or entry if requested.

moveDown(PDFStructure &$structure) : void
Parameters
$structure : PDFStructure

PDF structure

Return values
void

Search results