Inheritance diagram for Cpdf:

Public Member Functions
	addContent ($content)
	add content to the currently active object
	addDestination ($label, $style, $a=0, $b=0, $c=0)
	create a labelled destination within the document
	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
	addInfo ($label, $value=0)
	add content to the documents info object
	addInternalLink ($label, $x0, $y0, $x1, $y1)
	add a link in the document to an internal destination (ie.
	addJpegFromFile ($img, $x, $y, $w=0, $h=0)
	add a JPEG image into the document, from a file
	addJpegImage_common (&$data, $x, $y, $w=0, $h=0, $imageWidth, $imageHeight, $channels=3)
	common code used by the two JPEG adding functions
	addLink ($url, $x0, $y0, $x1, $y1)
	functions which can be called to adjust or add to the document
	addMessage ($message)
	used to add messages for use in debugging
	addObject ($id, $options= 'add')
	after an object has been created, it wil only show if it has been added, using this function.
	addPngFromFile ($file, $x, $y, $w=0, $h=0)
	add a PNG image into the document, from a file this should work with remote files
	addText ($x, $y, $size, $text, $angle=0, $wordSpaceAdjust=0)
	add text to the document, at a specified location, size and angle on the page
	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.
	ARC4 ($text)
	ARC4 encrypt a text string.
	ARC4_init ($key='')
	initialize the ARC4 encryption
	checkAllHere ()
	should be used for internal checks, not implemented as yet
	closeObject ()
	close an object
	Cpdf ($pageSize=array(0, 0, 612, 792))
	currentFont ()
	Get current font.
	curve ($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3)
	draw a bezier curve based on 4 control points
	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
	encryptInit ($id)
	initialize the encryption for processing a particular object
	filledEllipse ($x0, $y0, $r1, $r2=0, $angle=0, $nSeg=8, $astart=0, $afinish=360)
	draw a filled ellipse
	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
	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
	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.
	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
	getFontHeight ($size=false)
	return the height in units of the current font in the given size
	getTextWidth ($size, $text)
	calculate how wide a given text string will be on a page, at a given size.
	line ($x1, $y1, $x2, $y2)
	draw a line from one set of coordinates to another
	md5_16 ($string)
	ARC4 functions A series of function to implement ARC4 encoding in PHP.
	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
	newPage ($insert=0, $id=0, $pos= 'after')
	add a new page to the document this also makes the new page the current active object
	o_action ($id, $action, $options= '')
	an action object, used to link to URLS initially
	o_annotation ($id, $action, $options= '')
	an annotation object, this will add an annotation to the current page.
	o_catalog ($id, $action, $options= '')
	define the document catalog, the overall controller for the document
	o_contents ($id, $action, $options='')
	the contents objects hold all of the content which appears on pages
	o_destination ($id, $action, $options= '')
	Document object methods (internal use only)
	o_encryption ($id, $action, $options='')
	encryption object.
	o_font ($id, $action, $options= '')
	an object to hold the font description
	o_fontDescriptor ($id, $action, $options= '')
	a font descriptor, needed for including additional fonts
	o_fontEncoding ($id, $action, $options= '')
	the font encoding
	o_function ($id, $action, $options= '')
	Add object to hold Function properties Only partial support for type 0, 3 and 4.
	o_image ($id, $action, $options='')
	an image object, will be an XObject in the document, includes description and data
	o_info ($id, $action, $options= '')
	define the document information
	o_outlines ($id, $action, $options= '')
	define the outlines in the doc, empty for now
	o_page ($id, $action, $options='')
	a page object, it also creates a contents object to hold its contents
	o_pages ($id, $action, $options= '')
	object which is a parent to the pages in the document
	o_pattern ($id, $action, $options= '')
	Add object to hold pattern properties.
	o_procset ($id, $action, $options= '')
	the document procset, solves some problems with printing to old PS printers
	o_shading ($id, $action, $options= '')
	Add object to hold shading properties.
	o_viewerPreferences ($id, $action, $options= '')
	set the viewer preferences
	openFont ($font)
	open the font file and return a php structure containing it.
	openHere ($style, $a=0, $b=0, $c=0)
	specify where the document should open when it first starts
	openObject ()
	make a loose object, the output will go into this object, until it is closed, then will revert to the current one.
	output ($debug=0)
	return the pdf stream as a string returned from the function
	partEllipse ($x0, $y0, $astart, $afinish, $r1, $r2=0, $angle=0, $nSeg=8)
	draw a part of an ellipse
	polygon ($p, $np, $f=0)
	draw a polygon, the syntax for this is similar to the GD polygon command
	popTextState ()
	PRVT_getBytes (&$data, $pos, $num)
	extract an integer from a position in a byte stream
	PRVTadjustWrapText ($text, $actual, $width, &$x, &$adjust, $justification)
	do a part of the calculation for sorting out the justification of the text
	PRVTcheckTextDirective (&$text, $i, &$f, $final=0)
	wrapper function for PRVTcheckTextDirective1
	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
	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
	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
	reopenObject ($id)
	open an existing object for editing
	restoreState ($pageEnd=0)
	restore a previously saved state
	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
	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.
	setColor ($cmykArray, $force=0)
	setColorRGB ($r, $g, $b, $force=0)
	sets the colour for fill operations
	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.
	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.
	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.
	setLineStyle ($width=1, $cap= '', $join= '', $dash= '', $phase=0)
	this sets the line drawing style.
	setPreferences ($label, $value=0)
	set the viewer preferences of the document, it is up to the browser to obey these.
	setStrokeColor ($cmykArray, $force=0)
	setStrokeColorRGB ($r, $g, $b, $force=0)
	sets the colour for stroke operations
	shadedRectangle ($x1, $y1, $width, $height, $options)
	Create shaded rectangle area.
	stopObject ($id)
	stop an object from appearing on pages from this point on
	stream ($options= '')
	output the pdf code, streaming it to the browser the relevant headers are set so that hopefully the browser will recognise it
	transaction ($action)
	a few functions which should allow the document to be treated transactionally.
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
	$arc4 = ''
	the ancryption array for the document encryption is stored here
	$arc4_objnum = 0
	the object Id of the encryption information
	$callback = array()
	array which forms a stack to keep track of nested callback functions
	$catalogId
	the objectId (number within the objects array) of the document catalog
	$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.
	$currentBaseFont = ''
	the current base font
	$currentColour
	current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
	$currentContents
	object number of the currently active contents block
	$currentFont = ''
	a record of the current font
	$currentFontNum = 0
	the number of the current font within the font array
	$currentLineStyle = ''
	current style that lines are drawn in
	$currentNode
	$currentPage
	object number of the current page
	$currentStrokeColour
	current colour for stroke operations (lines etc.)
	$currentTextState = ''
	track if the current font is bolded or italicised
	$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
	$encrypted = 0
	a flag to say if a document is to be encrypted or not
	$encryptionKey = ''
	the ancryption key for the encryption of all the document content (structure is not encrypted)
	$fileIdentifier = ''
	the file identifier, used to uniquely identify a pdf document
	$firstPageId
	the objectId of the first page of the document
	$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.
	$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
	$infoObject = 0
	the objectId of the information object for the document this contains authorship, title etc.
	$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
	$messages = ''
	messages are stored here during processing, these can be selected afterwards to give some useful debug information
	$nCallback = 0
	the number of callback functions in the callback array
	$nStack = 0
	number of elements within the object Id storage stack
	$nStateStack = 0
	number of elements within the state stack
	$numFonts = 0
	number of fonts within the system
	$numImages = 0
	number of images being tracked within the document
	$numObj = 0
	the current number of pdf objects in the document
	$numPages = 0
	number of page objects within the document
	$objects = array()
	this array contains all of the pdf objects, ready for final assembly
	$options = array( 'compression' => 1 )
	an array containing options about the document it defaults to turning on the compression of the objects
	$procsetObjectId
	the object Id of the procset object
	$stack = array()
	object Id storage stack
	$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
	$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.

Detailed Description

Cpdf provides.

Definition at line 17 of file class.pdf.php.

Member Function Documentation

Cpdf::addContent ( $ content )

add content to the currently active object

private

Definition at line 2195 of file class.pdf.php.

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

create a labelled destination within the document

Definition at line 3966 of file class.pdf.php.

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

Definition at line 3850 of file class.pdf.php.

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

add content to the documents info object

Definition at line 3502 of file class.pdf.php.

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

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

within the document)

