[Cpdf] element index

Package indexes

All elements
a c d e f g i l m n o p r s t u w y
a
top
$addLooseObjects
Cpdf::$addLooseObjects in class.pdf.php
array contains infomation about how the loose objects are to be added to the document
$arc4
Cpdf::$arc4 in class.pdf.php
the ancryption array for the document encryption is stored here
$arc4_objnum
Cpdf::$arc4_objnum in class.pdf.php
the object Id of the encryption information
addDestination
Cpdf::addDestination() in class.pdf.php
create a labelled destination within the document
addImage
Cpdf::addImage() in class.pdf.php
add an image into the document, from a GD object
addInfo
Cpdf::addInfo() in class.pdf.php
add content to the documents info object
addInternalLink
Cpdf::addInternalLink() in class.pdf.php
add a link in the document to an internal destination (ie. within the document)
addJpegFromFile
Cpdf::addJpegFromFile() in class.pdf.php
add a JPEG image into the document, from a file
addLink
Cpdf::addLink() in class.pdf.php
add a link in the document to an external URL
addMessage
Cpdf::addMessage() in class.pdf.php
used to add messages for use in debugging
addObject
Cpdf::addObject() in class.pdf.php
after an object has been created, it wil only show if it has been added, using this function.
addPngFromFile
Cpdf::addPngFromFile() in class.pdf.php
add a PNG image into the document, from a file
addText
Cpdf::addText() in class.pdf.php
add text to the document, at a specified location, size and angle on the page
addTextWrap
Cpdf::addTextWrap() in class.pdf.php
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.
alink
Cezpdf::alink() in class.ezpdf.php
ARC4
Cpdf::ARC4() in class.pdf.php
ARC4 encrypt a text string
ARC4_init
Cpdf::ARC4_init() in class.pdf.php
initialize the ARC4 encryption
c
top
$callback
Cpdf::$callback in class.pdf.php
array which forms a stack to keep track of nested callback functions
$catalogId
Cpdf::$catalogId in class.pdf.php
the objectId (number within the objects array) of the document catalog
$checkpoint
Cpdf::$checkpoint in class.pdf.php
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
Cpdf::$currentBaseFont in class.pdf.php
the current base font
$currentColour
Cpdf::$currentColour in class.pdf.php
current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
$currentContents
Cpdf::$currentContents in class.pdf.php
object number of the currently active contents block
$currentFont
Cpdf::$currentFont in class.pdf.php
a record of the current font
$currentFontNum
Cpdf::$currentFontNum in class.pdf.php
the number of the current font within the font array
$currentLineStyle
Cpdf::$currentLineStyle in class.pdf.php
current style that lines are drawn in
$currentNode
Cpdf::$currentNode in class.pdf.php
$currentPage
Cpdf::$currentPage in class.pdf.php
object number of the current page
$currentStrokeColour
current colour for stroke operations (lines etc.)
$currentTextState
Cpdf::$currentTextState in class.pdf.php
track if the current font is bolded or italicised
Cezpdf
Cezpdf in class.ezpdf.php
Cpdf
Cezpdf
Cezpdf::Cezpdf() in class.ezpdf.php
checkAllHere
Cpdf::checkAllHere() in class.pdf.php
should be used for internal checks, not implemented as yet
closeObject
Cpdf::closeObject() in class.pdf.php
close an object
Cpdf
Cpdf in class.pdf.php
Cpdf
Cpdf
Cpdf::Cpdf() in class.pdf.php
class constructor
curve
Cpdf::curve() in class.pdf.php
draw a bezier curve based on 4 control points
class.pdf.php
class.pdf.php in class.pdf.php
d
top
$destinations
Cpdf::$destinations in class.pdf.php
store label->id pairs for named destinations, these will be used to replace internal links
e
top
$encrypted
Cpdf::$encrypted in class.pdf.php
a flag to say if a document is to be encrypted or not
$encryptionKey
Cpdf::$encryptionKey in class.pdf.php
the ancryption key for the encryption of all the document content (structure is not encrypted)
$ez
Cezpdf::$ez in class.ezpdf.php
$ezPageCount
Cezpdf::$ezPageCount in class.ezpdf.php
$ezPages
Cezpdf::$ezPages in class.ezpdf.php
ellipse
Cpdf::ellipse() in class.pdf.php
draw an ellipse note that the part and filled ellipse are just special cases of this function
encryptInit
Cpdf::encryptInit() in class.pdf.php
initialize the encryption for processing a particular object
execTemplate
Cezpdf::execTemplate() in class.ezpdf.php
ezColumnsStart
Cezpdf::ezColumnsStart() in class.ezpdf.php
ezColumnsStop
Cezpdf::ezColumnsStop() in class.ezpdf.php
ezGetCurrentPageNumber
ezImage
Cezpdf::ezImage() in class.ezpdf.php
ezInsertMode
Cezpdf::ezInsertMode() in class.ezpdf.php
ezNewPage
Cezpdf::ezNewPage() in class.ezpdf.php
ezOutput
Cezpdf::ezOutput() in class.ezpdf.php
ezProcessText
Cezpdf::ezProcessText() in class.ezpdf.php
ezPRVTaddPageNumbers
ezPRVTcleanUp
Cezpdf::ezPRVTcleanUp() in class.ezpdf.php
ezPrvtGetTextWidth
Cezpdf::ezPrvtGetTextWidth() in class.ezpdf.php
ezPRVTpageNumberSearch
ezPrvtTableColumnHeadings
ezPrvtTableDrawLines
ezSetCmMargins
Cezpdf::ezSetCmMargins() in class.ezpdf.php
ezSetDy
Cezpdf::ezSetDy() in class.ezpdf.php
ezSetMargins
Cezpdf::ezSetMargins() in class.ezpdf.php
ezSetY
Cezpdf::ezSetY() in class.ezpdf.php
ezStartPageNumbers
Cezpdf::ezStartPageNumbers() in class.ezpdf.php
ezStopPageNumbers
Cezpdf::ezStopPageNumbers() in class.ezpdf.php
ezStream
Cezpdf::ezStream() in class.ezpdf.php
ezTable
Cezpdf::ezTable() in class.ezpdf.php
ezText
Cezpdf::ezText() in class.ezpdf.php
ezWhatPageNumber
Cezpdf::ezWhatPageNumber() in class.ezpdf.php
f
top
$fileIdentifier
Cpdf::$fileIdentifier in class.pdf.php
the file identifier, used to uniquely identify a pdf document
$firstPageId
Cpdf::$firstPageId in class.pdf.php
the objectId of the first page of the document
$fontFamilies
Cpdf::$fontFamilies in class.pdf.php
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
Cpdf::$fonts in class.pdf.php
array carrying information about the fonts that the system currently knows about
filledEllipse
Cpdf::filledEllipse() in class.pdf.php
draw a filled ellipse
filledRectangle
Cpdf::filledRectangle() in class.pdf.php
a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
g
top
getFirstPageId
Cpdf::getFirstPageId() in class.pdf.php
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
Cpdf::getFontDecender() in class.pdf.php
return the font decender, this will normally return a negative number
getFontHeight
Cpdf::getFontHeight() in class.pdf.php
return the height in units of the current font in the given size
getTextWidth
Cpdf::getTextWidth() in class.pdf.php
calculate how wide a given text string will be on a page, at a given size.
i
top
$infoObject
Cpdf::$infoObject in class.pdf.php
the objectId of the information object for the document this contains authorship, title etc.
ilink
Cezpdf::ilink() in class.ezpdf.php
l
top
$looseObjects
Cpdf::$looseObjects in class.pdf.php
an array which contains information about the objects which are not firmly attached to pages
line
Cpdf::line() in class.pdf.php
draw a line from one set of coordinates to another
loadTemplate
Cezpdf::loadTemplate() in class.ezpdf.php
m
top
$messages
Cpdf::$messages in class.pdf.php
messages are stored here during processing, these can be selected afterwards to give some useful debug information
md5_16
Cpdf::md5_16() in class.pdf.php
calculate the 16 byte version of the 128 bit md5 digest of the string
n
top
$nCallback
Cpdf::$nCallback in class.pdf.php
the number of callback functions in the callback array
$nStack
Cpdf::$nStack in class.pdf.php
number of elements within the object Id storage stack
$nStateStack
Cpdf::$nStateStack in class.pdf.php
number of elements within the state stack
$numFonts
Cpdf::$numFonts in class.pdf.php
number of fonts within the system
$numImages
Cpdf::$numImages in class.pdf.php
number of images being tracked within the document
$numObj
Cpdf::$numObj in class.pdf.php
the current number of pdf objects in the document
$numPages
Cpdf::$numPages in class.pdf.php
number of page objects within the document
newPage
Cpdf::newPage() in class.pdf.php
add a new page to the document
o
top
$objects
Cpdf::$objects in class.pdf.php
this array contains all of the pdf objects, ready for final assembly
$options
Cpdf::$options in class.pdf.php
an array containing options about the document
openHere
Cpdf::openHere() in class.pdf.php
specify where the document should open when it first starts
openObject
Cpdf::openObject() in class.pdf.php
make a loose object, the output will go into this object, until it is closed, then will revert to the current one.
output
Cpdf::output() in class.pdf.php
return the pdf stream as a string returned from the function
o_action
Cpdf::o_action() in class.pdf.php
an action object, used to link to URLS initially
o_annotation
Cpdf::o_annotation() in class.pdf.php
an annotation object, this will add an annotation to the current page.
o_catalog
Cpdf::o_catalog() in class.pdf.php
define the document catalog, the overall controller for the document
o_contents
Cpdf::o_contents() in class.pdf.php
the contents objects hold all of the content which appears on pages
o_destination
Cpdf::o_destination() in class.pdf.php
destination object, used to specify the location for the user to jump to, presently on opening
o_encryption
Cpdf::o_encryption() in class.pdf.php
encryption object.
o_font
Cpdf::o_font() in class.pdf.php
an object to hold the font description
o_fontDescriptor
Cpdf::o_fontDescriptor() in class.pdf.php
a font descriptor, needed for including additional fonts
o_fontEncoding
Cpdf::o_fontEncoding() in class.pdf.php
the font encoding
o_image
Cpdf::o_image() in class.pdf.php
an image object, will be an XObject in the document, includes description and data
o_info
Cpdf::o_info() in class.pdf.php
define the document information
o_outlines
Cpdf::o_outlines() in class.pdf.php
define the outlines in the doc, empty for now
o_page
Cpdf::o_page() in class.pdf.php
a page object, it also creates a contents object to hold its contents
o_pages
Cpdf::o_pages() in class.pdf.php
object which is a parent to the pages in the document
o_procset
Cpdf::o_procset() in class.pdf.php
the document procset, solves some problems with printing to old PS printers
o_viewerPreferences
set the viewer preferences
p
top
$procsetObjectId
Cpdf::$procsetObjectId in class.pdf.php
the object Id of the procset object
partEllipse
Cpdf::partEllipse() in class.pdf.php
draw a part of an ellipse
polygon
Cpdf::polygon() in class.pdf.php
draw a polygon, the syntax for this is similar to the GD polygon command
r
top
rectangle
Cpdf::rectangle() in class.pdf.php
draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
reopenObject
Cpdf::reopenObject() in class.pdf.php
open an existing object for editing
restoreState
Cpdf::restoreState() in class.pdf.php
restore a previously saved state
s
top
$stack
Cpdf::$stack in class.pdf.php
object Id storage stack
$stateStack
Cpdf::$stateStack in class.pdf.php
an array which is used to save the state of the document, mainly the colours and styles
saveState
Cpdf::saveState() in class.pdf.php
this will be called at a new page to return the state to what it was on the
selectFont
Cpdf::selectFont() in class.pdf.php
if the font is not loaded then load it and make the required object
setColor
Cpdf::setColor() in class.pdf.php
sets the colour for fill operations
setEncryption
Cpdf::setEncryption() in class.pdf.php
set the encryption of the document can be used to turn it on and/or set the passwords which it will have.
setFontFamily
Cpdf::setFontFamily() in class.pdf.php
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.
setLineStyle
Cpdf::setLineStyle() in class.pdf.php
this sets the line drawing style.
setPreferences
Cpdf::setPreferences() in class.pdf.php
set the viewer preferences of the document, it is up to the browser to obey these.
setStrokeColor
Cpdf::setStrokeColor() in class.pdf.php
sets the colour for stroke operations
stopObject
Cpdf::stopObject() in class.pdf.php
stop an object from appearing on pages from this point on
stream
Cpdf::stream() in class.pdf.php
output the pdf code, streaming it to the browser
t
top
transaction
Cpdf::transaction() in class.pdf.php
a few functions which should allow the document to be treated transactionally.
u
top
uline
Cezpdf::uline() in class.ezpdf.php
w
top
$wordSpaceAdjust
Cpdf::$wordSpaceAdjust in class.pdf.php
used to track the last used value of the inter-word spacing, this is so that it is known when the spacing is changed.
y
top
$y
Cezpdf::$y in class.ezpdf.php
a c d e f g i l m n o p r s t u w y