Docs For Class Cpdf

Cpdf

Description

Cpdf

http://www.ros.co.nz/pdf

A PHP class to provide the basic functionality to create a pdf document without any requirement for additional modules.

Note that they companion class CezPdf can be used to extend this class and dramatically simplify the creation of documents.

IMPORTANT NOTE there is no warranty, implied or otherwise with this software.

LICENCE This code has been placed in the Public Domain for all to enjoy.

author: Wayne Munro <pdf@ros.co.nz>
version: 009
filesource: Source Code for this file

Located in /includes/class.pdf.php (line 23)

Direct descendents

Class	Description
Cezpdf	Cpdf

Variable Summary

mixed $addLooseObjects

mixed $arc4

mixed $arc4_objnum

mixed $callback

mixed $catalogId

mixed $checkpoint

mixed $currentBaseFont

mixed $currentColour

mixed $currentContents

mixed $currentFont

mixed $currentFontNum

mixed $currentLineStyle

mixed $currentNode

mixed $currentPage

mixed $currentStrokeColour

mixed $currentTextState

mixed $destinations

mixed $encrypted

mixed $encryptionKey

mixed $fileIdentifier

mixed $firstPageId

mixed $fontFamilies

mixed $fonts

mixed $infoObject

mixed $looseObjects

mixed $messages

mixed $nCallback

mixed $nStack

mixed $nStateStack

mixed $numFonts

mixed $numImages

mixed $numObj

mixed $numPages

mixed $objects

mixed $options

mixed $procsetObjectId

mixed $stack

mixed $stateStack

mixed $wordSpaceAdjust

Method Summary

Cpdf Cpdf ([ $pageSize = array(0,0,612,792)])

void addDestination ( $label, $style, [ $a = 0], [ $b = 0], [ $c = 0])

void addImage ( &$img, $x, $y, [ $w = 0], [ $h = 0], [ $quality = 75])

void addInfo ( $label, [ $value = 0])

void addInternalLink ( $label, $x0, $y0, $x1, $y1)

void addJpegFromFile ( $img, $x, $y, [ $w = 0], [ $h = 0])

void addLink ( $url, $x0, $y0, $x1, $y1)

void addMessage ( $message)

void addObject ( $id, [ $options = 'add'])

void addPngFromFile ( $file, $x, $y, [ $w = 0], [ $h = 0])

void addText ( $x, $y, $size, $text, [ $angle = 0], [ $wordSpaceAdjust = 0])

void addTextWrap ( $x, $y, $width, $size, $text, [ $justification = 'left'], [ $angle = 0], [ $test = 0])

void ARC4 ( $text)

void ARC4_init ([ $key = ''])

void checkAllHere ()

void closeObject ()

void curve ( $x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3)

void ellipse ( $x0, $y0, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8], [ $astart = 0], [ $afinish = 360], [ $close = 1], [ $fill = 0])

void encryptInit ( $id)

void filledEllipse ( $x0, $y0, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8], [ $astart = 0], [ $afinish = 360])

void filledRectangle ( $x1, $y1, $width, $height)

void getFirstPageId ()

void getFontDecender ( $size)

void getFontHeight ( $size)

void getTextWidth ( $size, $text)

void line ( $x1, $y1, $x2, $y2)

void md5_16 ( $string)

void newPage ([ $insert = 0], [ $id = 0], [ $pos = 'after'])

void openHere ( $style, [ $a = 0], [ $b = 0], [ $c = 0])

void openObject ()

void output ([ $debug = 0])

void o_action ( $id, $action, [ $options = ''])

void o_annotation ( $id, $action, [ $options = ''])

void o_catalog ( $id, $action, [ $options = ''])

void o_contents ( $id, $action, [ $options = ''])

void o_destination ( $id, $action, [ $options = ''])

void o_encryption ( $id, $action, [ $options = ''])

void o_font ( $id, $action, [ $options = ''])

void o_fontDescriptor ( $id, $action, [ $options = ''])

void o_fontEncoding ( $id, $action, [ $options = ''])

void o_image ( $id, $action, [ $options = ''])

void o_info ( $id, $action, [ $options = ''])

