Documentation

Document extends AbstractDocument
in package

Pdf document class

Tags
category

Pop

author

Nick Sagona, III dev@nolainteractive.com

copyright

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

license

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

version
5.2.0

Table of Contents

Constants

ORIGIN_BOTTOM_LEFT  = 'ORIGIN_BOTTOM_LEFT'
ORIGIN_BOTTOM_RIGHT  = 'ORIGIN_BOTTOM_RIGHT'
ORIGIN_CENTER  = 'ORIGIN_CENTER'
ORIGIN_TOP_LEFT  = 'ORIGIN_TOP_LEFT'
Document origin constants
ORIGIN_TOP_RIGHT  = 'ORIGIN_TOP_RIGHT'

Properties

$compression  : bool
Compression property
$currentFont  : string|null
Current font
$currentPage  : int|null
Current page
$fonts  : array<string|int, mixed>
Fonts array
$forms  : array<string|int, mixed>
Forms array
$importedFonts  : array<string|int, mixed>
Imported fonts
$importedObjects  : array<string|int, mixed>
Imported objects
$metadata  : Metadata|null
PDF metadata for the info object
$origin  : string
Document origin
$pages  : array<string|int, mixed>
Pages array
$styles  : array<string|int, mixed>
Styles array
$version  : float
PDF version

Methods

__construct()  : AbstractDocument
Constructor
__toString()  : string
Output the PDF document to string
addFont()  : Document
Add a font
addFonts()  : Document
Add fonts
addForm()  : AbstractDocument
Add form
addPage()  : Document
Add a page to the PDF document
addPages()  : Document
Add pages to the PDF document
addStyle()  : Document
Add a style
addStyles()  : AbstractDocument
Add styles
copyPage()  : Page
Copy and return a page of the PDF, adding it to the PDF document
createPage()  : Page
Create and return a new page object, adding it to the PDF document
createStyle()  : Document
Create style
deletePage()  : Document
Delete a page from the PDF document
embedFont()  : Document
Add a font
embedFonts()  : Document
Embed fonts
getAvailableFonts()  : array<string|int, mixed>
Get available fonts that have been added to the PDF document
getAvailableStyles()  : array<string|int, mixed>
Get available styles that have been added to the PDF document
getCurrentFont()  : string|null
Get the current font
getCurrentPage()  : int|null
Get the current page number
getFont()  : Font
Get a PDF font object
getFonts()  : array<string|int, mixed>
Get the PDF font objects array
getForm()  : Form|null
Get form objects
getForms()  : array<string|int, mixed>
Get form objects
getImportedFonts()  : array<string|int, mixed>
Get the import fonts
getImportObjects()  : array<string|int, mixed>
Get the imported objects
getMetadata()  : Metadata|null
Get the document metadata
getNumberOfFonts()  : int
Get the current number of fonts
getNumberOfPages()  : int
Get the current number of pages
getOrigin()  : string
Get the document origin
getPage()  : Page
Get a PDF page object
getPages()  : array<string|int, mixed>
Get the PDF page objects array
getStyle()  : Style
Get a PDF style object
getStyles()  : array<string|int, mixed>
Get the PDF style objects array
getVersion()  : float
Get the document version
hasFont()  : bool
Determine if a font has been added to the PDF document (alias)
hasFonts()  : bool
Determine if the document has font objects
hasForms()  : bool
Determine if the document has form objects
hasImportedFonts()  : bool
Determine if the document has imported fonts
hasImportedObjects()  : bool
Determine if the document has imported objects
hasPages()  : bool
Determine if the document has page objects
hasStyle()  : bool
Determine if a style has been added to the PDF document (alias)
hasStyles()  : bool
Determine if the document has style objects
importFonts()  : Document
Import fonts into document
importObjects()  : Document
Import objects into document
isCompressed()  : bool
Determine whether the PDF is compressed or not
isFontAvailable()  : bool
Determine if a font has been added to the PDF document
isStyleAvailable()  : bool
Determine if a style has been added to the PDF document
orderPages()  : Document
Order the pages
setCompression()  : AbstractDocument
Set the compression
setCurrentFont()  : Document
Set the current font of the PDF document
setCurrentPage()  : Document
Set the current page of the PDF document
setMetadata()  : AbstractDocument
Set the document metadata
setOrigin()  : AbstractDocument
Set the document origin
setVersion()  : AbstractDocument
Set the document version

Constants

ORIGIN_BOTTOM_LEFT

public mixed ORIGIN_BOTTOM_LEFT = 'ORIGIN_BOTTOM_LEFT'

ORIGIN_BOTTOM_RIGHT

public mixed ORIGIN_BOTTOM_RIGHT = 'ORIGIN_BOTTOM_RIGHT'

ORIGIN_TOP_LEFT

Document origin constants

public mixed ORIGIN_TOP_LEFT = 'ORIGIN_TOP_LEFT'

Properties

$importedFonts

