Documentation

AbstractCompiler
in package
implements CompilerInterface

Abstract Pdf compiler class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

Copyright (c) 2009-2021 NOLA Interactive, LLC. (http://www.nolainteractive.com)

license

http://www.popphp.org/license New BSD License

version
4.2.0

Interfaces, Classes and Traits

CompilerInterface
Compiler interface

Table of Contents

$byteLength  : int
PDF byte length
$compression  : bool
Compression property
$document  : Document
Document object
$fontReferences  : array<string|int, mixed>
Font references
$fonts  : array<string|int, mixed>
Fonts array
$info  : InfoObject
Info object
$objects  : array<string|int, mixed>
Objects array
$output  : string
PDF document output buffer
$pages  : array<string|int, Page>
Pages array
$parent  : ParentObject
Parent object
$root  : RootObject
Root object
$trailer  : string
PDF document trailer
finalize()  : void
Compile and finalize the PDF document
getDocument()  : Document
Get the document object
getFontReferences()  : array<string|int, mixed>
Get the font references
getFonts()  : array<string|int, mixed>
Get the fonts
getInfo()  : InfoObject
Get the info object
getOutput()  : string
Get the compiled output
getParent()  : ParentObject
Get the parent object
getRoot()  : RootObject
Get the root object
lastIndex()  : int
Return the last object index.
prepareFonts()  : void
Prepare the font objects
setDocument()  : Compiler
Set the document object
calculateByteLength()  : int
Calculate byte length
formatByteLength()  : string
Format byte length
getCoordinates()  : array<string|int, mixed>
Get coordinates based on document origin
prepareAnnotations()  : void
Prepare the annotation objects
prepareImages()  : void
Prepare the image objects
preparePaths()  : void
Prepare the path objects
prepareText()  : void
Prepare the text objects
setInfo()  : AbstractCompiler
Set the info object
setParent()  : AbstractCompiler
Set the parent object
setRoot()  : AbstractCompiler
Set the root object

Properties

$fontReferences

Font references

protected array<string|int, mixed> $fontReferences = []

Methods

getFontReferences()

Get the font references

public getFontReferences() : array<string|int, mixed>
Return values
array<string|int, mixed>

getFonts()

Get the fonts

public getFonts() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOutput()

Get the compiled output

public getOutput() : string
Return values
string

lastIndex()

Return the last object index.

public lastIndex() : int
Return values
int

prepareFonts()

Prepare the font objects

public abstract prepareFonts() : void
Return values
void

calculateByteLength()

Calculate byte length

protected calculateByteLength(string $string) : int
Parameters
$string : string
Return values
int

formatByteLength()

Format byte length

protected formatByteLength(int|string $num) : string
Parameters
$num : int|string
Return values
string

getCoordinates()

Get coordinates based on document origin

protected getCoordinates(int $x, int $y, PageObject $pageObject) : array<string|int, mixed>
Parameters
$x : int
$y : int
$pageObject : PageObject
Return values
array<string|int, mixed>

prepareAnnotations()

Prepare the annotation objects

protected abstract prepareAnnotations(array<string|int, mixed> $annotations, PageObject $pageObject) : void
Parameters
$annotations : array<string|int, mixed>
$pageObject : PageObject
Return values
void

prepareImages()

Prepare the image objects

protected abstract prepareImages(array<string|int, mixed> $images, PageObject $pageObject) : void
Parameters
$images : array<string|int, mixed>
$pageObject : PageObject
Return values
void

preparePaths()

Prepare the path objects

protected abstract preparePaths(array<string|int, mixed> $paths, PageObject $pageObject) : void
Parameters
$paths : array<string|int, mixed>
$pageObject : PageObject
Return values
void

prepareText()

Prepare the text objects

protected abstract prepareText(array<string|int, mixed> $text, PageObject $pageObject) : void
Parameters
$text : array<string|int, mixed>
$pageObject : PageObject
Return values
void

Search results