Class: Cpdf
Source Location: /phpDocumentor/Converters/PDF/default/class.pdf.php
Class Cpdf
Class Overview
|
Cpdf
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.
Located in /phpDocumentor/Converters/PDF/default/class.pdf.php [line 23]
Author(s):
Information Tags:
|
Properties
|
Methods
|
Direct descendents
| Cezpdf |
This class will take the basic interaction facilities of the Cpdf class and make more useful functions so that the user does not have to know all the ins and outs of pdf presentation to produce something pretty.
|
Property Summary
| mixed |
$addLooseObjects |
array contains infomation about how the loose objects are to be added to the document |
| mixed |
$arc4 |
the ancryption array for the document encryption is stored here |
| mixed |
$arc4_objnum |
the object Id of the encryption information |
| mixed |
$callback |
array which forms a stack to keep track of nested callback functions |
| mixed |
$catalogId |
the objectId (number within the objects array) of the document catalog |
| mixed |
$checkpoint |
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 |
$currentColour |
current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active |
| mixed |
$destinations |
store label->id pairs for named destinations, these will be used to replace internal links |
| mixed |
$encrypted |
a flag to say if a document is to be encrypted or not |
| mixed |
$encryptionKey |
the ancryption key for the encryption of all the document content (structure is not encrypted) |
| mixed |
$fileIdentifier |
the file identifier, used to uniquely identify a pdf document |
| mixed |
$firstPageId |
the objectId of the first page of the document |
| mixed |
$fontFamilies |
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. |
| mixed |
$fonts |
array carrying information about the fonts that the system currently knows about |
| mixed |
$infoObject |
the objectId of the information object for the document this contains authorship, title etc. |
| mixed |
$looseObjects |
an array which contains information about the objects which are not firmly attached to pages |
| mixed |
$messages |
messages are stored here during processing, these can be selected afterwards to give some useful debug information |
| mixed |
$nCallback |
the number of callback functions in the callback array |
| mixed |
$nStack |
number of elements within the object Id storage stack |
| mixed |
$nStateStack |
number of elements within the state stack |
| mixed |
$numFonts |
number of fonts within the system |
| mixed |
$numImages |
number of images being tracked within the document |
| mixed |
$numObj |
the current number of pdf objects in the document |
| mixed |
$numPages |
number of page objects within the document |
| mixed |
$objects |
this array contains all of the pdf objects, ready for final assembly |
| mixed |
$options |
an array containing options about the document |
| mixed |
$stack |
object Id storage stack |
| mixed |
$stateStack |
an array which is used to save the state of the document, mainly the colours and styles |
| mixed |
$wordSpaceAdjust |
used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed. |
Method Summary
| Cpdf |
Cpdf() |
class constructor |
| void |
addDestination() |
create a labelled destination within the document |
| void |
addImage() |
add an image into the document, from a GD object |
| void |
addInfo() |
add content to the documents info object |
| void |
addInternalLink() |
add a link in the document to an internal destination (ie. within the document) |
| void |
addLink() |
add a link in the document to an external URL |
| void |
addMessage() |
used to add messages for use in debugging |
| void |
addObject() |
after an object has been created, it wil only show if it has been added, using this function. |
| void |
addText() |
add text to the document, at a specified location, size and angle on the page |
| void |
addTextWrap() |
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. |
| void |
ARC4() |
ARC4 encrypt a text string |
| void |
ARC4_init() |
initialize the ARC4 encryption |
| void |
checkAllHere() |
should be used for internal checks, not implemented as yet |
| void |
curve() |
draw a bezier curve based on 4 control points |
| void |
ellipse() |
draw an ellipse note that the part and filled ellipse are just special cases of this function |
| void |
encryptInit() |
initialize the encryption for processing a particular object |
| void |
filledRectangle() |
a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not |
| void |
getFirstPageId() |
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 |
getFontDecender() |
return the font decender, this will normally return a negative number |
| void |
getFontHeight() |
return the height in units of the current font in the given size |
| void |
getTextWidth() |
calculate how wide a given text string will be on a page, at a given size. |
| void |
line() |
draw a line from one set of coordinates to another |
| void |
md5_16() |
calculate the 16 byte version of the 128 bit md5 digest of the string |
| void |
newPage() |
add a new page to the document |
| void |
openHere() |
specify where the document should open when it first starts |
| void |
openObject() |
make a loose object, the output will go into this object, until it is closed, then will revert to the current one. |
| void |
output() |
return the pdf stream as a string returned from the function |
| void |
o_action() |
an action object, used to link to URLS initially |
| void |
o_annotation() |
an annotation object, this will add an annotation to the current page. |
| void |
o_catalog() |
define the document catalog, the overall controller for the document |
| void |
o_contents() |
the contents objects hold all of the content which appears on pages |
| void |
o_destination() |
destination object, used to specify the location for the user to jump to, presently on opening |
| void |
o_font() |
an object to hold the font description |
| void |
o_fontDescriptor() |
a font descriptor, needed for including additional fonts |
| void |
o_image() |
an image object, will be an XObject in the document, includes description and data |
| void |
o_info() |
define the document information |
| void |
o_outlines() |
define the outlines in the doc, empty for now |
| void |
o_page() |
a page object, it also creates a contents object to hold its contents |
| void |
o_pages() |
object which is a parent to the pages in the document |
| void |
o_procset() |
the document procset, solves some problems with printing to old PS printers |
| void |
polygon() |
draw a polygon, the syntax for this is similar to the GD polygon command |
| void |
rectangle() |
draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not |
| void |
saveState() |
this will be called at a new page to return the state to what it was on the |
| void |
selectFont() |
if the font is not loaded then load it and make the required object |
| void |
setColor() |
sets the colour for fill operations |
| void |
setEncryption() |
set the encryption of the document can be used to turn it on and/or set the passwords which it will have. |
| void |
setFontFamily() |
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 |
setPreferences() |
set the viewer preferences of the document, it is up to the browser to obey these. |
| void |
stopObject() |
stop an object from appearing on pages from this point on |
| void |
stream() |
output the pdf code, streaming it to the browser |
| void |
transaction() |
a few functions which should allow the document to be treated transactionally. |
Properties
array contains infomation about how the loose objects are to be added to the document
the ancryption array for the document encryption is stored here
the object Id of the encryption information
array which forms a stack to keep track of nested callback functions
the objectId (number within the objects array) of the document catalog
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.
current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
object number of the currently active contents block
a record of the current font
the number of the current font within the font array
current style that lines are drawn in
object number of the current page
current colour for stroke operations (lines etc.)
track if the current font is bolded or italicised
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
a flag to say if a document is to be encrypted or not
the ancryption key for the encryption of all the document content (structure is not encrypted)
the file identifier, used to uniquely identify a pdf document
the objectId of the first page of the document
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.
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
the objectId of the information object for the document this contains authorship, title etc.
an array which contains information about the objects which are not firmly attached to pages
these have been added with the addObject function
messages are stored here during processing, these can be selected afterwards to give some useful debug information
the number of callback functions in the callback array
number of elements within the object Id storage stack
number of elements within the state stack
number of fonts within the system
number of images being tracked within the document
the current number of pdf objects in the document
number of page objects within the document
this array contains all of the pdf objects, ready for final assembly
an array containing options about the document
it defaults to turning on the compression of the objects
the object Id of the procset object
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
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
Cpdf Cpdf(
[
$pageSize = array(0,0,612,792)]
)
|
|
class constructor
this will start a new document
Parameters:
void addDestination(
$label,
$style, [
$a = 0], [
$b = 0], [
$c = 0]
)
|
|
create a labelled destination within the document
Parameters:
|
|
$label: |
|
|
|
$style: |
|
|
|
$a: |
|
|
|
$b: |
|
|
|
$c: |
|
void addImage(
&$img,
$x,
$y, [
$w = 0], [
$h = 0], [
$quality = 75]
)
|
|
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]
)
|
|
add content to the documents info object
Parameters:
void addInternalLink(
$label,
$x0,
$y0,
$x1,
$y1
)
|
|
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]
)
|
|
add a JPEG image into the document, from a file
Parameters:
void addLink(
$url,
$x0,
$y0,
$x1,
$y1
)
|
|
add a link in the document to an external URL
Parameters:
|
|
$url: |
|
|
|
$x0: |
|
|
|
$y0: |
|
|
|
$x1: |
|
|
|
$y1: |
|
void addMessage(
$message
)
|
|
used to add messages for use in debugging
Parameters:
Redefined in descendants as:
void addObject(
$id, [
$options = 'add']
)
|
|
after an object has been created, it wil only show if it has been added, using this function.
Parameters:
void addPngFromFile(
$file,
$x,
$y, [
$w = 0], [
$h = 0]
)
|
|
add a PNG image into the document, from a file
this should work with remote files
Parameters:
void addText(
$x,
$y,
$size,
$text, [
$angle = 0], [
$wordSpaceAdjust = 0]
)
|
|
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]
)
|
|
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: |
|
ARC4 encrypt a text string
Parameters:
void ARC4_init(
[
$key = '']
)
|
|
initialize the ARC4 encryption
Parameters:
should be used for internal checks, not implemented as yet
void curve(
$x0,
$y0,
$x1,
$y1,
$x2,
$y2,
$x3,
$y3
)
|
|
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]
)
|
|
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: |
|
initialize the encryption for processing a particular object
Parameters:
void filledEllipse(
$x0,
$y0,
$r1, [
$r2 = 0], [
$angle = 0], [
$nSeg = 8], [
$astart = 0], [
$afinish = 360]
)
|
|
draw a filled ellipse
Parameters:
|
|
$x0: |
|
|
|
$y0: |
|
|
|
$r1: |
|
|
|
$r2: |
|
|
|
$angle: |
|
|
|
$nSeg: |
|
|
|
$astart: |
|
|
|
$afinish: |
|
void filledRectangle(
$x1,
$y1,
$width,
$height
)
|
|
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: |
|
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 getFontDecender(
$size
)
|
|
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:
void getFontHeight(
$size
)
|
|
return the height in units of the current font in the given size
Parameters:
void getTextWidth(
$size,
$text
)
|
|
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:
void line(
$x1,
$y1,
$x2,
$y2
)
|
|
draw a line from one set of coordinates to another
Parameters:
calculate the 16 byte version of the 128 bit md5 digest of the string
Parameters:
void newPage(
[
$insert = 0], [
$id = 0], [
$pos = 'after']
)
|
|
add a new page to the document
this also makes the new page the current active object
Parameters:
void openHere(
$style, [
$a = 0], [
$b = 0], [
$c = 0]
)
|
|
specify where the document should open when it first starts
Parameters:
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 output(
[
$debug = 0]
)
|
|
return the pdf stream as a string returned from the function
Parameters:
void o_action(
$id,
$action, [
$options = '']
)
|
|
an action object, used to link to URLS initially
Parameters:
void o_annotation(
$id,
$action, [
$options = '']
)
|
|
an annotation object, this will add an annotation to the current page.
initially will support just link annotations
Parameters:
void o_catalog(
$id,
$action, [
$options = '']
)
|
|
define the document catalog, the overall controller for the document
Parameters:
void o_contents(
$id,
$action, [
$options = '']
)
|
|
the contents objects hold all of the content which appears on pages
Parameters:
void o_destination(
$id,
$action, [
$options = '']
)
|
|
destination object, used to specify the location for the user to jump to, presently on opening
Parameters:
void o_encryption(
$id,
$action, [
$options = '']
)
|
|
encryption object.
Parameters:
void o_font(
$id,
$action, [
$options = '']
)
|
|
an object to hold the font description
Parameters:
void o_fontDescriptor(
$id,
$action, [
$options = '']
)
|
|
a font descriptor, needed for including additional fonts
Parameters:
void o_fontEncoding(
$id,
$action, [
$options = '']
)
|
|
the font encoding
Parameters:
void o_image(
$id,
$action, [
$options = '']
)
|
|
an image object, will be an XObject in the document, includes description and data
Parameters:
void o_info(
$id,
$action, [
$options = '']
)
|
|
define the document information
Parameters:
void o_outlines(
$id,
$action, [
$options = '']
)
|
|
define the outlines in the doc, empty for now
Parameters:
void o_page(
$id,
$action, [
$options = '']
)
|
|
a page object, it also creates a contents object to hold its contents
Parameters:
void o_pages(
$id,
$action, [
$options = '']
)
|
|
object which is a parent to the pages in the document
Parameters:
void o_procset(
$id,
$action, [
$options = '']
)
|
|
the document procset, solves some problems with printing to old PS printers
Parameters:
void o_viewerPreferences(
$id,
$action, [
$options = '']
)
|
|
set the viewer preferences
Parameters:
void partEllipse(
$x0,
$y0,
$astart,
$afinish,
$r1, [
$r2 = 0], [
$angle = 0], [
$nSeg = 8]
)
|
|
draw a part of an ellipse
Parameters:
|
|
$x0: |
|
|
|
$y0: |
|
|
|
$astart: |
|
|
|
$afinish: |
|
|
|
$r1: |
|
|
|
$r2: |
|
|
|
$angle: |
|
|
|
$nSeg: |
|
void polygon(
$p,
$np, [
$f = 0]
)
|
|
draw a polygon, the syntax for this is similar to the GD polygon command
Parameters:
void rectangle(
$x1,
$y1,
$width,
$height
)
|
|
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: |
|
open an existing object for editing
Parameters:
void restoreState(
[
$pageEnd = 0]
)
|
|
restore a previously saved state
Parameters:
void saveState(
[
$pageEnd = 0]
)
|
|
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:
void selectFont(
$fontName, [
$encoding = ''], [
$set = 1]
)
|
|
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]
)
|
|
sets the colour for fill operations
Parameters:
void setEncryption(
[
$userPass = ''], [
$ownerPass = ''], [
$pc = array()]
)
|
|
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 = '']
)
|
|
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:
void setLineStyle(
[
$width = 1], [
$cap = ''], [
$join = ''], [
$dash = ''], [
$phase = 0]
)
|
|
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]
)
|
|
set the viewer preferences of the document, it is up to the browser to obey these.
Parameters:
void setStrokeColor(
$r,
$g,
$b, [
$force = 0]
)
|
|
sets the colour for stroke operations
Parameters:
stop an object from appearing on pages from this point on
Parameters:
void stream(
[
$options = '']
)
|
|
output the pdf code, streaming it to the browser
the relevant headers are set so that hopefully the browser will recognise it
Parameters:
void transaction(
$action
)
|
|
a few functions which should allow the document to be treated transactionally.
Parameters:
|
|