Definition at line 1622 of file class.pdf.php.

Referenced by Cezpdf\alink().

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

add a JPEG image into the document, from a file

Definition at line 3796 of file class.pdf.php.

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

Definition at line 3920 of file class.pdf.php.

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

Definition at line 1613 of file class.pdf.php.

Referenced by Cezpdf\alink().

Cpdf::addMessage ( $ message )

used to add messages for use in debugging

Definition at line 4028 of file class.pdf.php.

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.

Definition at line 3450 of file class.pdf.php.

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

Definition at line 3563 of file class.pdf.php.

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> )

Definition at line 2907 of file class.pdf.php.

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> )

Definition at line 3151 of file class.pdf.php.

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

Cpdf::ARC4 ( $ text )

ARC4 encrypt a text string.

Definition at line 1587 of file class.pdf.php.

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

Cpdf::ARC4_init ( $ key = '' )

initialize the ARC4 encryption

Definition at line 1561 of file class.pdf.php.

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

Cpdf::checkAllHere ( )

should be used for internal checks, not implemented as yet

Definition at line 1663 of file class.pdf.php.

Referenced by output().

Cpdf::closeObject ( )

close an object

Definition at line 3420 of file class.pdf.php.

Referenced by eZPDFTable\callFrameLine(), eZPDFTable\ezInsertBlockFrame(), eZPDFTable\ezInsertFrame(), eZPDFTable\ezInsertLine(), Cezpdf\ezPRVTaddPageNumbers(), eZPDFTable\ezTable(), and eZPDFTable\insertFrontpage().

