eZPublish  4.5
Cpdf Class Reference

Cpdf provides. More...

+ Inheritance diagram for Cpdf:

Public Member Functions

 addContent ($content)
 add content to the currently active object More...
 
 addDestination ($label, $style, $a=0, $b=0, $c=0)
 create a labelled destination within the document More...
 
 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 More...
 
 addInfo ($label, $value=0)
 add content to the documents info object More...
 
 addInternalLink ($label, $x0, $y0, $x1, $y1)
 add a link in the document to an internal destination (ie. More...
 
 addJpegFromFile ($img, $x, $y, $w=0, $h=0)
 add a JPEG image into the document, from a file More...
 
 addJpegImage_common (&$data, $x, $y, $w=0, $h=0, $imageWidth, $imageHeight, $channels=3)
 common code used by the two JPEG adding functions More...
 
 addLink ($url, $x0, $y0, $x1, $y1)
 functions which can be called to adjust or add to the document More...
 
 addMessage ($message)
 used to add messages for use in debugging More...
 
 addObject ($id, $options= 'add')
 after an object has been created, it wil only show if it has been added, using this function. More...
 
 addPngFromFile ($file, $x, $y, $w=0, $h=0)
 add a PNG image into the document, from a file this should work with remote files More...
 
 addText ($x, $y, $size, $text, $angle=0, $wordSpaceAdjust=0)
 add text to the document, at a specified location, size and angle on the page More...
 
 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. More...
 
 ARC4 ($text)
 ARC4 encrypt a text string. More...
 
 ARC4_init ($key='')
 initialize the ARC4 encryption More...
 
 checkAllHere ()
 should be used for internal checks, not implemented as yet More...
 
 closeObject ()
 close an object More...
 
 Cpdf ($pageSize=array(0, 0, 612, 792))
 
 currentFont ()
 Get current font. More...
 
 curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3)
 draw a bezier curve based on 4 control points More...
 
 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 More...
 
 encryptInit ($id)
 initialize the encryption for processing a particular object More...
 
 filledEllipse ($x0, $y0, $r1, $r2=0, $angle=0, $nSeg=8, $astart=0, $afinish=360)
 draw a filled ellipse More...
 
 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 More...
 
 filterText ($text)
 filter the text, this is applied to all text just before being inserted into the pdf document it escapes the various things that need to be escaped, and so on More...
 
 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. More...
 
 getFontDecender ($size=false)
 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 More...
 
 getFontHeight ($size=false)
 return the height in units of the current font in the given size More...
 
 getTextWidth ($size, $text)
 calculate how wide a given text string will be on a page, at a given size. More...
 
 line ($x1, $y1, $x2, $y2)
 draw a line from one set of coordinates to another More...
 
 md5_16 ($string)
 ARC4 functions A series of function to implement ARC4 encoding in PHP. More...
 
 newDocument ($pageSize=array(0, 0, 612, 792))
 intialize a new document if this is called on an existing document results may be unpredictable, but the existing document would be lost at minimum this function is called automatically by the constructor function More...
 
 newPage ($insert=0, $id=0, $pos= 'after')
 add a new page to the document this also makes the new page the current active object More...
 
 o_action ($id, $action, $options= '')
 an action object, used to link to URLS initially More...
 
 o_annotation ($id, $action, $options= '')
 an annotation object, this will add an annotation to the current page. More...
 
 o_catalog ($id, $action, $options= '')
 define the document catalog, the overall controller for the document More...
 
 o_contents ($id, $action, $options='')
 the contents objects hold all of the content which appears on pages More...
 
 o_destination ($id, $action, $options= '')
 Document object methods (internal use only) More...
 
 o_encryption ($id, $action, $options='')
 encryption object. More...
 
 o_font ($id, $action, $options= '')
 an object to hold the font description More...
 
 o_fontDescriptor ($id, $action, $options= '')
 a font descriptor, needed for including additional fonts More...
 
 o_fontEncoding ($id, $action, $options= '')
 the font encoding More...
 
 o_function ($id, $action, $options= '')
 Add object to hold Function properties Only partial support for type 0, 3 and 4. More...
 
 o_image ($id, $action, $options='')
 an image object, will be an XObject in the document, includes description and data More...
 
 o_info ($id, $action, $options= '')
 define the document information More...
 
 o_outlines ($id, $action, $options= '')
 define the outlines in the doc, empty for now More...
 
 o_page ($id, $action, $options='')
 a page object, it also creates a contents object to hold its contents More...
 
 o_pages ($id, $action, $options= '')
 object which is a parent to the pages in the document More...
 
 o_pattern ($id, $action, $options= '')
 Add object to hold pattern properties. More...
 
 o_procset ($id, $action, $options= '')
 the document procset, solves some problems with printing to old PS printers More...
 
 o_shading ($id, $action, $options= '')
 Add object to hold shading properties. More...
 
 o_viewerPreferences ($id, $action, $options= '')
 set the viewer preferences More...
 
 openFont ($font)
 open the font file and return a php structure containing it. More...
 
 openHere ($style, $a=0, $b=0, $c=0)
 specify where the document should open when it first starts More...
 
 openObject ()
 make a loose object, the output will go into this object, until it is closed, then will revert to the current one. More...
 
 output ($debug=0)
 return the pdf stream as a string returned from the function More...
 
 partEllipse ($x0, $y0, $astart, $afinish, $r1, $r2=0, $angle=0, $nSeg=8)
 draw a part of an ellipse More...
 
 polygon ($p, $np, $f=0)
 draw a polygon, the syntax for this is similar to the GD polygon command More...
 
 popTextState ()
 
 PRVT_getBytes (&$data, $pos, $num)
 extract an integer from a position in a byte stream More...
 
 PRVTadjustWrapText ($text, $actual, $width, &$x, &$adjust, $justification)
 do a part of the calculation for sorting out the justification of the text More...
 
 PRVTcheckTextDirective (&$text, $i, &$f, $final=0)
 wrapper function for PRVTcheckTextDirective1 More...
 
 PRVTcheckTextDirective1 (&$text, $i, &$f, $final, &$x, &$y, $size=0, $angle=0, $wordSpaceAdjust=0)
 checks if the text stream contains a control directive if so then makes some changes and returns the number of characters involved in the directive this has been re-worked to include everything neccesary to fins the current writing point, so that the location can be sent to the callback function if required if the directive does not require a font change, then $f should be set to 0 More...
 
 PRVTgetTextPosition ($x, $y, $angle, $size, $wa, $text)
 given a start position and information about how text is to be laid out, calculate where on the page the text will end More...
 
 pushTextState ($newState)
 
 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 More...
 
 reopenObject ($id)
 open an existing object for editing More...
 
 restoreState ($pageEnd=0)
 restore a previously saved state More...
 
 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 More...
 
 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. More...
 
 setColor ($cmykArray, $force=0)
 
 setColorRGB ($r, $g, $b, $force=0)
 sets the colour for fill operations More...
 
 setCurrentFont ()
 sets up the current font, based on the font families, and the current text state note that this system is quite flexible, a font can be completely different to a font, and even will have to be defined within the family to have meaning This function is to be called whenever the currentTextState is changed, it will update the currentFont setting to whatever the appropriatte family one is. More...
 
 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. More...
 
 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. More...
 
 setLineStyle ($width=1, $cap= '', $join= '', $dash= '', $phase=0)
 this sets the line drawing style. More...
 
 setPreferences ($label, $value=0)
 set the viewer preferences of the document, it is up to the browser to obey these. More...
 
 setStrokeColor ($cmykArray, $force=0)
 
 setStrokeColorRGB ($r, $g, $b, $force=0)
 sets the colour for stroke operations More...
 
 shadedRectangle ($x1, $y1, $width, $height, $options)
 Create shaded rectangle area. More...
 
 stopObject ($id)
 stop an object from appearing on pages from this point on More...
 
 stream ($options= '')
 output the pdf code, streaming it to the browser the relevant headers are set so that hopefully the browser will recognise it More...
 
 transaction ($action)
 a few functions which should allow the document to be treated transactionally. More...
 

