Class: Cpdf

[line 114]

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

Type: mixed

Overrides:

[line 159]

the ancryption array for the document encryption is stored here

Type: mixed

Overrides:

[line 163]

the object Id of the encryption information

Type: mixed

Overrides:

[line 179]

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

Type: mixed

Overrides:

[line 39]

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

Type: mixed

Overrides:

[line 194]

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.

Type: mixed

Overrides:

[line 52]

the current base font

Type: mixed

Overrides:

[line 76]

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

Type: mixed

Overrides:

[line 68]

object number of the currently active contents block

Type: mixed

Overrides:

[line 48]

a record of the current font

Type: mixed

Overrides:

[line 56]

the number of the current font within the font array

Type: mixed

Overrides:

[line 84]

current style that lines are drawn in

Type: mixed

Overrides:

[line 60]

Type: mixed

Overrides:

[line 64]

object number of the current page

Type: mixed

Overrides:

[line 80]

current colour for stroke operations (lines etc.)

Type: mixed

Overrides:

[line 151]

track if the current font is bolded or italicised

Type: mixed

Overrides:

[line 188]

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

Type: mixed

Overrides:

[line 171]

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

Type: mixed

Overrides:

[line 175]

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

Type: mixed

Overrides:

[line 167]

the file identifier, used to uniquely identify a pdf document

Type: mixed

Overrides:

[line 132]

the objectId of the first page of the document

Type: mixed

Overrides:

[line 147]

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.

Type: mixed

Overrides:

[line 44]

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

Type: mixed

Overrides:

[line 119]

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

Type: mixed

Overrides:

[line 110]

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

these have been added with the addObject function

Type: mixed

Overrides:

[line 155]

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

Type: mixed

Overrides:

[line 183]

the number of callback functions in the callback array

Type: mixed

Overrides:

[line 105]

number of elements within the object Id storage stack

Type: mixed

Overrides:

[line 93]

number of elements within the state stack

Type: mixed

Overrides:

[line 72]

number of fonts within the system

Type: mixed

Overrides:

[line 123]

number of images being tracked within the document

Type: mixed

Overrides:

[line 31]

the current number of pdf objects in the document

Type: mixed

Overrides:

[line 97]

number of page objects within the document

Type: mixed

Overrides:

[line 35]

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

Type: mixed

Overrides:

[line 128]

an array containing options about the document

it defaults to turning on the compression of the objects

Type: mixed

Overrides:

[line 141]

the object Id of the procset object

Type: mixed

Overrides:

[line 101]

object Id storage stack

Type: mixed

Overrides:

[line 89]

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

Type: mixed

Overrides:

[line 137]

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

Type: mixed

Overrides:

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

[line 200]

class constructor

this will start a new document

Tags:

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

Parameters:

• $pageSize -

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

[line 2972]

create a labelled destination within the document

Parameters:

• $label -
• $style -
• $a -
• $b -
• $c -

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

[line 2873]

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

Parameters:

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

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

[line 2593]

add content to the documents info object

Parameters:

• $label -
• $value -

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

[line 1176]

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

Parameters:

• $label -
• $x0 -
• $y0 -
• $x1 -
• $y1 -

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

[line 2828]

add a JPEG image into the document, from a file

Parameters:

• $img -
• $x -
• $y -
• $w -
• $h -

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

[line 1167]

add a link in the document to an external URL

Parameters:

• $url -
• $x0 -
• $y0 -
• $x1 -
• $y1 -

void addMessage( $message)

[line 3025]

used to add messages for use in debugging

Overridden in child classes as:

phpdocpdf::addMessage()

Parameters:

• $message -

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

[line 2547]

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

Parameters:

• $id -
• $options -

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

[line 2640]

add a PNG image into the document, from a file

this should work with remote files

Parameters:

• $file -
• $x -
• $y -
• $w -
• $h -

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

[line 2159]

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

Parameters:

• $x -
• $y -
• $size -
• $text -
• $angle -
• $wordSpaceAdjust -

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

[line 2334]

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

Parameters:

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

void ARC4( $text)

[line 1141]

ARC4 encrypt a text string

Parameters:

• $text -

void ARC4_init( [ $key = ''])

[line 1115]

initialize the ARC4 encryption

Parameters:

• $key -

void checkAllHere( )

[line 1217]

should be used for internal checks, not implemented as yet

Parameters:

void closeObject( )

[line 2521]

close an object

Parameters:

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

[line 1685]