Cpdf::compareCMYK	(	$	cmykArray1,
		$	cmykArray2
	)		`[static]`

Parameters:

new	cmyk array 1
new	cmyk array 2

Returns:: true if equal, false if not

Definition at line 4098 of file class.pdf.php.

Referenced by setColor(), and setStrokeColor().

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

Definition at line 231 of file class.pdf.php.

Referenced by Cezpdf\Cezpdf().

Cpdf::currentFont ( )

Get current font.

Returns:: current font name

Definition at line 2134 of file class.pdf.php.

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

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

draw a bezier curve based on 4 control points

Definition at line 2260 of file class.pdf.php.

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.

Definition at line 2294 of file class.pdf.php.

Referenced by filledEllipse(), and partEllipse().

Cpdf::encryptInit ( $ id )

initialize the encryption for processing a particular object

Definition at line 1547 of file class.pdf.php.

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

Definition at line 2279 of file class.pdf.php.

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

Definition at line 2468 of file class.pdf.php.

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

Definition at line 2632 of file class.pdf.php.

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.

Definition at line 2185 of file class.pdf.php.

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

Definition at line 2611 of file class.pdf.php.

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

Cpdf::getFontHeight ( $ size = false )

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

Definition at line 2591 of file class.pdf.php.

Referenced by addTextWrap(), eZPDFTable\callAnchor(), eZPDFTable\callCircle(), eZPDFTable\callInsertTOC(), Cezpdf\ezImage(), eZPDFTable\ezInsertFrame(), Cezpdf\ezNewPage(), eZPDFTable\ezTable(), Cezpdf\ezText(), eZPDFTable\insertTextFrame(), Cezpdf\lineHeight(), 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