Static Public Member Functions

 compareCMYK ($cmykArray1, $cmykArray2)
 

Public Attributes

 $addLooseObjects = array()
 array contains infomation about how the loose objects are to be added to the document More...
 
 $arc4 = ''
 the ancryption array for the document encryption is stored here More...
 
 $arc4_objnum = 0
 the object Id of the encryption information More...
 
 $callback = array()
 array which forms a stack to keep track of nested callback functions More...
 
 $catalogId
 the objectId (number within the objects array) of the document catalog More...
 
 $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. More...
 
 $currentBaseFont = ''
 the current base font More...
 
 $currentColour
 current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active More...
 
 $currentContents
 object number of the currently active contents block More...
 
 $currentFont = ''
 a record of the current font More...
 
 $currentFontNum = 0
 the number of the current font within the font array More...
 
 $currentLineStyle = ''
 current style that lines are drawn in More...
 
 $currentNode
 
 $currentPage
 object number of the current page More...
 
 $currentStrokeColour
 current colour for stroke operations (lines etc.) More...
 
 $currentTextState = ''
 track if the current font is bolded or italicised More...
 
 $destinations = array()
 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 More...
 
 $encrypted = 0
 a flag to say if a document is to be encrypted or not More...
 
 $encryptionKey = ''
 the ancryption key for the encryption of all the document content (structure is not encrypted) More...
 
 $fileIdentifier = ''
 the file identifier, used to uniquely identify a pdf document More...
 
 $firstPageId
 the objectId of the first page of the document More...
 
 $fontFamilies = array()
 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. More...
 
 $fonts = array()
 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 More...
 
 $infoObject = 0
 the objectId of the information object for the document this contains authorship, title etc. More...
 
 $looseObjects = array()
 an array which contains information about the objects which are not firmly attached to pages these have been added with the addObject function More...
 
 $messages = ''
 messages are stored here during processing, these can be selected afterwards to give some useful debug information More...
 
 $nCallback = 0
 the number of callback functions in the callback array More...
 
 $nStack = 0
 number of elements within the object Id storage stack More...
 
 $nStateStack = 0
 number of elements within the state stack More...
 
 $numFonts = 0
 number of fonts within the system More...
 
 $numImages = 0
 number of images being tracked within the document More...
 
 $numObj = 0
 the current number of pdf objects in the document More...
 
 $numPages = 0
 number of page objects within the document More...
 
 $objects = array()
 this array contains all of the pdf objects, ready for final assembly More...
 
 $options = array( 'compression' => 1 )
 an array containing options about the document it defaults to turning on the compression of the objects More...
 
 $procsetObjectId
 the object Id of the procset object More...
 
 $stack = array()
 object Id storage stack More...
 
 $stateStack = array()
 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 More...
 
 $textStateStack = array( '' )
 
 $wordSpaceAdjust = 0
 used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed. More...
 