void o_outlines ( $id, $action, [ $options = ''])

void o_page ( $id, $action, [ $options = ''])

void o_pages ( $id, $action, [ $options = ''])

void o_procset ( $id, $action, [ $options = ''])

void o_viewerPreferences ( $id, $action, [ $options = ''])

void partEllipse ( $x0, $y0, $astart, $afinish, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8])

void polygon ( $p, $np, [ $f = 0])

void rectangle ( $x1, $y1, $width, $height)

void reopenObject ( $id)

void restoreState ([ $pageEnd = 0])

void saveState ([ $pageEnd = 0])

void selectFont ( $fontName, [ $encoding = ''], [ $set = 1])

void setColor ( $r, $g, $b, [ $force = 0])

void setEncryption ([ $userPass = ''], [ $ownerPass = ''], [ $pc = array()])

void setFontFamily ( $family, [ $options = ''])

void setLineStyle ([ $width = 1], [ $cap = ''], [ $join = ''], [ $dash = ''], [ $phase = 0])

void setPreferences ( $label, [ $value = 0])

void setStrokeColor ( $r, $g, $b, [ $force = 0])

void stopObject ( $id)

void stream ([ $options = ''])

void transaction ( $action)

Variables

mixed $addLooseObjects = array() (line 111)

array contains infomation about how the loose objects are to be added to the document

mixed $arc4 = '' (line 156)

the ancryption array for the document encryption is stored here

mixed $arc4_objnum (line 160)

the object Id of the encryption information

mixed $callback = array() (line 176)

array which forms a stack to keep track of nested callback functions

mixed $catalogId (line 36)

the objectId (number within the objects array) of the document catalog

mixed $checkpoint = '' (line 191)

store the stack for the transaction commands, each item in here is a record of the values of all the variables within the class, so that the user can rollback at will (from each 'start' command) note that this includes the objects array, so these can be large.

mixed $currentBaseFont = '' (line 49)

the current base font

mixed $currentColour = array('r'=>-1,'g'=>-1,'b'=>-1) (line 73)

current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active

mixed $currentContents (line 65)

object number of the currently active contents block

mixed $currentFont = '' (line 45)

a record of the current font

mixed $currentFontNum (line 53)

the number of the current font within the font array

mixed $currentLineStyle = '' (line 81)

current style that lines are drawn in

mixed $currentNode (line 57)

mixed $currentPage (line 61)

object number of the current page

mixed $currentStrokeColour = array('r'=>-1,'g'=>-1,'b'=>-1) (line 77)

current colour for stroke operations (lines etc.)

mixed $currentTextState = '' (line 148)

track if the current font is bolded or italicised

mixed $destinations = array() (line 185)

store label->id pairs for named destinations, these will be used to replace internal links

done this way so that destinations can be defined after the location that links to them

mixed $encrypted (line 168)

a flag to say if a document is to be encrypted or not

mixed $encryptionKey = '' (line 172)

the ancryption key for the encryption of all the document content (structure is not encrypted)

mixed $fileIdentifier = '' (line 164)

the file identifier, used to uniquely identify a pdf document

mixed $firstPageId (line 129)

the objectId of the first page of the document

mixed $fontFamilies = array() (line 144)

store the information about the relationship between font families this used so that the code knows which font is the bold version of another font, etc.

the value of this array is initialised in the constuctor function.

mixed $fonts = array() (line 41)

array carrying information about the fonts that the system currently knows about

used to ensure that a font is not loaded twice, among other things

mixed $infoObject (line 116)

the objectId of the information object for the document this contains authorship, title etc.

mixed $looseObjects = array() (line 107)

an array which contains information about the objects which are not firmly attached to pages

these have been added with the addObject function

mixed $messages = '' (line 152)

messages are stored here during processing, these can be selected afterwards to give some useful debug information

mixed $nCallback = 0 (line 180)

the number of callback functions in the callback array

mixed $nStack (line 102)

number of elements within the object Id storage stack

mixed $nStateStack = 0 (line 90)

number of elements within the state stack

mixed $numFonts (line 69)

number of fonts within the system

mixed $numImages (line 120)

number of images being tracked within the document