Definition at line 3044 of file class.pdf.php.

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

Cpdf::line	(	$	x1,
		$	y1,
		$	x2,
		$	y2
	)

draw a line from one set of coordinates to another

Definition at line 2252 of file class.pdf.php.

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

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

Definition at line 1535 of file class.pdf.php.

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

Definition at line 1718 of file class.pdf.php.

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

Definition at line 2486 of file class.pdf.php.

Referenced by Cezpdf\ezNewPage().

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

an action object, used to link to URLS initially

Definition at line 1151 of file class.pdf.php.

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

Definition at line 1211 of file class.pdf.php.

Referenced by addInternalLink(), and addLink().

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

define the document catalog, the overall controller for the document

Definition at line 348 of file class.pdf.php.

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

Definition at line 1339 of file class.pdf.php.

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

Definition at line 266 of file class.pdf.php.

Referenced by addDestination(), and openHere().

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

encryption object.

Definition at line 1464 of file class.pdf.php.

Referenced by setEncryption().

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

an object to hold the font description

Definition at line 846 of file class.pdf.php.

Referenced by selectFont().

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

a font descriptor, needed for including additional fonts

Definition at line 952 of file class.pdf.php.

Referenced by selectFont().

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

the font encoding

Definition at line 1009 of file class.pdf.php.

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:

object	id.
action
options

Definition at line 580 of file class.pdf.php.

Referenced by o_shading().

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

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

Definition at line 1389 of file class.pdf.php.

Referenced by addJpegImage_common(), and addPngFromFile().

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

define the document information

Definition at line 1097 of file class.pdf.php.

Referenced by addInfo(), and newDocument().

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

define the outlines in the doc, empty for now

Definition at line 538 of file class.pdf.php.

Referenced by newDocument().

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

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

Definition at line 1270 of file class.pdf.php.

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

Definition at line 404 of file class.pdf.php.

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:

object	id.
action
options

Returns:: action 'new' - dictionary name 'out' - pdf output

Definition at line 662 of file class.pdf.php.

Cpdf::o_procset	(	$	id,
		$	action,
		$	options = `''`
	)

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

Definition at line 1056 of file class.pdf.php.

Referenced by newDocument(), and o_image().

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

Add object to hold shading properties.

Parameters:

object	id.
action
options

Returns:: action 'new' - dictionary name 'out' - pdf output

Definition at line 743 of file class.pdf.php.

Referenced by shadedRectangle().

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

set the viewer preferences

Definition at line 306 of file class.pdf.php.

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

Definition at line 1757 of file class.pdf.php.

Referenced by selectFont().

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

specify where the document should open when it first starts

Definition at line 3943 of file class.pdf.php.

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

Definition at line 3387 of file class.pdf.php.

Referenced by eZPDFTable\ezTable().

Cpdf::output ( $ debug = 0 )

return the pdf stream as a string returned from the function

Definition at line 1669 of file class.pdf.php.

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

Definition at line 2271 of file class.pdf.php.

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

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

Definition at line 2418 of file class.pdf.php.

Cpdf::popTextState ( )

Pop text stack, and set to previous state.

Definition at line 4121 of file class.pdf.php.

Referenced by getTextWidth().

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

extract an integer from a position in a byte stream

private

Definition at line 3545 of file class.pdf.php.

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

Definition at line 3111 of file class.pdf.php.

Referenced by addTextWrap().

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

wrapper function for PRVTcheckTextDirective1

private

Definition at line 2675 of file class.pdf.php.

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

Definition at line 2691 of file class.pdf.php.

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

Definition at line 2652 of file class.pdf.php.

Referenced by addText(), and PRVTcheckTextDirective1().

Cpdf::pushTextState ( $ newState )

Push current text state, and set specified to current

Parameters:

new	text state