Detailed Description

Cpdf provides.

Member Function Documentation

Cpdf::addContent (   $content)

add content to the currently active object

private

Cpdf::addDestination (   $label,
  $style,
  $a = 0,
  $b = 0,
  $c = 0 
)

create a labelled destination within the document

Referenced by eZPDFTable\callAnchor(), eZPDFTable\callInsertTOC(), and eZPDFTable\callKeyword().

Cpdf::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

Cpdf::addInfo (   $label,
  $value = 0 
)

add content to the documents info object

Cpdf::addInternalLink (   $label,
  $x0,
  $y0,
  $x1,
  $y1 
)

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

within the document)

Referenced by Cezpdf\alink().

Cpdf::addJpegFromFile (   $img,
  $x,
  $y,
  $w = 0,
  $h = 0 
)

add a JPEG image into the document, from a file

Referenced by eZPDFTable\callImage(), and Cezpdf\ezImage().

Cpdf::addJpegImage_common ( $data,
  $x,
  $y,
  $w = 0,
  $h = 0,
  $imageWidth,
  $imageHeight,
  $channels = 3 
)

common code used by the two JPEG adding functions

private

Referenced by addImage(), and addJpegFromFile().

Cpdf::addLink (   $url,
  $x0,
  $y0,
  $x1,
  $y1 
)

functions which can be called to adjust or add to the document

add a link in the document to an external URL

Referenced by Cezpdf\alink().

Cpdf::addMessage (   $message)

used to add messages for use in debugging

Referenced by addPngFromFile(), Cezpdf\ezWhatPageNumber(), o_font(), openFont(), and selectFont().

Cpdf::addObject (   $id,
  $options = 'add' 
)

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

Referenced by eZPDFTable\ezTable().

