API Documentation
\
Pop
Acl
Assertion
Policy
Audit
Adapter
Model
Auth
Cache
Adapter
Code
Generator
Traits
Reflection
Config
Console
Controller
Cookie
Css
Color
Csv
Db
Adapter
Profiler
Gateway
Record
Relationships
Sql
Migration
Parser
Predicate
Schema
Formatter
Seeder
Debug
Handler
Storage
Dir
Dom
Event
Filter
Form
Element
Input
Select
Ftp
Http
Client
Server
Request
I18n
Format
Image
Adapter
Adjust
Color
Draw
Effect
Filter
Layer
Type
Kettle
Controller
Event
Model
Loader
Log
Writer
Mail
Client
Message
Transport
Smtp
Auth
Stream
Byte
Filter
Mime
Part
Model
Module
Nav
Paginator
Pdf
Build
Font
Standard
TrueType
Table
Cmap
Html
Image
PdfObject
Document
Page
Annotation
Color
Field
Text
Queue
Adapter
Processor
Jobs
Router
Match
Service
Session
Utils
Validator
View
Template
Stream
Popcorn

\Pop\Pdf\BuildCompiler

Pdf compiler class

Summary

Methods
Properties
Constants
getDocument()
getRoot()
getParent()
getInfo()
getFonts()
getFontReferences()
lastIndex()
getOutput()
setDocument()
finalize()
prepareFonts()
No public properties found
No constants found
setRoot()
setParent()
setInfo()
calculateByteLength()
formatByteLength()
getCoordinates()
prepareImages()
prepareText()
prepareAnnotations()
preparePaths()
prepareTextStreams()
prepareFields()
prepareForms()
$root
$parent
$info
$document
$pages
$objects
$fonts
$fontReferences
$compression
$byteLength
$trailer
$output
N/A
No private methods found
No private properties found
N/A

Properties

$objects

$objects : array

Objects array

Type

array

$fonts

$fonts : array

Fonts array

Type

array

$fontReferences

$fontReferences : array

Font references

Type

array

$compression

$compression : boolean

Compression property

Type

boolean

$byteLength

$byteLength : integer

PDF byte length

Type

integer

$trailer

$trailer : string

PDF document trailer

Type

string

$output

$output : string

PDF document output buffer

Type

string

Methods

getDocument()

getDocument() : \Pop\Pdf\Document

Get the document object

Returns

\Pop\Pdf\Document

getFonts()

getFonts() : array

Get the fonts

Returns

array

getFontReferences()

getFontReferences() : array

Get the font references

Returns

array

lastIndex()

lastIndex() : integer

Return the last object index.

Returns

integer

getOutput()

getOutput() : string

Get the compiled output

Returns

string

finalize()

finalize(\Pop\Pdf\Document\AbstractDocument  $document = null) : void

Compile and finalize the PDF document

Parameters

\Pop\Pdf\Document\AbstractDocument $document

prepareFonts()

prepareFonts() : void

Prepare the font objects

calculateByteLength()

calculateByteLength(string  $string) : integer

Calculate byte length

Parameters

string $string

Returns

integer

formatByteLength()

formatByteLength(integer|string  $num) : string

Format byte length

Parameters

integer|string $num

Returns

string

getCoordinates()

getCoordinates(integer  $x, integer  $y, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : array

Get coordinates based on document origin

Parameters

integer $x
integer $y
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

Returns

array

prepareImages()

prepareImages(array  $images, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the image objects

Parameters

array $images
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

prepareText()

prepareText(array  $text, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the text objects

Parameters

array $text
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

Throws

\Pop\Pdf\Build\Exception

prepareAnnotations()

prepareAnnotations(array  $annotations, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the annotation objects

Parameters

array $annotations
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

preparePaths()

preparePaths(array  $paths, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the path objects

Parameters

array $paths
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

prepareTextStreams()

prepareTextStreams(array  $textStreams, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the text streams objects

Parameters

array $textStreams
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

Throws

\Pop\Pdf\Build\Exception

prepareFields()

prepareFields(array  $fields, \Pop\Pdf\Build\PdfObject\PageObject  $pageObject) : void

Prepare the field objects

Parameters

array $fields
\Pop\Pdf\Build\PdfObject\PageObject $pageObject

Throws

\Pop\Pdf\Build\Exception

prepareForms()

prepareForms() : void

Prepare the form objects