Imported fonts

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

$importedObjects

Imported objects

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

Methods

__toString()

Output the PDF document to string

public __toString() : string
Return values
string

addFont()

Add a font

public addFont(Font|string $font[, bool $embedOverride = false ]) : Document
Parameters
$font : Font|string
$embedOverride : bool = false
Tags
throws
Exception
Return values
Document

addFonts()

Add fonts

public addFonts(array<string|int, mixed> $fonts[, bool $embedOverride = false ]) : Document
Parameters
$fonts : array<string|int, mixed>
$embedOverride : bool = false
Tags
throws
Exception
Return values
Document

addPages()

Add pages to the PDF document

public addPages(array<string|int, mixed> $pages) : Document
Parameters
$pages : array<string|int, mixed>
Return values
Document

copyPage()

Copy and return a page of the PDF, adding it to the PDF document

public copyPage(int $p[, bool $preserveContent = true ]) : Page
Parameters
$p : int
$preserveContent : bool = true
Tags
throws
Exception
Return values
Page

createPage()

Create and return a new page object, adding it to the PDF document

public createPage(mixed $size[, int|null $height = null ]) : Page
Parameters
$size : mixed
$height : int|null = null
Tags
throws
Exception
Return values
Page

createStyle()

Create style

public createStyle(Style|string $style[, string|null $font = null ][, int|float|null $size = null ]) : Document
Parameters
$style : Style|string
$font : string|null = null
$size : int|float|null = null
Return values
Document

embedFonts()

Embed fonts

public embedFonts(array<string|int, mixed> $fonts[, bool $embedOverride = false ]) : Document
Parameters
$fonts : array<string|int, mixed>
$embedOverride : bool = false
Tags
throws
Exception
Return values
Document

getAvailableFonts()

Get available fonts that have been added to the PDF document

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

getAvailableStyles()

Get available styles that have been added to the PDF document

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

getCurrentFont()

Get the current font

public getCurrentFont() : string|null
Return values
string|null

getCurrentPage()

Get the current page number

public getCurrentPage() : int|null
Return values
int|null

getFonts()

Get the PDF font objects array

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

getForm()

Get form objects

public getForm(string $name) : Form|null
Parameters
$name : string
Return values
Form|null

getForms()

Get form objects

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

getImportedFonts()

Get the import fonts

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

getImportObjects()

Get the imported objects

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

getNumberOfFonts()

Get the current number of fonts

public getNumberOfFonts() : int
Return values
int

getNumberOfPages()

Get the current number of pages

public getNumberOfPages() : int
Return values
int

getOrigin()

Get the document origin

public getOrigin() : string
Return values
string

getPages()

Get the PDF page objects array

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

getStyles()

Get the PDF style objects array

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

getVersion()

Get the document version

public getVersion() : float
Return values
float

hasFont()

Determine if a font has been added to the PDF document (alias)

public hasFont(string $font) : bool
Parameters
$font : string
Return values
bool

hasFonts()

Determine if the document has font objects

public hasFonts() : bool
Return values
bool

hasForms()

Determine if the document has form objects

public hasForms() : bool
Return values
bool

hasImportedFonts()

Determine if the document has imported fonts

public hasImportedFonts() : bool
Return values
bool

hasImportedObjects()

Determine if the document has imported objects

public hasImportedObjects() : bool
Return values
bool

hasPages()

Determine if the document has page objects

public hasPages() : bool
Return values
bool

hasStyle()

Determine if a style has been added to the PDF document (alias)

public hasStyle(string $style) : bool
Parameters
$style : string
Return values
bool

hasStyles()

Determine if the document has style objects

public hasStyles() : bool
Return values
bool

importFonts()

Import fonts into document

public importFonts(array<string|int, mixed> $fonts) : Document
Parameters
$fonts : array<string|int, mixed>
Return values
Document

importObjects()

Import objects into document

public importObjects(array<string|int, mixed> $objects) : Document
Parameters
$objects : array<string|int, mixed>
Return values
Document

isCompressed()

Determine whether the PDF is compressed or not

public isCompressed() : bool
Return values
bool

isFontAvailable()

Determine if a font has been added to the PDF document

public isFontAvailable(string $font) : bool
Parameters
$font : string
Return values
bool

isStyleAvailable()

Determine if a style has been added to the PDF document

public isStyleAvailable(string $style) : bool
Parameters
$style : string
Return values
bool

orderPages()

Order the pages

public orderPages(array<string|int, mixed> $pages) : Document
Parameters
$pages : array<string|int, mixed>
Tags
throws
Exception
Return values
Document

setCurrentFont()

Set the current font of the PDF document

public setCurrentFont(string $name) : Document
Parameters
$name : string
Tags
throws
Exception
Return values
Document

setCurrentPage()

Set the current page of the PDF document

public setCurrentPage(int $p) : Document
Parameters
$p : int
Tags
throws
Exception
Return values
Document 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results