Cpdf::addPngFromFile (   $file,
  $x,
  $y,
  $w = 0,
  $h = 0 
)

add a PNG image into the document, from a file this should work with remote files

Returns
true if adding image succeded

Referenced by eZPDFTable\callImage(), and Cezpdf\ezImage().

Cpdf::addText (   $x,
  $y,
  $size,
  $text,
  $angle = 0,
  $wordSpaceAdjust = 0 
)

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

Returns
array( 'height' => <used height if more than normal text, -1 if not> )

Referenced by addTextWrap(), eZPDFTable\dots(), Cezpdf\ezPRVTaddPageNumbers(), Cezpdf\ezText(), and eZPDFTable\insertTextFrame().

Cpdf::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

return array ('text' => <text for="" new="" line>="">, 'width' => <width of added text, 0 i more text>, 'height' => <height of added text, -1 if none/default> )

Referenced by eZPDFTable\ezInsertFrame(), eZPDFTable\ezTable(), and Cezpdf\ezText().

Cpdf::ARC4 (   $text)

ARC4 encrypt a text string.

Referenced by o_action(), o_contents(), o_encryption(), o_image(), and o_info().

Cpdf::ARC4_init (   $key = '')

initialize the ARC4 encryption

Referenced by encryptInit(), o_encryption(), and output().

Cpdf::checkAllHere ( )

should be used for internal checks, not implemented as yet

Referenced by output().

Cpdf::compareCMYK (   $cmykArray1,
  $cmykArray2 
)
static
Parameters
newcmyk array 1
newcmyk array 2
Returns
true if equal, false if not

Referenced by setColor(), and setStrokeColor().

Cpdf::Cpdf (   $pageSize = array( 0, 0, 612, 792 ))

Referenced by Cezpdf\Cezpdf().

Cpdf::currentFont ( )

Get current font.

Returns
current font name

Referenced by eZPDFTable\ezInsertFrame(), eZPDFTable\insertTextFrame(), and setCurrentFont().

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

draw a bezier curve based on 4 control points

Referenced by eZPDFTable\callRectangle().

Cpdf::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.

Referenced by filledEllipse(), and partEllipse().

Cpdf::encryptInit (   $id)

initialize the encryption for processing a particular object

Referenced by o_action(), o_contents(), o_image(), and o_info().

Cpdf::filledEllipse (   $x0,
  $y0,
  $r1,
  $r2 = 0,
  $angle = 0,
  $nSeg = 8,
  $astart = 0,
  $afinish = 360 
)

draw a filled ellipse

Referenced by eZPDFTable\callCircle(), and eZPDFTable\insertTextFrame().

Cpdf::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

Referenced by eZPDFTable\ezTable(), and eZPDFTable\insertTextFrame().

Cpdf::filterText (   $text)

filter the text, this is applied to all text just before being inserted into the pdf document it escapes the various things that need to be escaped, and so on

private

Referenced by o_action(), and o_info().

Cpdf::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.

Referenced by Cezpdf\Cezpdf().

Cpdf::getFontDecender (   $size = false)

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

Referenced by eZPDFTable\ezTable(), eZPDFTable\insertTextFrame(), and PRVTcheckTextDirective1().

Cpdf::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

Referenced by eZPDFTable\dots(), Cezpdf\eZGetMaxWordWidth(), Cezpdf\ezPRVTaddPageNumbers(), Cezpdf\ezPrvtGetTextWidth(), eZPDFTable\insertTextFrame(), and PRVTgetTextPosition().

Cpdf::md5_16 (   $string)

ARC4 functions A series of function to implement ARC4 encoding in PHP.

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

Referenced by encryptInit(), and o_encryption().

Cpdf::newDocument (   $pageSize = array(0,0,612,792))

intialize a new document if this is called on an existing document results may be unpredictable, but the existing document would be lost at minimum this function is called automatically by the constructor function

private

Referenced by Cpdf().

Cpdf::newPage (   $insert = 0,
  $id = 0,
  $pos = 'after' 
)

add a new page to the document this also makes the new page the current active object

Referenced by Cezpdf\ezNewPage().

Cpdf::o_action (   $id,
  $action,
  $options = '' 
)

an action object, used to link to URLS initially

Referenced by o_annotation().

Cpdf::o_annotation (   $id,
  $action,
  $options = '' 
)

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

