API Documentation
\
Pop
Acl
Assertion
Resource
Role
Archive
Adapter
Compress
Auth
Adapter
Cache
Adapter
Code
Generator
Config
Console
Input
Controller
Cookie
Crypt
Data
Type
Db
Adapter
Gateway
Parser
Record
Sql
Dom
Event
Feed
Format
File
Form
Element
Input
Template
Ftp
Http
Client
I18n
Format
Image
Adjust
Draw
Effect
Factory
Filter
Layer
Type
Loader
Log
Writer
Mail
Module
Nav
Paginator
Payment
Adapter
Pdf
Build
Font
TrueType
Table
Cmap
Image
Object
Document
Page
Annotation
Color
Field
Router
Match
Service
Session
Shipping
Adapter
Validator
Version
View
Template

\Pop\Pdf\DocumentAbstractPage

Abstract Page class

Summary

Methods
Properties
Constants
setWidth()
setHeight()
setIndex()
getWidth()
getHeight()
getIndex()
getImages()
getText()
getAnnotations()
getPaths()
getFields()
hasImages()
hasText()
hasAnnotations()
hasPaths()
hasFields()
__construct()
addImage()
addText()
addAnnotation()
addUrl()
addLink()
addPath()
addField()
No public properties found
ENVELOPE_10
ENVELOPE_C5
ENVELOPE_DL
FOLIO
EXECUTIVE
LETTER
LEGAL
LEDGER
TABLOID
A0
A1
A2
A3
A4
A5
A6
A7
A8
A9
B0
B1
B2
B3
B4
B5
B6
B7
B8
B9
B10
No protected methods found
$sizes
$index
$width
$height
$images
$text
$annotations
$paths
$fields
N/A
No private methods found
No private properties found
N/A

Constants

ENVELOPE_10

ENVELOPE_10

Page size constants

ENVELOPE_C5

ENVELOPE_C5

ENVELOPE_DL

ENVELOPE_DL

FOLIO

FOLIO

EXECUTIVE

EXECUTIVE

LETTER

LETTER

LEDGER

LEDGER

TABLOID

TABLOID

A0

A0

A1

A1

A2

A2

A3

A3

A4

A4

A5

A5

A6

A6

A7

A7

A8

A8

A9

A9

B0

B0

B1

B1

B2

B2

B3

B3

B4

B4

B5

B5

B6

B6

B7

B7

B8

B8

B9

B9

B10

B10

Properties

$sizes

$sizes : array

Array of page sizes

Type

array

$index

$index : integer

Page index if page object represents an imported page

Type

integer

$width

$width : integer

Page width

Type

integer

$height

$height : integer

Page height

Type

integer

$images

$images : array

Images array

Type

array

$text

$text : array

Text array

Type

array

$annotations

$annotations : array

Annotations array

Type

array

$paths

$paths : array

Paths array

Type

array

$fields

$fields : array

Fields array

Type

array

Methods

setWidth()

setWidth(mixed  $width) : \Pop\Pdf\Document\Page

Set the page width

Parameters

mixed $width

Returns

\Pop\Pdf\Document\Page

setHeight()

setHeight(mixed  $height) : \Pop\Pdf\Document\Page

Set the page height

Parameters

mixed $height

Returns

\Pop\Pdf\Document\Page

setIndex()

setIndex(integer  $i) : \Pop\Pdf\Document\Page

Set the page index

Parameters

integer $i

Returns

\Pop\Pdf\Document\Page

getWidth()

getWidth() : integer

Get the page width

Returns

integer

getHeight()

getHeight() : integer

Get the page height

Returns

integer

getIndex()

getIndex() : integer

Get the page index

Returns

integer

getImages()

getImages() : array

Get image objects

Returns

array

getText()

getText() : array

Get text objects

Returns

array

getAnnotations()

getAnnotations() : array

Get annotation objects

Returns

array

getPaths()

getPaths() : array

Get path objects

Returns

array

getFields()

getFields() : array

Get field objects

Returns

array

hasImages()

hasImages() : boolean

Determine if the page has image objects

Returns

boolean

hasText()

hasText() : boolean

Determine if the page has text objects

Returns

boolean

hasAnnotations()

hasAnnotations() : boolean

Determine if the page has annotation objects

Returns

boolean

hasPaths()

hasPaths() : boolean

Determine if the page has path objects

Returns

boolean

hasFields()

hasFields() : boolean

Determine if the page has field objects

Returns

boolean

__construct()

__construct(mixed  $size, mixed  $height = null, integer  $i = null) : \Pop\Pdf\Document\AbstractPage

Constructor

Instantiate a PDF page.

Parameters

mixed $size
mixed $height
integer $i

Throws

\Pop\Pdf\Document\Exception

Returns

\Pop\Pdf\Document\AbstractPage

addText()

addText(\Pop\Pdf\Document\Page\Text  $text, string  $font, integer  $x, integer  $y) : \Pop\Pdf\Document\Page

Add text to the PDF page

Parameters

\Pop\Pdf\Document\Page\Text $text
string $font
integer $x
integer $y

Returns

\Pop\Pdf\Document\Page