mixed $numObj (line 28)

the current number of pdf objects in the document

mixed $numPages (line 94)

number of page objects within the document

mixed $objects = array() (line 32)

this array contains all of the pdf objects, ready for final assembly

mixed $options = array('compression'=>1) (line 125)

an array containing options about the document

it defaults to turning on the compression of the objects

mixed $procsetObjectId (line 138)

the object Id of the procset object

mixed $stack = array() (line 98)

object Id storage stack

mixed $stateStack = array() (line 86)

an array which is used to save the state of the document, mainly the colours and styles

it is used to temporarily change to another state, the change back to what it was before

mixed $wordSpaceAdjust (line 134)

used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed.

Methods

Constructor Cpdf (line 197)

class constructor

this will start a new document

var: array of 4 numbers, defining the bottom left and upper right corner of the page. first two are normally zero.

Cpdf Cpdf ([ $pageSize = array(0,0,612,792)])

$pageSize

addDestination (line 2971)

create a labelled destination within the document

void addDestination ( $label, $style, [ $a = 0], [ $b = 0], [ $c = 0])

$label
$style
$a
$b
$c

addImage (line 2872)

add an image into the document, from a GD object

this function is not all that reliable, and I would probably encourage people to use the file based functions

void addImage ( &$img, $x, $y, [ $w = 0], [ $h = 0], [ $quality = 75])

&$img
$x
$y
$w
$h
$quality

addInfo (line 2592)

add content to the documents info object

void addInfo ( $label, [ $value = 0])

$label
$value

addInternalLink (line 1173)

add a link in the document to an internal destination (ie. within the document)

void addInternalLink ( $label, $x0, $y0, $x1, $y1)

$label
$x0
$y0
$x1
$y1

addJpegFromFile (line 2827)

add a JPEG image into the document, from a file

void addJpegFromFile ( $img, $x, $y, [ $w = 0], [ $h = 0])

$img
$x
$y
$w
$h

addLink (line 1164)

add a link in the document to an external URL

void addLink ( $url, $x0, $y0, $x1, $y1)

$url
$x0
$y0
$x1
$y1

addMessage (line 3024)

used to add messages for use in debugging

void addMessage ( $message)

$message

addObject (line 2546)

after an object has been created, it wil only show if it has been added, using this function.

void addObject ( $id, [ $options = 'add'])

$id
$options

addPngFromFile (line 2639)

add a PNG image into the document, from a file

this should work with remote files

void addPngFromFile ( $file, $x, $y, [ $w = 0], [ $h = 0])

$file
$x
$y
$w
$h

addText (line 2158)

add text to the document, at a specified location, size and angle on the page

void addText ( $x, $y, $size, $text, [ $angle = 0], [ $wordSpaceAdjust = 0])

$x
$y
$size
$text
$angle
$wordSpaceAdjust

addTextWrap (line 2333)

add text to the page, but ensure that it fits within a certain width if it does not fit then put in as much as possible, splitting at word boundaries and return the remainder.

justification and angle can also be specified for the text

void addTextWrap ( $x, $y, $width, $size, $text, [ $justification = 'left'], [ $angle = 0], [ $test = 0])

$x
$y
$width
$size
$text
$justification
$angle
$test

ARC4 (line 1138)

ARC4 encrypt a text string

void ARC4 ( $text)

$text

ARC4_init (line 1112)

initialize the ARC4 encryption

void ARC4_init ([ $key = ''])

$key

checkAllHere (line 1214)

should be used for internal checks, not implemented as yet

void checkAllHere ()

closeObject (line 2520)

close an object

void closeObject ()

curve (line 1684)

draw a bezier curve based on 4 control points

void curve ( $x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3)

ellipse (line 1715)

draw an ellipse note that the part and filled ellipse are just special cases of this function

draws an ellipse in the current line style centered at $x0,$y0, radii $r1,$r2 if $r2 is not set, then a circle is drawn nSeg is not allowed to be less than 2, as this will simply draw a line (and will even draw a pretty crappy shape at 2, as we are approximating with bezier curves.

void ellipse ( $x0, $y0, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8], [ $astart = 0], [ $afinish = 360], [ $close = 1], [ $fill = 0])