Definition at line 4111 of file class.pdf.php.

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

Definition at line 2477 of file class.pdf.php.

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

Cpdf::reopenObject ( $ id )

open an existing object for editing

Definition at line 3404 of file class.pdf.php.

Referenced by eZPDFTable\callFrameLine(), eZPDFTable\ezInsertBlockFrame(), eZPDFTable\ezInsertFrame(), eZPDFTable\ezInsertLine(), Cezpdf\ezPRVTaddPageNumbers(), eZPDFTable\ezTable(), and eZPDFTable\insertFrontpage().

Cpdf::restoreState ( $ pageEnd = 0 )

restore a previously saved state

Definition at line 3366 of file class.pdf.php.

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

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

Definition at line 3340 of file class.pdf.php.

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.

Definition at line 1892 of file class.pdf.php.

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

Cpdf::setColor	(	$	cmykArray,
		$	force = `0`
	)

sets the colour for fill operations

Parameters:

CMYK array

Definition at line 2213 of file class.pdf.php.

Referenced by eZPDFTable\callCircle(), eZPDFTable\callRectangle(), eZPDFTable\ezTable(), eZPDFTable\insertTextFrame(), newPage(), eZPDFTable\outputDocSpecification(), saveState(), and setColorRGB().

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

sets the colour for fill operations

Definition at line 2203 of file class.pdf.php.

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

Definition at line 2151 of file class.pdf.php.

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

Definition at line 1633 of file class.pdf.php.

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.

Definition at line 3985 of file class.pdf.php.

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.

Definition at line 2383 of file class.pdf.php.

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.

Definition at line 3524 of file class.pdf.php.

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

sets the colour for stroke operations

Parameters:

cmyk	array
force	color change

Definition at line 2238 of file class.pdf.php.

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

Cpdf::setStrokeColorRGB	(	$	r,
		$	g,
		$	b,
		$	force = `0`
	)

sets the colour for stroke operations

Definition at line 2227 of file class.pdf.php.

Referenced by Cezpdf\alink(), Cezpdf\ezImage(), Cezpdf\ezPrvtTableDrawLines(), eZPDFTable\ezPrvtTableDrawLines(), and eZPDFTable\ezTable().

Cpdf::shadedRectangle	(	$	x1,
		$	y1,
		$	width,
		$	height,
		$	options
	)

Create shaded rectangle area.

Parameters:

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

Definition at line 2448 of file class.pdf.php.

Referenced by Cezpdf\ezShadedRectangle().

Cpdf::stopObject ( $ id )

stop an object from appearing on pages from this point on

Definition at line 3437 of file class.pdf.php.

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

Definition at line 2544 of file class.pdf.php.

Referenced by Cezpdf\ezStream().

Cpdf::transaction ( $ action )

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

Definition at line 4036 of file class.pdf.php.

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

Definition at line 126 of file class.pdf.php.

Cpdf::$arc4 = ''

the ancryption array for the document encryption is stored here

Definition at line 181 of file class.pdf.php.

Cpdf::$arc4_objnum = 0

the object Id of the encryption information

Definition at line 186 of file class.pdf.php.

Cpdf::$callback = array()

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

Definition at line 206 of file class.pdf.php.

Cpdf::$catalogId

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

Definition at line 33 of file class.pdf.php.

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.

Definition at line 224 of file class.pdf.php.

Cpdf::$currentBaseFont = ''

the current base font

Definition at line 49 of file class.pdf.php.

Cpdf::$currentColour

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

Definition at line 79 of file class.pdf.php.

Cpdf::$currentContents

object number of the currently active contents block

Definition at line 69 of file class.pdf.php.

Cpdf::$currentFont = ''

a record of the current font

Definition at line 44 of file class.pdf.php.

Cpdf::$currentFontNum = 0

the number of the current font within the font array

Definition at line 54 of file class.pdf.php.

Cpdf::$currentLineStyle = ''