draw a bezier curve based on 4 control points

Parameters:

• $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])

[line 1716]

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.

Parameters:

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

void encryptInit( $id)

[line 1101]

initialize the encryption for processing a particular object

Parameters:

• $id -

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

[line 1702]

draw a filled ellipse

Parameters:

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

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

[line 1838]

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

Parameters:

• $x1 -
• $y1 -
• $width -
• $height -

void getFirstPageId( )

[line 1642]

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.

Parameters:

void getFontDecender( $size)

[line 1946]

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

Parameters:

• $size -

void getFontHeight( $size)

[line 1932]

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

Parameters:

• $size -

void getTextWidth( $size, $text)

[line 2251]

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

Parameters:

• $size -
• $text -

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

[line 1678]

draw a line from one set of coordinates to another

Parameters:

• $x1 -
• $y1 -
• $x2 -
• $y2 -

void md5_16( $string)

[line 1089]

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

Parameters:

• $string -

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

[line 1854]

add a new page to the document

this also makes the new page the current active object

Parameters:

• $insert -
• $id -
• $pos -

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

[line 2952]

specify where the document should open when it first starts

Parameters:

• $style -
• $a -
• $b -
• $c -

void openObject( )

[line 2493]

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

Parameters:

void output( [ $debug = 0])

[line 1223]

return the pdf stream as a string returned from the function

Parameters:

• $debug -

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

[line 729]

an action object, used to link to URLS initially

Parameters:

• $id -
• $action -
• $options -

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

[line 772]

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

initially will support just link annotations

Parameters:

• $id -
• $action -
• $options -

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

[line 300]

define the document catalog, the overall controller for the document

Parameters:

• $id -
• $action -
• $options -

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

[line 893]

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

Parameters:

• $id -
• $action -
• $options -

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

[line 227]

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

Parameters:

• $id -
• $action -
• $options -

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

[line 1018]

encryption object.

Parameters:

• $id -
• $action -
• $options -

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

[line 478]

an object to hold the font description

Parameters:

• $id -
• $action -
• $options -

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

[line 562]

a font descriptor, needed for including additional fonts

Parameters:

• $id -
• $action -
• $options -

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

[line 613]

the font encoding

Parameters:

• $id -
• $action -
• $options -

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

[line 943]

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

Parameters:

• $id -
• $action -
• $options -

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

[line 685]

define the document information

Parameters:

• $id -
• $action -
• $options -

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

[line 448]

define the outlines in the doc, empty for now

Parameters:

• $id -
• $action -
• $options -

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

[line 824]

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

Parameters:

• $id -
• $action -
• $options -

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

[line 350]

object which is a parent to the pages in the document

Parameters:

• $id -
• $action -
• $options -

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

[line 650]

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

Parameters:

• $id -
• $action -
• $options -

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

[line 262]

set the viewer preferences

Parameters:

• $id -
• $action -
• $options -

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

[line 1695]

draw a part of an ellipse

Parameters:

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

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

[line 1821]

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

Parameters:

• $p -
• $np -
• $f -

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

[line 1846]

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

Parameters:

• $x1 -
• $y1 -
• $width -
• $height -

void reopenObject( $id)

[line 2508]

open an existing object for editing

Parameters:

• $id -

void restoreState( [ $pageEnd = 0])

[line 2474]

restore a previously saved state

Parameters:

• $pageEnd -

void saveState( [ $pageEnd = 0])

[line 2450]

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

Parameters:

• $pageEnd -

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

[line 1420]

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.

Parameters:

• $fontName -
• $encoding -
• $set -

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

[line 1658]

sets the colour for fill operations

Parameters:

• $r -
• $g -
• $b -
• $force -

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

[line 1187]

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

Parameters:

• $userPass -
• $ownerPass -
• $pc -

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

[line 2988]

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.

Parameters:

• $family -
• $options -

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

[line 1792]

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.

Parameters:

• $width -
• $cap -
• $join -
• $dash -
• $phase -

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

[line 2610]

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

Parameters:

• $label -
• $value -

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

[line 1668]

sets the colour for stroke operations

Parameters:

• $r -
• $g -
• $b -
• $force -

void stopObject( $id)

[line 2536]

stop an object from appearing on pages from this point on

Parameters:

• $id -

void stream( [ $options = ''])

[line 1902]

output the pdf code, streaming it to the browser

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

Parameters:

• $options -

void transaction( $action)

[line 3032]

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

Parameters:

• $action -