$x0
$y0
$r1
$r2
$angle
$nSeg
$astart
$afinish
$close
$fill

encryptInit (line 1098)

initialize the encryption for processing a particular object

void encryptInit ( $id)

filledEllipse (line 1701)

draw a filled ellipse

void filledEllipse ( $x0, $y0, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8], [ $astart = 0], [ $afinish = 360])

$x0
$y0
$r1
$r2
$angle
$nSeg
$astart
$afinish

filledRectangle (line 1837)

a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not

the coordinates of the upper-right corner

void filledRectangle ( $x1, $y1, $width, $height)

$x1
$y1
$width
$height

getFirstPageId (line 1641)

function for the user to find out what the ID is of the first page that was created during startup - useful if they wish to add something to it later.

void getFirstPageId ()

getFontDecender (line 1945)

return the font decender, this will normally return a negative number

if you add this number to the baseline, you get the level of the bottom of the font it is in the pdf user units

void getFontDecender ( $size)

$size

getFontHeight (line 1931)

return the height in units of the current font in the given size

void getFontHeight ( $size)

$size

getTextWidth (line 2250)

calculate how wide a given text string will be on a page, at a given size.

this can be called externally, but is alse used by the other class functions

void getTextWidth ( $size, $text)

$size
$text

line (line 1677)

draw a line from one set of coordinates to another

void line ( $x1, $y1, $x2, $y2)

md5_16 (line 1086)

calculate the 16 byte version of the 128 bit md5 digest of the string

void md5_16 ( $string)

$string

newPage (line 1853)

add a new page to the document

this also makes the new page the current active object

void newPage ([ $insert = 0], [ $id = 0], [ $pos = 'after'])

$insert
$id
$pos

openHere (line 2951)

specify where the document should open when it first starts

void openHere ( $style, [ $a = 0], [ $b = 0], [ $c = 0])

$style
$a
$b
$c

openObject (line 2492)

make a loose object, the output will go into this object, until it is closed, then will revert to the current one.

this object will not appear until it is included within a page. the function will return the object number

void openObject ()

output (line 1220)

return the pdf stream as a string returned from the function

void output ([ $debug = 0])

$debug

o_action (line 726)

an action object, used to link to URLS initially

void o_action ( $id, $action, [ $options = ''])

$id
$action
$options

o_annotation (line 769)

an annotation object, this will add an annotation to the current page.

initially will support just link annotations

void o_annotation ( $id, $action, [ $options = ''])

$id
$action
$options

o_catalog (line 297)

define the document catalog, the overall controller for the document

void o_catalog ( $id, $action, [ $options = ''])

$id
$action
$options

o_contents (line 890)

the contents objects hold all of the content which appears on pages

void o_contents ( $id, $action, [ $options = ''])

$id
$action
$options

o_destination (line 224)

destination object, used to specify the location for the user to jump to, presently on opening

void o_destination ( $id, $action, [ $options = ''])

$id
$action
$options

o_encryption (line 1015)

encryption object.

void o_encryption ( $id, $action, [ $options = ''])

$id
$action
$options

o_font (line 475)

an object to hold the font description

void o_font ( $id, $action, [ $options = ''])

$id
$action
$options

o_fontDescriptor (line 559)

a font descriptor, needed for including additional fonts

void o_fontDescriptor ( $id, $action, [ $options = ''])

$id
$action
$options

o_fontEncoding (line 610)

the font encoding

void o_fontEncoding ( $id, $action, [ $options = ''])

$id
$action
$options

o_image (line 940)

an image object, will be an XObject in the document, includes description and data

void o_image ( $id, $action, [ $options = ''])

$id
$action
$options

o_info (line 682)

define the document information

void o_info ( $id, $action, [ $options = ''])

$id
$action
$options

o_outlines (line 445)

define the outlines in the doc, empty for now

void o_outlines ( $id, $action, [ $options = ''])

$id
$action
$options

o_page (line 821)

a page object, it also creates a contents object to hold its contents

void o_page ( $id, $action, [ $options = ''])

$id
$action
$options

o_pages (line 347)

object which is a parent to the pages in the document

