Class: Cpdf
Source Location: /PhpDocumentor-1.3.2/phpDocumentor/Converters/PDF/default/class.pdf.php
Child classes:
|
Inherited Variables
|
Inherited Methods
|
Class Details
Class Variables
$addLooseObjects = array()
[line 111]
array contains infomation about how the loose objects are to be added to the document
$arc4 = ''
[line 156]
the ancryption array for the document encryption is stored here
$arc4_objnum = 0
[line 160]
the object Id of the encryption information
$callback = array()
[line 176]
array which forms a stack to keep track of nested callback functions
$catalogId =
[line 36]
the objectId (number within the objects array) of the document catalog
$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.
$currentBaseFont = ''
[line 49]
the current base font
$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
$currentContents =
[line 65]
object number of the currently active contents block
$currentFont = ''
[line 45]
a record of the current font
$currentFontNum = 0
[line 53]
the number of the current font within the font array
$currentLineStyle = ''
[line 81]
current style that lines are drawn in
$currentNode =
[line 57]
$currentPage =
[line 61]
object number of the current page
$currentStrokeColour = array('r'=>-1,'g'=>-1,'b'=>-1)
[line 77]
current colour for stroke operations (lines etc.)
$currentTextState = ''
[line 148]
track if the current font is bolded or italicised
$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
$encrypted = 0
[line 168]
a flag to say if a document is to be encrypted or not
$encryptionKey = ''
[line 172]
the ancryption key for the encryption of all the document content (structure is not encrypted)
$fileIdentifier = ''
[line 164]
the file identifier, used to uniquely identify a pdf document
$firstPageId =
[line 129]
the objectId of the first page of the document
$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.
$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
$infoObject = 0
[line 116]
the objectId of the information object for the document this contains authorship, title etc.
$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
$messages = ''
[line 152]
messages are stored here during processing, these can be selected afterwards to give some useful debug information
$nCallback = 0
[line 180]
the number of callback functions in the callback array
$nStack = 0
[line 102]
number of elements within the object Id storage stack
$nStateStack = 0
[line 90]
number of elements within the state stack
$numFonts = 0
[line 69]
number of fonts within the system
$numImages = 0
[line 120]
number of images being tracked within the document
$numObj = 0
[line 28]
the current number of pdf objects in the document
$numPages = 0
[line 94]
number of page objects within the document
$objects = array()
[line 32]
this array contains all of the pdf objects, ready for final assembly
$options = array('compression'=>1)
[line 125]
an array containing options about the document it defaults to turning on the compression of the objects
$procsetObjectId =
[line 138]
the object Id of the procset object
$stack = array()
[line 98]
object Id storage stack
$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
$wordSpaceAdjust = 0
[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.
Method Detail
Cpdf (Constructor) [line 197]
Cpdf Cpdf(
[
$pageSize = array(0,0,612,792)])
|
|
class constructor this will start a new document
Parameters:
addDestination [line 2969]
void addDestination(
$label,
$style, [
$a = 0], [
$b = 0], [
$c = 0])
|
|
create a labelled destination within the document
Parameters:
addImage [line 2870]
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:
addInfo [line 2590]
void addInfo(
$label, [
$value = 0])
|
|
add content to the documents info object
Parameters:
addInternalLink [line 1173]
void addInternalLink(
$label,
$x0,
$y0,
$x1,
$y1)
|
|
add a link in the document to an internal destination (ie. within the document)
Parameters:
addJpegFromFile [line 2825]
void addJpegFromFile(
$img,
$x,
$y, [
$w = 0], [
$h = 0])
|
|
add a JPEG image into the document, from a file
Parameters:
addLink [line 1164]
void addLink(
$url,
$x0,
$y0,
$x1,
$y1)
|
|
add a link in the document to an external URL
Parameters:
addMessage [line 3022]
void addMessage(
$message)
|
|
used to add messages for use in debugging
Overridden in child classes as:
- phpdocpdf::addMessage()
Parameters:
addObject [line 2544]
void addObject(
$id, [
$options = 'add'])
|
|
after an object has been created, it wil only show if it has been added, using this function.
Parameters:
addPngFromFile [line 2637]
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:
addText [line 2156]
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:
addTextWrap [line 2331]
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:
ARC4 [line 1138]
ARC4 encrypt a text string
Parameters:
ARC4_init [line 1112]
void ARC4_init(
[
$key = ''])
|
|
initialize the ARC4 encryption
Parameters:
checkAllHere [line 1214]
should be used for internal checks, not implemented as yet
closeObject [line 2518]
curve [line 1682]
void curve(
$x0,
$y0,
$x1,
$y1,
$x2,
$y2,
$x3,
$y3)
|
|
draw a bezier curve based on 4 control points
Parameters:
ellipse [line 1713]
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:
encryptInit [line 1098]
initialize the encryption for processing a particular object
Parameters:
filledEllipse [line 1699]
void filledEllipse(
$x0,
$y0,
$r1, [
$r2 = 0], [
$angle = 0], [
$nSeg = 8], [
$astart = 0], [
$afinish = 360])
|
|
draw a filled ellipse
Parameters:
filledRectangle [line 1835]
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:
getFirstPageId [line 1639]
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.
getFontDecender [line 1943]
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:
getFontHeight [line 1929]
void getFontHeight(
$size)
|
|
return the height in units of the current font in the given size
Parameters:
getTextWidth [line 2248]
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:
line [line 1675]
void line(
$x1,
$y1,
$x2,
$y2)
|
|
draw a line from one set of coordinates to another
Parameters:
md5_16 [line 1086]
calculate the 16 byte version of the 128 bit md5 digest of the string
Parameters:
newPage [line 1851]
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:
openHere [line 2949]
void openHere(
$style, [
$a = 0], [
$b = 0], [
$c = 0])
|
|
specify where the document should open when it first starts
Parameters:
openObject [line 2490]
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
output [line 1220]
void output(
[
$debug = 0])
|
|
return the pdf stream as a string returned from the function
Parameters:
o_action [line 726]
void o_action(
$id,
$action, [
$options = ''])
|
|
an action object, used to link to URLS initially
Parameters:
o_annotation [line 769]
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:
o_catalog [line 297]
void o_catalog(
$id,
$action, [
$options = ''])
|
|
define the document catalog, the overall controller for the document
Parameters:
o_contents [line 890]
void o_contents(
$id,
$action, [
$options = ''])
|
|
the contents objects hold all of the content which appears on pages
Parameters:
o_destination [line 224]
void o_destination(
$id,
$action, [
$options = ''])
|
|
destination object, used to specify the location for the user to jump to, presently on opening
Parameters:
o_encryption [line 1015]
void o_encryption(
$id,
$action, [
$options = ''])
|
|
encryption object.
Parameters:
o_font [line 475]
void o_font(
$id,
$action, [
$options = ''])
|
|
an object to hold the font description
Parameters:
o_fontDescriptor [line 559]
void o_fontDescriptor(
$id,
$action, [
$options = ''])
|
|
a font descriptor, needed for including additional fonts
Parameters:
o_fontEncoding [line 610]
void o_fontEncoding(
$id,
$action, [
$options = ''])
|
|
the font encoding
Parameters:
o_image [line 940]
void o_image(
$id,
$action, [
$options = ''])
|
|
an image object, will be an XObject in the document, includes description and data
Parameters:
o_info [line 682]
void o_info(
$id,
$action, [
$options = ''])
|
|
define the document information
Parameters:
o_outlines [line 445]
void o_outlines(
$id,
$action, [
$options = ''])
|
|
define the outlines in the doc, empty for now
Parameters:
o_page [line 821]
void o_page(
$id,
$action, [
$options = ''])
|
|
a page object, it also creates a contents object to hold its contents
Parameters:
o_pages [line 347]
void o_pages(
$id,
$action, [
$options = ''])
|
|
object which is a parent to the pages in the document
Parameters:
o_procset [line 647]
void o_procset(
$id,
$action, [
$options = ''])
|
|
the document procset, solves some problems with printing to old PS printers
Parameters:
o_viewerPreferences [line 259]
void o_viewerPreferences(
$id,
$action, [
$options = ''])
|
|
set the viewer preferences
Parameters:
partEllipse [line 1692]
void partEllipse(
$x0,
$y0,
$astart,
$afinish,
$r1, [
$r2 = 0], [
$angle = 0], [
$nSeg = 8])
|
|
draw a part of an ellipse
Parameters:
polygon [line 1818]
void polygon(
$p,
$np, [
$f = 0])
|
|
draw a polygon, the syntax for this is similar to the GD polygon command
Parameters:
rectangle [line 1843]
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:
reopenObject [line 2505]
open an existing object for editing
Parameters:
restoreState [line 2471]
void restoreState(
[
$pageEnd = 0])
|
|
restore a previously saved state
Parameters:
saveState [line 2447]
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:
selectFont [line 1417]
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:
setColor [line 1655]
void setColor(
$r,
$g,
$b, [
$force = 0])
|
|
sets the colour for fill operations
Parameters:
setEncryption [line 1184]
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:
setFontFamily [line 2985]
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:
setLineStyle [line 1789]
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:
setPreferences [line 2607]
void setPreferences(
$label, [
$value = 0])
|
|
set the viewer preferences of the document, it is up to the browser to obey these.
Parameters:
setStrokeColor [line 1665]
void setStrokeColor(
$r,
$g,
$b, [
$force = 0])
|
|
sets the colour for stroke operations
Parameters:
stopObject [line 2533]
stop an object from appearing on pages from this point on
Parameters:
stream [line 1899]
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:
transaction [line 3029]
void transaction(
$action)
|
|
a few functions which should allow the document to be treated transactionally.
Parameters:
Documentation generated on Mon, 11 Mar 2019 14:58:33 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.
|
|
