| Cpdf

# Class: Creport Source Location: /lib/cpdf/readme.php
### Class Overview
    Cpdf
       |
       --Cezpdf
          |
          --Creport
Cpdf #### Author(s): Wayne Munro <mailto:pdf@ros.co.nz> #### Version: 009 | ### Variables $reportContents | ### Methods Creport dots rf
### Inherited Variables #### Class: Cezpdf Cezpdf::$ez Cezpdf::$ezPageCount Cezpdf::$ezPages Cezpdf::$y #### Class: Cpdf Cpdf::$addLooseObjects Cpdf::$arc4 Cpdf::$arc4_objnum Cpdf::$callback Cpdf::$catalogId Cpdf::$checkpoint Cpdf::$currentBaseFont Cpdf::$currentColour Cpdf::$currentContents Cpdf::$currentFont Cpdf::$currentFontNum Cpdf::$currentLineStyle Cpdf::$currentNode Cpdf::$currentPage Cpdf::$currentStrokeColour Cpdf::$currentTextState Cpdf::$destinations Cpdf::$encrypted Cpdf::$encryptionKey Cpdf::$fileIdentifier Cpdf::$firstPageId Cpdf::$fontFamilies Cpdf::$fonts Cpdf::$infoObject Cpdf::$looseObjects Cpdf::$messages Cpdf::$nCallback Cpdf::$nStack Cpdf::$nStateStack Cpdf::$numFonts Cpdf::$numImages Cpdf::$numObj Cpdf::$numPages Cpdf::$objects Cpdf::$options Cpdf::$procsetObjectId Cpdf::$stack Cpdf::$stateStack Cpdf::$wordSpaceAdjust | ### Inherited Methods #### Class: Cezpdf Cezpdf::Cezpdf() Cezpdf::alink() Cezpdf::execTemplate() Cezpdf::ezColumnsStart() Cezpdf::ezColumnsStop() Cezpdf::ezGetCurrentPageNumber() Cezpdf::ezInsertMode() Cezpdf::ezList() Renders the given list to the pdf. Cezpdf::ezNewPage() Cezpdf::ezOutput() Cezpdf::ezProcessText() Cezpdf::ezPRVTaddPageNumbers() Cezpdf::ezPRVTcleanUp() Cezpdf::ezPrvtGetTextWidth() Cezpdf::ezPRVTpageNumberSearch() Cezpdf::ezPrvtTableColumnHeadings() Cezpdf::ezPrvtTableDrawLines() Cezpdf::ezSetCmMargins() Cezpdf::ezSetDy() Cezpdf::ezSetMargins() Cezpdf::ezSetY() Cezpdf::ezStartPageNumbers() Cezpdf::ezStopPageNumbers() Cezpdf::ezStream() Cezpdf::ezTable() Cezpdf::ezText() Cezpdf::ezWhatPageNumber() Cezpdf::hexToRgb() converts a hex color code to an rgb array. Cezpdf::ilink() Cezpdf::invertY() inverts the given $y value based on the pageHeight. Cezpdf::loadTemplate() Cezpdf::uline() #### Class: Cpdf Cpdf::Cpdf() class constructor Cpdf::addDestination() create a labelled destination within the document Cpdf::addImage() add an image into the document, from a GD object Cpdf::addInfo() add content to the documents info object Cpdf::addInternalLink() add a link in the document to an internal destination (ie. within the document) Cpdf::addJpegFromFile() add a JPEG image into the document, from a file Cpdf::addLink() add a link in the document to an external URL Cpdf::addMessage() used to add messages for use in debugging Cpdf::addObject() after an object has been created, it wil only show if it has been added, using this function. Cpdf::addPngFromFile() add a PNG image into the document, from a file Cpdf::addText() add text to the document, at a specified location, size and angle on the page Cpdf::addTextAlignRight() Cpdf::addTextWrap() add text to the page, but ensure that it fits within a certain width if it does not fit then put in as much as possible, splitting at word boundaries and return the remainder. Cpdf::ARC4() ARC4 encrypt a text string Cpdf::ARC4_init() initialize the ARC4 encryption Cpdf::checkAllHere() should be used for internal checks, not implemented as yet Cpdf::closeObject() close an object Cpdf::curve() draw a bezier curve based on 4 control points Cpdf::ellipse() draw an ellipse note that the part and filled ellipse are just special cases of this function Cpdf::encryptInit() initialize the encryption for processing a particular object Cpdf::filledEllipse() draw a filled ellipse Cpdf::filledRectangle() a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not 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. Cpdf::getFontDecender() return the font decender, this will normally return a negative number Cpdf::getFontHeight() return the height in units of the current font in the given size Cpdf::getTextWidth() calculate how wide a given text string will be on a page, at a given size. Cpdf::line() draw a line from one set of coordinates to another Cpdf::md5_16() calculate the 16 byte version of the 128 bit md5 digest of the string Cpdf::newPage() add a new page to the document Cpdf::openHere() 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. Cpdf::output() return the pdf stream as a string returned from the function Cpdf::o_action() an action object, used to link to URLS initially Cpdf::o_annotation() an annotation object, this will add an annotation to the current page. Cpdf::o_catalog() define the document catalog, the overall controller for the document Cpdf::o_contents() the contents objects hold all of the content which appears on pages Cpdf::o_destination() destination object, used to specify the location for the user to jump to, presently on opening Cpdf::o_encryption() encryption object. Cpdf::o_font() an object to hold the font description Cpdf::o_fontDescriptor() a font descriptor, needed for including additional fonts Cpdf::o_fontEncoding() the font encoding Cpdf::o_image() an image object, will be an XObject in the document, includes description and data Cpdf::o_info() define the document information Cpdf::o_outlines() define the outlines in the doc, empty for now Cpdf::o_page() a page object, it also creates a contents object to hold its contents Cpdf::o_pages() object which is a parent to the pages in the document Cpdf::o_procset() the document procset, solves some problems with printing to old PS printers Cpdf::o_viewerPreferences() set the viewer preferences Cpdf::partEllipse() draw a part of an ellipse Cpdf::polygon() draw a polygon, the syntax for this is similar to the GD polygon command Cpdf::rectangle() draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not Cpdf::reopenObject() open an existing object for editing Cpdf::restoreState() restore a previously saved state Cpdf::saveState() this will be called at a new page to return the state to what it was on the Cpdf::selectFont() if the font is not loaded then load it and make the required object Cpdf::setColor() sets the colour for fill operations Cpdf::setColorBy255() like setColor() but uses values from 0-255 instead of 0-1. Cpdf::setEncryption() set the encryption of the document can be used to turn it on and/or set the passwords which it will have. Cpdf::setFontFamily() define font families, this is used to initialize the font families for the default fonts and for the user to add new ones for their fonts. The default bahavious can be overridden should that be desired. Cpdf::setLineStyle() this sets the line drawing style. Cpdf::setPreferences() set the viewer preferences of the document, it is up to the browser to obey these. Cpdf::setStrokeColor() sets the colour for stroke operations Cpdf::setStrokeColorBy255() like setStrokeColor() but uses values from 0-255 instead of 0-1. Cpdf::stopObject() stop an object from appearing on pages from this point on Cpdf::stream() output the pdf code, streaming it to the browser Cpdf::transaction() a few functions which should allow the document to be treated transactionally.
### Class Details [line 24] Cpdf http://www.ros.co.nz/pdf A PHP class to provide the basic functionality to create a pdf document without any requirement for additional modules. Note that they companion class CezPdf can be used to extend this class and dramatically simplify the creation of documents. IMPORTANT NOTE there is no warranty, implied or otherwise with this software. LICENCE This code has been placed in the Public Domain for all to enjoy. #### Tags:
version: | 009
author: | Wayne Munro <mailto:pdf@ros.co.nz>
[ Top ] ### Class Variables #### $reportContents = array() [line 26]
Type: | mixed
[ Top ] ### Class Methods ### constructor Creport [line 28]
`Creport Creport( mixed $p, mixed $o)`
[ Top ] ### method dots [line 43]
`void dots( mixed $info)`
[ Top ] ### method rf [line 32]
`void rf( mixed $info)`
[ Top ] Documentation generated on Mon, 29 Dec 2003 21:15:53 +0100 by phpDocumentor 1.2.3