void o_pages ( $id, $action, [ $options = ''])

$id
$action
$options

o_procset (line 647)

the document procset, solves some problems with printing to old PS printers

void o_procset ( $id, $action, [ $options = ''])

$id
$action
$options

o_viewerPreferences (line 259)

set the viewer preferences

void o_viewerPreferences ( $id, $action, [ $options = ''])

$id
$action
$options

partEllipse (line 1694)

draw a part of an ellipse

void partEllipse ( $x0, $y0, $astart, $afinish, $r1, [ $r2 = 0], [ $angle = 0], [ $nSeg = 8])

$x0
$y0
$astart
$afinish
$r1
$r2
$angle
$nSeg

polygon (line 1820)

draw a polygon, the syntax for this is similar to the GD polygon command

void polygon ( $p, $np, [ $f = 0])

rectangle (line 1845)

draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not

the coordinates of the upper-right corner

void rectangle ( $x1, $y1, $width, $height)

$x1
$y1
$width
$height

reopenObject (line 2507)

open an existing object for editing

void reopenObject ( $id)

restoreState (line 2473)

restore a previously saved state

void restoreState ([ $pageEnd = 0])

$pageEnd

saveState (line 2449)

this will be called at a new page to return the state to what it was on the

end of the previous page, before the stack was closed down This is to get around not being able to have open 'q' across pages

void saveState ([ $pageEnd = 0])

$pageEnd

selectFont (line 1419)

if the font is not loaded then load it and make the required object

else just make it the current font the encoding array can contain 'encoding'=> 'none','WinAnsiEncoding','MacRomanEncoding' or 'MacExpertEncoding' note that encoding='none' will need to be used for symbolic fonts and 'differences' => an array of mappings between numbers 0->255 and character names.

void selectFont ( $fontName, [ $encoding = ''], [ $set = 1])

$fontName
$encoding
$set

setColor (line 1657)

sets the colour for fill operations

void setColor ( $r, $g, $b, [ $force = 0])

$r
$g
$b
$force

setEncryption (line 1184)

set the encryption of the document can be used to turn it on and/or set the passwords which it will have.

also the functions that the user will have are set here, such as print, modify, add

void setEncryption ([ $userPass = ''], [ $ownerPass = ''], [ $pc = array()])

$userPass
$ownerPass
$pc

setFontFamily (line 2987)

define font families, this is used to initialize the font families for the default fonts and for the user to add new ones for their fonts. The default bahavious can be overridden should that be desired.

void setFontFamily ( $family, [ $options = ''])

$family
$options

setLineStyle (line 1791)

this sets the line drawing style.

width, is the thickness of the line in user units cap is the type of cap to put on the line, values can be 'butt','round','square' where the diffference between 'square' and 'butt' is that 'square' projects a flat end past the end of the line. join can be 'miter', 'round', 'bevel' dash is an array which sets the dash pattern, is a series of length values, which are the lengths of the on and off dashes. (2) represents 2 on, 2 off, 2 on , 2 off ... (2,1) is 2 on, 1 off, 2 on, 1 off.. etc phase is a modifier on the dash pattern which is used to shift the point at which the pattern starts.

void setLineStyle ([ $width = 1], [ $cap = ''], [ $join = ''], [ $dash = ''], [ $phase = 0])

$width
$cap
$join
$dash
$phase

setPreferences (line 2609)

set the viewer preferences of the document, it is up to the browser to obey these.

void setPreferences ( $label, [ $value = 0])

$label
$value

setStrokeColor (line 1667)

sets the colour for stroke operations

void setStrokeColor ( $r, $g, $b, [ $force = 0])

$r
$g
$b
$force

stopObject (line 2535)

stop an object from appearing on pages from this point on

void stopObject ( $id)

stream (line 1901)

output the pdf code, streaming it to the browser

the relevant headers are set so that hopefully the browser will recognise it

void stream ([ $options = ''])

$options

transaction (line 3031)

a few functions which should allow the document to be treated transactionally.

void transaction ( $action)

$action

Documentation generated on Mon, 05 May 2008 16:17:18 +0400 by phpDocumentor 1.4.0