PDFStructure
in package
PDF structure
Tags
Table of Contents
- FOLDING_NONE = 'no'
- no folding marks
- FOLDING_STANDARD = 'standard'
- standard folding marks
- NO_LOGO = 'none'
- $foldingMarks : string
- $logo : string
- $sections : array<string|int, mixed>
- $title : string
-
export()
: array<string, string|string[]|array
- Returns an array representation of the structure.
- getFoldingMarks() : string
- Returns if to print folding marks.
- getLogo() : string
- Returns the logo file path.
- getSections() : array<string|int, PDFTextSection>|array<string|int, PDFEntrySection>
- Returns the sections.
- getTitle() : string
- Returns the title.
- import() : void
- Imports an array representation of the structure.
- isValidLogoFileName() : bool
- Returns if the given logo file name is valid.
- setFoldingMarks() : void
- Sets if to print folding marks.
- setLogo() : void
- Sets the logo file path.
- setSections() : void
- Sets the sections.
- setTitle() : void
- Sets the title.
Constants
FOLDING_NONE
no folding marks
public
mixed
FOLDING_NONE
= 'no'
FOLDING_STANDARD
standard folding marks
public
mixed
FOLDING_STANDARD
= 'standard'
NO_LOGO
public
mixed
NO_LOGO
= 'none'
Properties
$foldingMarks
private
string
$foldingMarks
= 'no'
$logo
private
string
$logo
= self::NO_LOGO
$sections
private
array<string|int, mixed>
$sections
= []
sections
$title
private
string
$title
= 'LDAP Account Manager'
Methods
export()
Returns an array representation of the structure.
public
export() : array<string, string|string[]|array[]>
Return values
array<string, string|string[]|arrayexport data
getFoldingMarks()
Returns if to print folding marks.
public
getFoldingMarks() : string
Return values
string —print folding marks
getLogo()
Returns the logo file path.
public
getLogo() : string
Return values
string —logo
getSections()
Returns the sections.
public
getSections() : array<string|int, PDFTextSection>|array<string|int, PDFEntrySection>
Return values
array<string|int, PDFTextSection>|array<string|int, PDFEntrySection> —$sections
getTitle()
Returns the title.
public
getTitle() : string
Return values
string —title
import()
Imports an array representation of the structure.
public
import(array<string, string|string[]|array[]> $data) : void
Parameters
-
$data
: array<string, string|string[]|array
-
import data
Return values
void —isValidLogoFileName()
Returns if the given logo file name is valid.
public
static isValidLogoFileName(string $fileName) : bool
Parameters
- $fileName : string
-
file name
Return values
bool —valid
setFoldingMarks()
Sets if to print folding marks.
public
setFoldingMarks(string|null $foldingMarks) : void
Parameters
- $foldingMarks : string|null
-
print folding marks
Tags
Return values
void —setLogo()
Sets the logo file path.
public
setLogo(string|null $logo) : void
Parameters
- $logo : string|null
-
logo
Tags
Return values
void —setSections()
Sets the sections.
public
setSections(array<string|int, PDFEntrySection>|array<string|int, PDFTextSection> $sections) : void
Parameters
- $sections : array<string|int, PDFEntrySection>|array<string|int, PDFTextSection>
-
sections
Return values
void —setTitle()
Sets the title.
public
setTitle(string $title) : void
Parameters
- $title : string
-
title