initially will support just link annotations

Referenced by addInternalLink(), and addLink().

Cpdf::o_catalog (   $id,
  $action,
  $options = '' 
)

define the document catalog, the overall controller for the document

Referenced by newDocument(), o_outlines(), o_pages(), openHere(), and setPreferences().

Cpdf::o_contents (   $id,
  $action,
  $options = '' 
)

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

Referenced by o_image(), o_page(), openObject(), and selectFont().

Cpdf::o_destination (   $id,
  $action,
  $options = '' 
)

Document object methods (internal use only)

There is about one object method for each type of object in the pdf document Each function has the same call list ($id,$action,$options). $id = the object ID of the object, or what it is to be if it is being created $action = a string specifying the action to be performed, though ALL must support: 'new' - create the object with the id $id 'out' - produce the output for the pdf object $options = optional, a string or array containing the various parameters for the object

These, in conjunction with the output function are the ONLY way for output to be produced within the pdf 'file'. destination object, used to specify the location for the user to jump to, presently on opening

Referenced by addDestination(), and openHere().

Cpdf::o_encryption (   $id,
  $action,
  $options = '' 
)

encryption object.

Referenced by setEncryption().

Cpdf::o_font (   $id,
  $action,
  $options = '' 
)

an object to hold the font description

Referenced by selectFont().

Cpdf::o_fontDescriptor (   $id,
  $action,
  $options = '' 
)

a font descriptor, needed for including additional fonts

Referenced by selectFont().

Cpdf::o_fontEncoding (   $id,
  $action,
  $options = '' 
)

the font encoding

Referenced by o_font().

Cpdf::o_function (   $id,
  $action,
  $options = '' 
)

Add object to hold Function properties Only partial support for type 0, 3 and 4.

Parameters
objectid.
action
options

Referenced by o_shading().

Cpdf::o_image (   $id,
  $action,
  $options = '' 
)

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

Referenced by addJpegImage_common(), and addPngFromFile().

Cpdf::o_info (   $id,
  $action,
  $options = '' 
)

define the document information

Referenced by addInfo(), and newDocument().

Cpdf::o_outlines (   $id,
  $action,
  $options = '' 
)

define the outlines in the doc, empty for now

Referenced by newDocument().

Cpdf::o_page (   $id,
  $action,
  $options = '' 
)

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

Referenced by addObject(), newDocument(), newPage(), and o_annotation().

Cpdf::o_pages (   $id,
  $action,
  $options = '' 
)

object which is a parent to the pages in the document

Referenced by newDocument(), o_font(), o_image(), o_page(), o_procset(), and o_shading().

Cpdf::o_pattern (   $id,
  $action,
  $options = '' 
)

Add object to hold pattern properties.

Parameters
objectid.
action
options
Returns
action 'new' - dictionary name 'out' - pdf output
Cpdf::o_procset (   $id,
  $action,
  $options = '' 
)

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

Referenced by newDocument(), and o_image().

Cpdf::o_shading (   $id,
  $action,
  $options = '' 
)

Add object to hold shading properties.

Parameters
objectid.
action
options
Returns
action 'new' - dictionary name 'out' - pdf output

Referenced by shadedRectangle().

Cpdf::o_viewerPreferences (   $id,
  $action,
  $options = '' 
)

set the viewer preferences

Referenced by o_catalog().

Cpdf::openFont (   $font)

open the font file and return a php structure containing it.

first check if this one has been done before and saved in a form more suited to php note that if a php serialized version does not exist it will try and make one, but will require write access to the directory to do it... it is MUCH faster to have these serialized files.

private

Referenced by selectFont().

Cpdf::openHere (   $style,
  $a = 0,
  $b = 0,
  $c = 0 
)

specify where the document should open when it first starts

Cpdf::openObject ( )

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

Referenced by eZPDFTable\ezTable().

Cpdf::output (   $debug = 0)

return the pdf stream as a string returned from the function

Referenced by Cezpdf\ezOutput(), and stream().

Cpdf::partEllipse (   $x0,
  $y0,
  $astart,
  $afinish,
  $r1,
  $r2 = 0,
  $angle = 0,
  $nSeg = 8 
)

draw a part of an ellipse

Cpdf::polygon (   $p,
  $np,
  $f = 0 
)

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