current style that lines are drawn in

Definition at line 89 of file class.pdf.php.

Cpdf::$currentNode

Definition at line 59 of file class.pdf.php.

Cpdf::$currentPage

object number of the current page

Definition at line 64 of file class.pdf.php.

Cpdf::$currentStrokeColour

current colour for stroke operations (lines etc.)

Definition at line 84 of file class.pdf.php.

Cpdf::$currentTextState = ''

track if the current font is bolded or italicised

Definition at line 171 of file class.pdf.php.

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

Definition at line 217 of file class.pdf.php.

Cpdf::$encrypted = 0

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

Definition at line 196 of file class.pdf.php.

Cpdf::$encryptionKey = ''

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

Definition at line 201 of file class.pdf.php.

Cpdf::$fileIdentifier = ''

the file identifier, used to uniquely identify a pdf document

Definition at line 191 of file class.pdf.php.

Cpdf::$firstPageId

the objectId of the first page of the document

Definition at line 148 of file class.pdf.php.

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.

Definition at line 166 of file class.pdf.php.

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

Definition at line 39 of file class.pdf.php.

Cpdf::$infoObject = 0

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

Definition at line 132 of file class.pdf.php.

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

Definition at line 121 of file class.pdf.php.

Cpdf::$messages = ''

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

Definition at line 176 of file class.pdf.php.

Cpdf::$nCallback = 0

the number of callback functions in the callback array

Definition at line 211 of file class.pdf.php.

Cpdf::$nStack = 0

number of elements within the object Id storage stack

Definition at line 115 of file class.pdf.php.

Cpdf::$nStateStack = 0

number of elements within the state stack

Definition at line 100 of file class.pdf.php.

Cpdf::$numFonts = 0

number of fonts within the system

Definition at line 74 of file class.pdf.php.

Cpdf::$numImages = 0

number of images being tracked within the document

Definition at line 137 of file class.pdf.php.

Cpdf::$numObj = 0

the current number of pdf objects in the document

Definition at line 23 of file class.pdf.php.

Cpdf::$numPages = 0

number of page objects within the document

Definition at line 105 of file class.pdf.php.

Cpdf::$objects = array()

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

Definition at line 28 of file class.pdf.php.

Cpdf::$options = array( 'compression' => 1 )

an array containing options about the document it defaults to turning on the compression of the objects

Definition at line 143 of file class.pdf.php.

Referenced by addObject(), addPngFromFile(), eZPDFTable\addToPreStack(), eZPDFTable\callFont(), eZPDFTable\callHeader(), eZPDFTable\callSetMargin(), eZPDFTable\callText(), eZPDFTable\eZCalculateColumnWidth(), Cezpdf\ezColumnsStart(), Cezpdf\ezOutput(), Cezpdf\ezPrvtTableColumnHeadings(), Cezpdf\ezStream(), eZPDFTable\ezTable(), Cezpdf\ezText(), Cezpdf\lineHeight(), o_action(), o_annotation(), o_catalog(), o_contents(), o_destination(), o_encryption(), o_font(), o_fontDescriptor(), o_fontEncoding(), o_function(), o_image(), o_info(), o_outlines(), o_page(), o_pages(), o_pattern(), o_procset(), o_shading(), o_viewerPreferences(), selectFont(), setEncryption(), setFontFamily(), shadedRectangle(), and stream().

Cpdf::$procsetObjectId

the object Id of the procset object

Definition at line 159 of file class.pdf.php.

Cpdf::$stack = array()

object Id storage stack

Definition at line 110 of file class.pdf.php.

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

Definition at line 95 of file class.pdf.php.

Cpdf::$textStateStack = array( '' )

Definition at line 4127 of file class.pdf.php.

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.

Definition at line 154 of file class.pdf.php.

Referenced by addText(), and PRVTcheckTextDirective1().

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

class.pdf.php

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

Member Data Documentation