Cpdf::popTextState ( )

Pop text stack, and set to previous state.

Referenced by getTextWidth().

Cpdf::PRVT_getBytes ( $data,
  $pos,
  $num 
)

extract an integer from a position in a byte stream

private

Referenced by addPngFromFile().

Cpdf::PRVTadjustWrapText (   $text,
  $actual,
  $width,
$x,
$adjust,
  $justification 
)

do a part of the calculation for sorting out the justification of the text

private

Referenced by addTextWrap().

Cpdf::PRVTcheckTextDirective ( $text,
  $i,
$f,
  $final = 0 
)

wrapper function for PRVTcheckTextDirective1

private

Referenced by addText(), addTextWrap(), Cezpdf\ezText(), and getTextWidth().

Cpdf::PRVTcheckTextDirective1 ( $text,
  $i,
$f,
  $final,
$x,
$y,
  $size = 0,
  $angle = 0,
  $wordSpaceAdjust = 0 
)

checks if the text stream contains a control directive if so then makes some changes and returns the number of characters involved in the directive this has been re-worked to include everything neccesary to fins the current writing point, so that the location can be sent to the callback function if required if the directive does not require a font change, then $f should be set to 0

private

Referenced by addText(), and PRVTcheckTextDirective().

Cpdf::PRVTgetTextPosition (   $x,
  $y,
  $angle,
  $size,
  $wa,
  $text 
)

given a start position and information about how text is to be laid out, calculate where on the page the text will end

private

Referenced by addText(), and PRVTcheckTextDirective1().

Cpdf::pushTextState (   $newState)

Push current text state, and set specified to current

Parameters
newtext state

Referenced by getTextWidth().

Cpdf::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

Referenced by eZPDFTable\callRectangle(), and Cezpdf\ezImage().

Cpdf::restoreState (   $pageEnd = 0)
Cpdf::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

Referenced by Cezpdf\alink(), eZPDFTable\dots(), eZPDFTable\ezTable(), eZPDFTable\insertFrontpage(), newPage(), shadedRectangle(), Cezpdf\strike(), and Cezpdf\uline().

Cpdf::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.

Referenced by addText(), addTextWrap(), eZPDFTable\ezInsertFrame(), getFontDecender(), getFontHeight(), getTextWidth(), eZPDFTable\insertTextFrame(), eZPDFTable\outputDocSpecification(), and setCurrentFont().

Cpdf::setColor (   $cmykArray,
  $force = 0 
)
Cpdf::setColorRGB (   $r,
  $g,
  $b,
  $force = 0 
)

sets the colour for fill operations

Referenced by Cezpdf\alink().

Cpdf::setCurrentFont ( )

sets up the current font, based on the font families, and the current text state note that this system is quite flexible, a font can be completely different to a font, and even will have to be defined within the family to have meaning This function is to be called whenever the currentTextState is changed, it will update the currentFont setting to whatever the appropriatte family one is.

If the user calls selectFont themselves then that will reset the currentBaseFont, and the currentFont This function will change the currentFont to whatever it should be, but will not change the currentBaseFont.

private

Referenced by addText(), addTextWrap(), getTextWidth(), popTextState(), pushTextState(), and selectFont().

Cpdf::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

Cpdf::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.

Referenced by Cpdf(), and selectFont().

Cpdf::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.

Referenced by Cezpdf\alink(), eZPDFTable\callDrawLine(), eZPDFTable\callFrameLine(), eZPDFTable\callRectangle(), eZPDFTable\dots(), Cezpdf\ezImage(), Cezpdf\ezPrvtTableDrawLines(), eZPDFTable\ezPrvtTableDrawLines(), eZPDFTable\ezTable(), Cezpdf\strike(), and Cezpdf\uline().

Cpdf::setPreferences (   $label,
  $value = 0 
)

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

Cpdf::setStrokeColor (   $cmykArray,
  $force = 0 
)

sets the colour for stroke operations

Parameters
cmykarray
forcecolor change

Referenced by eZPDFTable\callCircle(), eZPDFTable\callFont(), eZPDFTable\callRectangle(), newPage(), saveState(), and setStrokeColorRGB().

Cpdf::setStrokeColorRGB (   $r,
  $g,
  $b,
  $force = 0 
)
Cpdf::shadedRectangle (   $x1,
  $y1,
  $width,
  $height,
  $options 
)

Create shaded rectangle area.

Parameters
x1
x2
width
height
optionsarray ( 'orientation' => <vertical|horizontal ( optianal )>, 'color0' => <CMYK color="" array>="">, 'color1' => <CMYK color="" array>=""> )

Referenced by Cezpdf\ezShadedRectangle().

Cpdf::stopObject (   $id)

stop an object from appearing on pages from this point on

Cpdf::stream (   $options = '')

output the pdf code, streaming it to the browser the relevant headers are set so that hopefully the browser will recognise it

Referenced by Cezpdf\ezStream().

Cpdf::transaction (   $action)

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

Referenced by eZPDFTable\callImage(), Cezpdf\ezPrvtTableColumnHeadings(), and eZPDFTable\ezTable().

Member Data Documentation

Cpdf::$addLooseObjects = array()

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

Cpdf::$arc4 = ''

the ancryption array for the document encryption is stored here

Referenced by ARC4().

Cpdf::$arc4_objnum = 0

the object Id of the encryption information

Cpdf::$callback = array()

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

Cpdf::$catalogId

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

Referenced by openHere().

Cpdf::$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.

Referenced by transaction().

Cpdf::$currentBaseFont = ''

the current base font

Referenced by currentFont(), and setCurrentFont().

Cpdf::$currentColour

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

Referenced by eZPDFTable\callCircle(), and eZPDFTable\insertTextFrame().

Cpdf::$currentFont = ''

a record of the current font

Referenced by addTextWrap(), getFontDecender(), getFontHeight(), getTextWidth(), and setCurrentFont().

Cpdf::$currentFontNum = 0

the number of the current font within the font array

Referenced by selectFont().

Cpdf::$currentLineStyle = ''

current style that lines are drawn in

Cpdf::$currentNode
Cpdf::$currentPage

object number of the current page

Referenced by eZPDFTable\insertFrontpage(), and o_annotation().

Cpdf::$currentStrokeColour

current colour for stroke operations (lines etc.)

Referenced by eZPDFTable\callCircle(), and eZPDFTable\callRectangle().

Cpdf::$currentTextState = ''

track if the current font is bolded or italicised

Referenced by addTextWrap(), PRVTcheckTextDirective1(), pushTextState(), and setCurrentFont().

Cpdf::$destinations = array()

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

Cpdf::$encrypted = 0

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

Cpdf::$encryptionKey = ''

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

Referenced by encryptInit().

Cpdf::$fileIdentifier = ''

the file identifier, used to uniquely identify a pdf document

Cpdf::$firstPageId

the objectId of the first page of the document

Referenced by getFirstPageId().

Cpdf::$fontFamilies = array()

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.

Cpdf::$fonts = array()

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

Cpdf::$infoObject = 0

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

Cpdf::$looseObjects = array()

an array which contains information about the objects which are not firmly attached to pages these have been added with the addObject function

Cpdf::$messages = ''

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

Cpdf::$nCallback = 0

the number of callback functions in the callback array

Referenced by PRVTcheckTextDirective1().

Cpdf::$nStack = 0

number of elements within the object Id storage stack

Referenced by closeObject(), openObject(), and reopenObject().

Cpdf::$nStateStack = 0

number of elements within the state stack

Referenced by newPage(), restoreState(), and saveState().

Cpdf::$numFonts = 0

number of fonts within the system

Referenced by o_font(), and selectFont().

Cpdf::$numImages = 0

number of images being tracked within the document

Referenced by addJpegImage_common(), and addPngFromFile().

Cpdf::$numObj = 0

the current number of pdf objects in the document

Referenced by addDestination(), o_annotation(), o_catalog(), o_font(), o_image(), o_page(), o_shading(), openObject(), and selectFont().

Cpdf::$numPages = 0

number of page objects within the document

Cpdf::$objects = array()

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

Cpdf::$procsetObjectId

the object Id of the procset object

Cpdf::$stack = array()

object Id storage stack

Cpdf::$stateStack = array()

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

Cpdf::$textStateStack = array( '' )
Cpdf::$wordSpaceAdjust = 0

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

Referenced by addText(), and PRVTcheckTextDirective1().


The documentation for this class was generated from the following file: