| blob | 04cf51622fbf15385f33f81802d94e9a528ec5e6 |
1 <?php
2 /**
3 * Cpdf
4 *
5 * http://www.ros.co.nz/pdf
6 *
7 * A PHP class to provide the basic functionality to create a pdf document without
8 * any requirement for additional modules.
9 *
10 * Note that they companion class CezPdf can be used to extend this class and dramatically
11 * simplify the creation of documents.
12 *
13 * IMPORTANT NOTE
14 * there is no warranty, implied or otherwise with this software.
15 *
16 * LICENCE
17 * This code has been placed in the Public Domain for all to enjoy.
18 *
19 * @author Wayne Munro <pdf@ros.co.nz>
20 * @version 009
21 * @package Cpdf
22 */
26 /**
27 * the current number of pdf objects in the document
28 */
31 /**
32 * this array contains all of the pdf objects, ready for final assembly
33 */
36 /**
37 * the objectId (number within the objects array) of the document catalog
38 */
41 /**
42 * array carrying information about the fonts that the system currently knows about
43 * used to ensure that a font is not loaded twice, among other things
44 */
47 /**
48 * a record of the current font
49 */
52 /**
53 * the current base font
54 */
57 /**
58 * the number of the current font within the font array
59 */
62 /**
63 *
64 */
67 /**
68 * object number of the current page
69 */
72 /**
73 * object number of the currently active contents block
74 */
77 /**
78 * number of fonts within the system
79 */
82 /**
83 * Number of graphic state resources used
84 */
88 /**
89 * current colour for fill operations, defaults to inactive value, all three components should be between 0 and 1 inclusive when active
90 */
93 /**
94 * current colour for stroke operations (lines etc.)
95 */
98 /**
99 * current style that lines are drawn in
100 */
103 /**
104 * current line transparency (partial graphics state)
105 */
108 /**
109 * current fill transparency (partial graphics state)
110 */
113 /**
114 * an array which is used to save the state of the document, mainly the colours and styles
115 * it is used to temporarily change to another state, the change back to what it was before
116 */
119 /**
120 * number of elements within the state stack
121 */
124 /**
125 * number of page objects within the document
126 */
129 /**
130 * object Id storage stack
131 */
134 /**
135 * number of elements within the object Id storage stack
136 */
139 /**
140 * an array which contains information about the objects which are not firmly attached to pages
141 * these have been added with the addObject function
142 */
145 /**
146 * array contains infomation about how the loose objects are to be added to the document
147 */
150 /**
151 * the objectId of the information object for the document
152 * this contains authorship, title etc.
153 */
156 /**
157 * number of images being tracked within the document
158 */
161 /**
162 * an array containing options about the document
163 * it defaults to turning on the compression of the objects
164 */
167 /**
168 * the objectId of the first page of the document
169 */
172 /**
173 * used to track the last used value of the inter-word spacing, this is so that it is known
174 * when the spacing is changed.
175 */
178 /**
179 * the object Id of the procset object
180 */
183 /**
184 * store the information about the relationship between font families
185 * this used so that the code knows which font is the bold version of another font, etc.
186 * the value of this array is initialised in the constuctor function.
187 */
190 /**
191 * track if the current font is bolded or italicised
192 */
195 /**
196 * messages are stored here during processing, these can be selected afterwards to give some useful debug information
197 */
200 /**
201 * the ancryption array for the document encryption is stored here
202 */
205 /**
206 * the object Id of the encryption information
207 */
210 /**
211 * the file identifier, used to uniquely identify a pdf document
212 */
215 /**
216 * a flag to say if a document is to be encrypted or not
217 */
220 /**
221 * the ancryption key for the encryption of all the document content (structure is not encrypted)
222 */
225 /**
226 * array which forms a stack to keep track of nested callback functions
227 */
230 /**
231 * the number of callback functions in the callback array
232 */
235 /**
236 * store label->id pairs for named destinations, these will be used to replace internal links
237 * done this way so that destinations can be defined after the location that links to them
238 */
241 /**
242 * store the stack for the transaction commands, each item in here is a record of the values of all the
243 * publiciables within the class, so that the user can rollback at will (from each 'start' command)
244 * note that this includes the objects array, so these can be large.
245 */
248 /**
249 * class constructor
250 * this will start a new document
251 * @var array array of 4 numbers, defining the bottom left and upper right corner of the page. first two are normally zero.
252 */
258 // also initialize the font families that are known about already
261 // $this->fileIdentifier = md5('xxxxxxxx'.time());
264 }
267 /**
268 * Document object methods (internal use only)
269 *
270 * There is about one object method for each type of object in the pdf document
271 * Each function has the same call list ($id,$action,$options).
272 * $id = the object ID of the object, or what it is to be if it is being created
273 * $action = a string specifying the action to be performed, though ALL must support:
274 * 'new' - create the object with the id $id
275 * 'out' - produce the output for the pdf object
276 * $options = optional, a string or array containing the various parameters for the object
277 *
278 * These, in conjunction with the output function are the ONLY way for output to be produced
279 * within the pdf 'file'.
280 */
282 /**
283 *destination object, used to specify the location for the user to jump to, presently on opening
284 */
290 }
327 }
340 }
341 }
344 /**
345 * set the viewer preferences
346 */
352 }
385 }
386 }
398 }
405 }
406 }
409 /**
410 * define the document catalog, the overall controller for the document
411 */
417 }
448 }
487 }
488 }
495 }
496 }
499 /**
500 * object which is a parent to the pages in the document
501 */
507 }
523 // then it will just be the id of the new page
527 // then it should be an array having 'id','rid','pos', where rid=the page to which this one will be placed relative
528 // and pos is either 'before' or 'after', saying where this page will fit.
535 // then there is a match
536 // make a space
556 }
563 }
566 }
567 }
568 }
569 }
582 // which should be an array of 4 numbers
594 $o['info']['extGStates'][] = array('objNum' => $options['objNum'], 'stateNum' => $options['stateNum']);
614 }
629 }
638 }
641 }
650 }
653 }
662 }
665 }
674 $res.= "\n/MediaBox [".sprintf('%.3f', $tmp[0]) .' '.sprintf('%.3f', $tmp[1]) .' '.sprintf('%.3f', $tmp[2]) .' '.sprintf('%.3f', $tmp[3]) .']';
675 }
676 }
682 }
687 }
688 }
691 /**
692 * define the outlines in the doc, empty for now
693 */
699 }
726 }
732 }
737 }
738 }
741 /**
742 * an object to hold the font description
743 */
749 }
755 $this->objects[$id] = array('t' => 'font', 'info' => array('name' => $options['name'], 'SubType' => 'Type1'));
761 // deal with the encoding and the differences
764 // then we'll need an encoding dictionary
772 // we can specify encoding here
794 }
798 }
800 // also tell the pages node about the new font
833 }
834 }
849 // then place a reference to the dictionary
853 // use the specified encoding
855 }
860 }
865 }
870 }
875 }
882 }
883 }
886 /**
887 * a font descriptor, needed for including additional fonts
888 */
894 }
941 }
966 }
967 }
974 }
975 }
978 /**
979 * the font encoding
980 */
986 }
992 // the options array should contain 'differences' and maybe 'encoding'
1004 }
1009 }
1019 // we cannot make use of consecutive numbering
1024 }
1027 }
1034 }
1035 }
1038 /**
1039 * the document procset, solves some problems with printing to old PS printers
1040 */
1046 }
1062 // this is to add new items to the procset list, despite the fact that this is considered
1063 // obselete, the items are required for printing to some postscript printers
1075 }
1086 }
1093 }
1094 }
1097 /**
1098 * define the document information
1099 */
1105 }
1115 $this->objects[$id] = array('t'=>'info', 'info'=>array('Creator'=>'R and OS php pdf writer, http://www.ros.co.nz', 'CreationDate'=>$date));
1146 }
1160 }
1163 }
1170 }
1171 }
1174 /**
1175 * an action object, used to link to URLS initially
1176 */
1182 }
1193 // then assume a URI action
1195 }
1204 }
1212 // there will be an 'label' setting, this is the name of the destination
1227 }
1232 }
1239 }
1240 }
1243 /**
1244 * an annotation object, this will add an annotation to the current page.
1245 * initially will support just link annotations
1246 */
1252 }
1258 // add the annotation to the current page
1263 // and add the action object which is going to be required
1280 // this is to a named internal link
1292 }
1309 }
1322 }
1331 }
1332 }
1335 /**
1336 * a page object, it also creates a contents object to hold its contents
1337 */
1343 }
1351 $this->objects[$id] = array('t'=>'page', 'info'=>array('parent'=>$this->currentNode, 'pageNum'=>$this->numPages));
1355 // then this must be a page insertion, array shoudl contain 'rid','pos'=[before|after]
1362 }
1366 //make a contents object to go with this page
1384 }
1385 }
1397 // add an annotation to this page
1401 }
1403 // $options should contain the id of the annotation dictionary
1421 }
1424 }
1435 // reverse the page contents so added objects are below normal content
1436 //foreach (array_reverse($o['info']['contents']) as $cId) {
1438 // Back to normal now that I've got transparency working --Benj
1441 }
1444 }
1451 }
1452 }
1455 /**
1456 * the contents objects hold all of the content which appears on pages
1457 */
1463 }
1473 // then this contents is the primary for a page
1477 // then this page contains some other type of system object
1479 }
1485 // add more options to the decleration
1489 }
1506 // then implement ZLIB based compression on this content stream
1510 }
1517 }
1522 }
1525 }
1532 }
1533 }
1536 /**
1537 * an image object, will be an XObject in the document, includes description and data
1538 */
1544 }
1550 // make the new object
1566 }
1581 }
1590 $this->objects[$id]['info']['DecodeParms'] = '<< /Predictor 15 /Colors '.$options['ncolor'].' /Columns '.$options['iw'].' /BitsPerComponent '.$options['bitsPerComponent'].'>>';
1629 }
1630 }
1654 }
1655 }
1657 }
1660 }
1662 // assign it a place in the named resource dictionary as an external object, according to
1663 // the label passed in with it.
1664 $this->o_pages($this->currentNode, 'xObject', array('label'=>$options['label'], 'objNum'=>$id));
1666 // also make sure that we have the right procset object for it.
1680 }
1687 }
1694 }
1695 }
1698 /**
1699 * graphics state object
1700 */
1712 }
1719 // Tell the pages about the new resource
1721 $this->o_pages($this->currentNode, 'extGState', array("objNum" => $id, "stateNum" => $this->numStates));
1734 }
1741 }
1742 }
1745 /**
1746 * encryption object.
1747 */
1753 }
1759 // make the new object
1764 // figure out the additional paramaters required
1765 $pad = chr(0x28) .chr(0xBF) .chr(0x4E) .chr(0x5E) .chr(0x4E) .chr(0x75) .chr(0x8A) .chr(0x41) .chr(0x64) .chr(0x00) .chr(0x4E) .chr(0x56) .chr(0xFF) .chr(0xFA) .chr(0x01) .chr(0x08) .chr(0x2E) .chr(0x2E) .chr(0x00) .chr(0xB6) .chr(0xD0) .chr(0x68) .chr(0x3E) .chr(0x80) .chr(0x2F) .chr(0x0C) .chr(0xA9) .chr(0xFE) .chr(0x64) .chr(0x53) .chr(0x69) .chr(0x7A);
1778 }
1791 }
1803 // now make the u value, phew.
1804 $tmp = $this->md5_16($user.$ovalue.chr($options['p']) .chr(255) .chr(255) .chr(255) .$this->fileIdentifier);
1823 // initialize the arc4 array
1840 // and the p-value needs to be converted to account for the twos-complement approach
1851 }
1852 }
1855 /**
1856 * ARC4 functions
1857 * A series of function to implement ARC4 encoding in PHP
1858 */
1860 /**
1861 * calculate the 16 byte version of the 128 bit md5 digest of the string
1862 */
1872 }
1875 }
1878 /**
1879 * initialize the encryption for processing a particular object
1880 */
1890 }
1892 $tmp.= chr(hexdec(substr($hex, 4, 2))) .chr(hexdec(substr($hex, 2, 2))) .chr(hexdec(substr($hex, 0, 2))) .chr(0) .chr(0);
1897 }
1900 /**
1901 * initialize the ARC4 encryption
1902 */
1907 // setup the control array
1911 }
1918 }
1925 }
1938 }
1939 }
1942 /**
1943 * ARC4 encrypt a text string
1944 */
1972 }
1976 }
1979 /**
1980 * functions which can be called to adjust or add to the document
1981 */
1983 /**
1984 * add a link in the document to an external URL
1985 */
1993 }
1996 /**
1997 * add a link in the document to an internal destination (ie. within the document)
1998 */
2006 }
2009 /**
2010 * set the encryption of the document
2011 * can be used to turn it on and/or set the passwords which it will have.
2012 * also the functions that the user will have are set here, such as print, modify, add
2013 */
2030 }
2031 }
2033 // implement encryption on the document
2036 // then the block does not exist already, add it.
2042 }
2044 $this->o_encryption($this->numObj, 'new', array('user'=>$userPass, 'owner'=>$ownerPass, 'p'=>$p));
2045 }
2046 }
2049 /**
2050 * should be used for internal checks, not implemented as yet
2051 */
2053 }
2056 /**
2057 * return the pdf stream as a string returned from the function
2058 */
2064 // turn compression off
2066 }
2072 }
2082 // $content="%PDF-1.3\n";
2096 }
2103 }
2105 $content.= "trailer\n<<\n/Size ".(count($xref) +1) ."\n/Root 1 0 R\n/Info ".$this->infoObject." 0 R\n";
2107 // if encryption has been applied to this document then add the marker for this dictionary
2111 }
2116 }
2121 }
2124 /**
2125 * intialize a new document
2126 * if this is called on an existing document results may be unpredictable, but the existing document would be lost at minimum
2127 * this function is called automatically by the constructor function
2128 *
2129 * @access private
2130 */
2173 // need to store the first page id as there is no way to get it to the user during
2174 // startup
2176 }
2179 /**
2180 * open the font file and return a php structure containing it.
2181 * first check if this one has been done before and saved in a form more suited to php
2182 * note that if a php serialized version does not exist it will try and make one, but will
2183 * require write access to the directory to do it... it is MUCH faster to have these serialized
2184 * files.
2185 *
2186 * @access private
2187 */
2190 // assume that $font contains both the path and perhaps the extension to the file, split them
2203 }
2209 }
2223 // if the font file is old, then clear it out and prepare for re-creation
2227 }
2228 }
2232 // then rebuild the php_<font>.afm file from the <font>.afm file
2247 // then there must be some keyword
2300 //C 39 ; WX 222 ; N quoteright ; B 53 463 157 718 ;
2318 }
2322 }
2323 }
2324 }
2334 }
2340 //KPX Adieresis yacute -40
2346 }
2347 }
2348 }
2354 file_put_contents($dir . 'php_' . $name . '.afm', '$this->fonts[$font]=' . var_export($data, true) . ';');
2359 // echo 'Font not Found '.$font;
2361 }
2362 }
2365 /**
2366 * if the font is not loaded then load it and make the required object
2367 * else just make it the current font
2368 * the encoding array can contain 'encoding'=> 'none','WinAnsiEncoding','MacRomanEncoding' or 'MacExpertEncoding'
2369 * note that encoding='none' will need to be used for symbolic fonts
2370 * and 'differences' => an array of mappings between numbers 0->255 and character names.
2371 *
2372 */
2377 // load the file
2386 //$this->numFonts = md5($fontName);
2389 // $dir = substr($fontName,0,$pos+1);
2395 }
2402 // then encoding and differences might be set
2406 }
2411 }
2414 // then perhaps only the encoding has been set
2416 }
2426 // if this is a '.afm' font, and there is a '.pfa' file to go with it ( as there
2427 // should be for all non-basic fonts), then load it into an object and put the
2428 // references into the font object
2440 }
2445 // $pfbfile = substr($fontName,0,strlen($fontName)-4).'.pfb';
2446 // $ttffile = substr($fontName,0,strlen($fontName)-4).'.ttf';
2454 // $fontObj = $this->numObj;
2457 // find the array of fond widths, and put that into an object.
2473 }
2474 }
2481 }
2484 }
2485 }
2487 // also need to adjust the widths for the differences array
2497 }
2500 }
2505 }
2506 }
2507 }
2522 }
2529 // load the pfb file, and put that into an object too.
2530 // note that pdf supports only binary format type 1 font files, though there is a
2531 // simple utility to convert them from pfa to pfb.
2541 // create the font descriptor
2550 // determine flags (more than a little flakey, hopefully will not matter much)
2555 }
2559 }
2562 // assume non-sybolic
2564 $list = array('Ascent' => 'Ascender', 'CapHeight' => 'CapHeight', 'Descent' => 'Descender', 'FontBBox' => 'FontBBox', 'ItalicAngle' => 'ItalicAngle');
2567 'Flags' => $flags, 'FontName' => $adobeFontName, 'StemV' => 100 // don't know what the value for this should be!
2568 );
2575 }
2576 }
2585 }
2590 // embed the font program
2595 // determine the cruicial lengths within this file
2604 $this->o_contents($this->numObj, 'add', array('Length1' => $l1, 'Length2' => $l2, 'Length3' => $l3));
2610 }
2614 // tell the font object about all this new stuff
2615 $tmp = array('BaseFont' => $adobeFontName, 'Widths' => $widthid, 'FirstChar' => $firstChar, 'LastChar' => $lastChar, 'FontDescriptor' => $fontDescriptorId);
2620 }
2627 }
2632 $this->addMessage('selectFont: pfb or ttf file not found, ok if this is one of the 14 standard fonts');
2633 }
2637 // also set the differences here, note that this means that these will take effect only the
2638 //first time that a font is selected, else they are ignored
2642 }
2643 }
2644 }
2648 // so if for some reason the font was not set in the last one then it will not be selected
2651 // the next lines mean that if a new font is selected, then the current text state will be
2652 // applied to it as well.
2657 //$this->setCurrentFont();
2659 }
2663 //return $this->numObj;
2665 }
2668 /**
2669 * sets up the current font, based on the font families, and the current text state
2670 * note that this system is quite flexible, a bold-italic font can be completely different to a
2671 * italic-bold font, and even bold-bold will have to be defined within the family to have meaning
2672 * This function is to be called whenever the currentTextState is changed, it will update
2673 * the currentFont setting to whatever the appropriatte family one is.
2674 * If the user calls selectFont themselves then that will reset the currentBaseFont, and the currentFont
2675 * This function will change the currentFont to whatever it should be, but will not change the
2676 * currentBaseFont.
2677 *
2678 * @access private
2679 */
2682 // if (strlen($this->currentBaseFont) == 0){
2683 // // then assume an initial font
2684 // $this->selectFont('./fonts/Helvetica.afm');
2685 // }
2686 // $cf = substr($this->currentBaseFont,strrpos($this->currentBaseFont,'/')+1);
2687 // if (strlen($this->currentTextState)
2688 // && isset($this->fontFamilies[$cf])
2689 // && isset($this->fontFamilies[$cf][$this->currentTextState])){
2690 // // then we are in some state or another
2691 // // and this font has a family, and the current setting exists within it
2692 // // select the font, then return it
2693 // $nf = substr($this->currentBaseFont,0,strrpos($this->currentBaseFont,'/')+1).$this->fontFamilies[$cf][$this->currentTextState];
2694 // $this->selectFont($nf,'',0);
2695 // $this->currentFont = $nf;
2696 // $this->currentFontNum = $this->fonts[$nf]['fontNum'];
2697 // } else {
2698 // // the this font must not have the right family member for the current state
2699 // // simply assume the base font
2704 // }
2706 }
2709 /**
2710 * function for the user to find out what the ID is of the first page that was created during
2711 * startup - useful if they wish to add something to it later.
2712 */
2716 }
2719 /**
2720 * add content to the currently active object
2721 *
2722 * @access private
2723 */
2727 }
2730 /**
2731 * sets the colour for fill operations
2732 */
2735 if ($r >= 0 && ($force || $r != $this->currentColour['r'] || $g != $this->currentColour['g'] || $b != $this->currentColour['b'])) {
2737 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $r) .' '.sprintf('%.3f', $g) .' '.sprintf('%.3f', $b) .' rg';
2740 }
2741 }
2744 /**
2745 * sets the colour for stroke operations
2746 */
2749 if ($r >= 0 && ($force || $r != $this->currentStrokeColour['r'] || $g != $this->currentStrokeColour['g'] || $b != $this->currentStrokeColour['b'])) {
2751 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $r) .' '.sprintf('%.3f', $g) .' '.sprintf('%.3f', $b) .' RG';
2754 }
2755 }
2758 /**
2759 * Set the graphics state for compositions
2760 */
2763 // Create a new graphics state object
2764 // FIXME: should actually keep track of states that have already been created...
2770 }
2773 /**
2774 * Set current blend mode & opacity for lines.
2775 *
2776 * Valid blend modes are:
2777 *
2778 * Normal, Multiply, Screen, Overlay, Darken, Lighten,
2779 * ColorDogde, ColorBurn, HardLight, SoftLight, Difference,
2780 * Exclusion
2781 *
2782 * @param string $mode the blend mode to use
2783 * @param float $opacity 0.0 fully transparent, 1.0 fully opaque
2784 */
2794 // Only create a new graphics state if required
2803 }
2805 /**
2806 * Set current blend mode & opacity for filled objects.
2807 *
2808 * Valid blend modes are:
2809 *
2810 * Normal, Multiply, Screen, Overlay, Darken, Lighten,
2811 * ColorDogde, ColorBurn, HardLight, SoftLight, Difference,
2812 * Exclusion
2813 *
2814 * @param string $mode the blend mode to use
2815 * @param float $opacity 0.0 fully transparent, 1.0 fully opaque
2816 */
2834 }
2836 /**
2837 * draw a line from one set of coordinates to another
2838 */
2842 "\n".sprintf('%.3f', $x1) .' '.sprintf('%.3f', $y1) .' m '.sprintf('%.3f', $x2) .' '.sprintf('%.3f', $y2) .' l S';
2843 }
2846 /**
2847 * draw a bezier curve based on 4 control points
2848 */
2851 // in the current line style, draw a bezier curve from (x0,y0) to (x3,y3) using the other two points
2852 // as the control points for the curve.
2854 "\n".sprintf('%.3f', $x0) .' '.sprintf('%.3f', $y0) .' m '.sprintf('%.3f', $x1) .' '.sprintf('%.3f', $y1);
2857 ' '.sprintf('%.3f', $x2) .' '.sprintf('%.3f', $y2) .' '.sprintf('%.3f', $x3) .' '.sprintf('%.3f', $y3) .' c S';
2858 }
2861 /**
2862 * draw a part of an ellipse
2863 */
2867 }
2870 /**
2871 * draw a filled ellipse
2872 */
2873 function filledEllipse($x0, $y0, $r1, $r2 = 0, $angle = 0, $nSeg = 8, $astart = 0, $afinish = 360) {
2876 }
2879 /**
2880 * draw an ellipse
2881 * note that the part and filled ellipse are just special cases of this function
2882 *
2883 * draws an ellipse in the current line style
2884 * centered at $x0,$y0, radii $r1,$r2
2885 * if $r2 is not set, then a circle is drawn
2886 * nSeg is not allowed to be less than 2, as this will simply draw a line (and will even draw a
2887 * pretty crappy shape at 2, as we are approximating with bezier curves.
2888 */
2889 function ellipse($x0, $y0, $r1, $r2 = 0, $angle = 0, $nSeg = 8, $astart = 0, $afinish = 360, $close = 1, $fill = 0) {
2893 }
2897 }
2901 }
2921 $tmp .= sprintf('%.3f', cos($a)) .' '.sprintf('%.3f', (-1.0*sin($a))) .' '.sprintf('%.3f', sin($a)) .' '.sprintf('%.3f', cos($a)) .' ';
2928 }
2938 $this->objects[$this->currentContents]['c'] .= "\n".sprintf('%.3f', $a0) .' '.sprintf('%.3f', $b0) .' m ';
2942 // draw this bit of the total curve
2957 ' '.sprintf('%.3f', ($a1-$c1*$dtm)) .' '.sprintf('%.3f', ($b1-$d1*$dtm)) .' '.sprintf('%.3f', $a1) .' '.sprintf('%.3f', $b1) .' c';
2966 }
2974 // small 's' signifies closing the path as well
2980 }
2984 }
2986 }
2989 /**
2990 * this sets the line drawing style.
2991 * width, is the thickness of the line in user units
2992 * cap is the type of cap to put on the line, values can be 'butt','round','square'
2993 * where the diffference between 'square' and 'butt' is that 'square' projects a flat end past the
2994 * end of the line.
2995 * join can be 'miter', 'round', 'bevel'
2996 * dash is an array which sets the dash pattern, is a series of length values, which are the lengths of the
2997 * on and off dashes.
2998 * (2) represents 2 on, 2 off, 2 on , 2 off ...
2999 * (2,1) is 2 on, 1 off, 2 on, 1 off.. etc
3000 * phase is a modifier on the dash pattern which is used to shift the point at which the pattern starts.
3001 */
3005 // this is quite inefficient in that it sets all the parameters whenever 1 is changed, but will fix another day
3011 }
3018 }
3025 }
3034 }
3037 }
3042 }
3046 /**
3047 * draw a polygon, the syntax for this is similar to the GD polygon command
3048 */
3053 $this->objects[$this->currentContents]['c'].= sprintf('%.3f', $p[0]) .' '.sprintf('%.3f', $p[1]) .' m ';
3057 $this->objects[$this->currentContents]['c'].= sprintf('%.3f', $p[$i]) .' '.sprintf('%.3f', $p[$i+1]) .' l ';
3058 }
3066 }
3067 }
3070 /**
3071 * a filled rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
3072 * the coordinates of the upper-right corner
3073 */
3076 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $x1) .' '.sprintf('%.3f', $y1) .' '.sprintf('%.3f', $width) .' '.sprintf('%.3f', $height) .' re f';
3077 }
3080 /**
3081 * draw a rectangle, note that it is the width and height of the rectangle which are the secondary paramaters, not
3082 * the coordinates of the upper-right corner
3083 */
3086 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $x1) .' '.sprintf('%.3f', $y1) .' '.sprintf('%.3f', $width) .' '.sprintf('%.3f', $height) .' re S';
3087 }
3090 /**
3091 * add a new page to the document
3092 * this also makes the new page the current active object
3093 */
3097 // if there is a state saved, then go up the stack closing them
3098 // then on the new page, re-open them with the right setings
3105 }
3106 }
3113 // the id from the ezPdf class is the od of the contents of the page, not the page object itself
3114 // query that object to find the parent
3123 }
3125 // if there is a stack saved, then put that onto the page
3131 }
3132 }
3134 // and if there has been a stroke or fill colour set, then transfer them
3137 $this->setColor($this->currentColour['r'], $this->currentColour['g'], $this->currentColour['b'], 1);
3138 }
3142 $this->setStrokeColor($this->currentStrokeColour['r'], $this->currentStrokeColour['g'], $this->currentStrokeColour['b'], 1);
3143 }
3146 // if there is a line style set, then put this in too
3150 }
3153 // the call to the o_page object set currentContents to the present page, so this can be returned as the page id
3155 }
3158 /**
3159 * output the pdf code, streaming it to the browser
3160 * the relevant headers are set so that hopefully the browser will recognise it
3161 */
3164 // setting the options allows the adjustment of the headers
3165 // values at the moment are:
3166 // 'Content-Disposition' => 'filename' - sets the filename, though not too sure how well this will
3167 // work as in my trial the browser seems to use the filename of the php file with .pdf on the end
3168 // 'Accept-Ranges' => 1 or 0 - if this is not set to 1, then this header is not included, off by default
3169 // this header seems to have caused some problems despite tha fact that it is supposed to solve
3170 // them, so I am leaving it off by default.
3171 // 'compress' = > 1 or 0 - apply content stream compression, this is on (1) by default
3172 // 'Attachment' => 1 or 0 - if 1, force the browser to open a download dialog
3176 }
3188 }
3195 //header("Content-Length: " . strlen($tmp));
3196 $fileName = (isset($options['Content-Disposition']) ? $options['Content-Disposition'] : 'file.pdf');
3211 }
3216 }
3219 /**
3220 * return the height in units of the current font in the given size
3221 */
3227 }
3229 // for the current font, and the given size, what is the height of the font in user units
3230 $h = $this->fonts[$this->currentFont]['FontBBox'][3]-$this->fonts[$this->currentFont]['FontBBox'][1];
3233 }
3236 /**
3237 * return the font decender, this will normally return a negative number
3238 * if you add this number to the baseline, you get the level of the bottom of the font
3239 * it is in the pdf user units
3240 */
3243 // note that this will most likely return a negative value
3247 }
3252 }
3255 /**
3256 * filter the text, this is applied to all text just before being inserted into the pdf document
3257 * it escapes the various things that need to be escaped, and so on
3258 *
3259 * @access private
3260 */
3271 }
3274 /**
3275 * given a start position and information about how text is to be laid out, calculate where
3276 * on the page the text will end
3277 *
3278 * @access private
3279 */
3282 // given this information return an array containing x and y for the end position as elements 0 and 1
3285 // need to adjust for the number of spaces in this text
3295 }
3298 /**
3299 * wrapper function for PRVTcheckTextDirective1
3300 *
3301 * @access private
3302 */
3312 }
3315 /**
3316 * checks if the text stream contains a control directive
3317 * if so then makes some changes and returns the number of characters involved in the directive
3318 * this has been re-worked to include everything neccesary to fins the current writing point, so that
3319 * the location can be sent to the callback function if required
3320 * if the directive does not require a font change, then $f should be set to 0
3321 *
3322 * @access private
3323 */
3324 function PRVTcheckTextDirective1(&$text, $i, &$f, $final, &$x, &$y, $size = 0, $angle = 0, $wordSpaceAdjust = 0) {
3345 }
3361 // then there is one to remove
3362 $this->currentTextState = substr($this->currentTextState, 0, $p) .substr($this->currentTextState, $p+1);
3363 }
3366 }
3372 // this this might be a callback function
3379 // then this will be treated as a callback directive
3384 // split the remainder on colons to get the function name and the paramater
3399 }
3406 // only call the function if this is the final call
3409 // need to assess the text position, calculate the text width to this point
3410 // can use getTextWidth to find the text width I think
3411 $tmp = $this->PRVTgetTextPosition($x, $y, $angle, $size, $wordSpaceAdjust, substr($text, 0, $i));
3413 $info = array('x' => $tmp[0], 'y' => $tmp[1], 'angle' => $angle, 'status' => 'end', 'p' => $parm, 'nCallback' => $this->nCallback);
3423 // then the return from the callback function could set the position, to start with, later will do font colour, and font
3435 }
3436 }
3437 }
3439 // also remove from to the stack
3440 // for simplicity, just take from the end, fix this another day
3446 }
3447 }
3448 }
3449 }
3452 }
3467 }
3477 // this this might be a callback function
3484 // then this will be treated as a callback directive
3489 // split the remainder on colons to get the function name and the paramater
3490 // $bits = explode(':',substr($text,$j+1,$k-$j-1));
3505 }
3512 // only call the function if this is the final call, ie, the one actually doing printing, not measurement
3515 // need to assess the text position, calculate the text width to this point
3516 // can use getTextWidth to find the text width I think
3517 // also add the text height and decender
3518 $tmp = $this->PRVTgetTextPosition($x, $y, $angle, $size, $wordSpaceAdjust, substr($text, 0, $i));
3520 $info = array('x' => $tmp[0], 'y' => $tmp[1], 'angle' => $angle, 'status' => 'start', 'p' => $parm, 'f' => $func, 'height' => $this->getFontHeight($size), 'decender' => $this->getFontDecender($size));
3528 // only add to the stack if this is a small 'c', therefore is a start-stop pair
3534 }
3540 // then the return from the callback function could set the position, to start with, later will do font colour, and font
3552 }
3553 }
3554 }
3555 }
3556 }
3557 }
3560 }
3561 }
3564 }
3567 /**
3568 * add text to the document, at a specified location, size and angle on the page
3569 */
3574 }
3577 // if there are any open callbacks, then they should be called, to show the start of the line
3582 // call each function
3595 }
3596 }
3600 $this->objects[$this->currentContents]['c'].= "\n".'BT '.sprintf('%.3f', $x) .' '.sprintf('%.3f', $y) .' Td';
3608 $tmp.= sprintf('%.3f', cos($a)) .' '.sprintf('%.3f', (-1.0*sin($a))) .' '.sprintf('%.3f', sin($a)) .' '.sprintf('%.3f', cos($a)) .' ';
3613 }
3620 }
3626 /*
3627 for ($i = 0;$i<$len;$i++){
3628 $f = 1;
3629 $directive = 0; //$this->PRVTcheckTextDirective($text,$i,$f);
3630 if ($directive){
3631 // then we should write what we need to
3632 if ($i>$start){
3633 $part = substr($text,$start,$i-$start);
3634 $this->objects[$this->currentContents]['c'] .= ' /F'.$this->currentFontNum.' '.sprintf('%.1f',$size).' Tf ';
3635 $this->objects[$this->currentContents]['c'] .= ' ('.$this->filterText($part).') Tj';
3636 }
3637 if ($f){
3638 // then there was nothing drastic done here, restore the contents
3639 $this->setCurrentFont();
3640 } else {
3641 $this->objects[$this->currentContents]['c'] .= ' ET';
3642 $f = 1;
3643 $xp = $x;
3644 $yp = $y;
3645 $directive = 0; //$this->PRVTcheckTextDirective1($text,$i,$f,1,$xp,$yp,$size,$angle,$wordSpaceAdjust);
3647 // restart the text object
3648 if ($angle == 0){
3649 $this->objects[$this->currentContents]['c'] .= "\n".'BT '.sprintf('%.3f',$xp).' '.sprintf('%.3f',$yp).' Td';
3650 } else {
3651 $a = deg2rad((float)$angle);
3652 $tmp = "\n".'BT ';
3653 $tmp .= sprintf('%.3f',cos($a)).' '.sprintf('%.3f',(-1.0*sin($a))).' '.sprintf('%.3f',sin($a)).' '.sprintf('%.3f',cos($a)).' ';
3654 $tmp .= sprintf('%.3f',$xp).' '.sprintf('%.3f',$yp).' Tm';
3655 $this->objects[$this->currentContents]['c'] .= $tmp;
3656 }
3657 if ($wordSpaceAdjust != 0 || $wordSpaceAdjust != $this->wordSpaceAdjust){
3658 $this->wordSpaceAdjust = $wordSpaceAdjust;
3659 $this->objects[$this->currentContents]['c'] .= ' '.sprintf('%.3f',$wordSpaceAdjust).' Tw';
3660 }
3661 }
3662 // and move the writing point to the next piece of text
3663 $i = $i+$directive-1;
3664 $start = $i+1;
3665 }
3667 }
3668 */
3673 $this->objects[$this->currentContents]['c'].= ' /F'.$this->currentFontNum.' '.sprintf('%.1f', $size) .' Tf ';
3676 }
3681 // if there are any open callbacks, then they should be called, to show the end of the line
3686 // call each function
3689 $info = array('x' => $tmp[0], 'y' => $tmp[1], 'angle' => $angle, 'status' => 'eol', 'p' => $this->callback[$i]['p'], 'nCallback' => $this->callback[$i]['nCallback'], 'height' => $this->callback[$i]['height'], 'decender' => $this->callback[$i]['decender']);
3694 }
3695 }
3696 }
3699 /**
3700 * calculate how wide a given text string will be on a page, at a given size.
3701 * this can be called externally, but is alse used by the other class functions
3702 */
3705 // this function should not change any of the settings, though it will need to
3706 // track any directives which change during calculation, so copy them at the start
3707 // and put them back at the end.
3714 }
3717 // converts a number or a float to a string so it can get the width
3721 // hmm, this is where it all starts to get tricky - use the font information to
3722 // calculate the width of each character, add them up and convert to user units
3733 // $f = 1;
3734 // $directive = 0; //$this->PRVTcheckTextDirective($text,$i,$f);
3735 // if ($directive){
3736 // if ($f){
3737 // $this->setCurrentFont();
3738 // $cf = $this->currentFont;
3739 // }
3740 // $i = $i+$directive-1;
3741 // } else {
3747 // then this character is being replaced by another
3759 }
3769 }
3772 /**
3773 * do a part of the calculation for sorting out the justification of the text
3774 *
3775 * @access private
3776 */
3803 // count the number of words
3814 }
3817 }
3818 }
3821 /**
3822 * add text to the page, but ensure that it fits within a certain width
3823 * if it does not fit then put in as much as possible, splitting at word boundaries
3824 * and return the remainder.
3825 * justification and angle can also be specified for the text
3826 */
3827 function addTextWrap($x, $y, $width, $size, $text, $justification = 'left', $angle = 0, $test = 0) {
3829 // this will display the text, and if it goes beyond the width $width, will backtrack to the
3830 // previous space or hyphen, and return the remainder of the text.
3832 // $justification can be set to 'left','right','center','centre','full'
3834 // need to store the initial text state, as this will change during the width calculation
3835 // but will need to be re-set before printing, so that the chars work out right
3841 }
3845 // error, pretend it printed ok, otherwise risking a loop
3847 }
3866 //$this->PRVTcheckTextDirective($text,$i,$f);
3874 }
3883 // then this character is being replaced by another
3888 }
3894 }
3898 // then we need to truncate this line
3901 // then we have somewhere that we can split :)
3908 }
3915 // reset the text state
3923 }
3928 // just split before the current character
3938 }
3944 // reset the text state
3952 }
3955 }
3956 }
3963 }
3974 }
3977 }
3978 }
3979 }
3981 // then there was no need to break this line
3985 }
3993 // reset the text state
4001 }
4004 }
4007 /**
4008 * this will be called at a new page to return the state to what it was on the
4009 * end of the previous page, before the stack was closed down
4010 * This is to get around not being able to have open 'q' across pages
4011 *
4012 */
4017 // this will be called at a new page to return the state to what it was on the
4018 // end of the previous page, before the stack was closed down
4019 // This is to get around not being able to have open 'q' across pages
4021 // ok to use this as stack starts numbering at 1
4028 // $this->currentLineStyle = $opt['lin'];
4035 'col' => $this->currentColour, 'str' => $this->currentStrokeColour, 'lin' => $this->currentLineStyle);
4036 }
4039 }
4042 /**
4043 * restore a previously saved state
4044 */
4062 }
4065 }
4068 /**
4069 * make a loose object, the output will go into this object, until it is closed, then will revert to
4070 * the current one.
4071 * this object will not appear until it is included within a page.
4072 * the function will return the object number
4073 */
4080 // add a new object of the content type, to hold the data flow
4091 }
4094 /**
4095 * open an existing object for editing
4096 */
4105 // also if this object is the primary contents for a page, then set the current page to its parent
4109 }
4110 }
4113 /**
4114 * close an object
4115 */
4118 // close the object, as long as there was one open in the first place, which will be indicated by
4119 // an objectId on the stack.
4128 // easier to probably not worry about removing the old entries, they will be overwritten
4129 // if there are new ones.
4131 }
4132 }
4135 /**
4136 * stop an object from appearing on pages from this point on
4137 */
4140 // if an object has been appearing on pages up to now, then stop it, this page will
4141 // be the last one that could contian it.
4145 }
4146 }
4149 /**
4150 * after an object has been created, it wil only show if it has been added, using this function.
4151 */
4154 // add the specified object to the page
4157 // then it is a valid object, and it is not being added to itself
4162 // then this object is to be added to this page (done in the next block) and
4163 // all future new pages.
4170 // then the destination contents is the primary for the page
4171 // (though this object is actually added to that page)
4173 }
4186 // hacky huh :)
4188 }
4201 // hacky huh :)
4203 }
4224 }
4225 }
4226 }
4229 /**
4230 * return a storable representation of a specific object
4231 */
4239 }
4242 /**
4243 * restore an object from its stored representation. returns its new object id.
4244 */
4255 }
4259 /**
4260 * add content to the documents info object
4261 */
4264 // this will only work if the label is one of the valid ones.
4265 // modify this so that arrays can be passed as well.
4266 // if $label is an array then assume that it is key => value pairs
4267 // else assume that they are both scalar, anything else will probably error
4273 }
4277 }
4278 }
4281 /**
4282 * set the viewer preferences of the document, it is up to the browser to obey these.
4283 */
4286 // this will only work if the label is one of the valid ones.
4292 }
4296 }
4297 }
4300 /**
4301 * extract an integer from a position in a byte stream
4302 *
4303 * @access private
4304 */
4307 // return the integer represented by $num bytes from $pos within $data
4315 }
4318 }
4321 /**
4322 * add a PNG image into the document, from a file
4323 * this should work with remote files
4324 */
4327 // read in a png file, interpret it, then add to the system
4336 // $fp = @fopen($file,'rb');
4337 // if ($fp){
4338 // $data = '';
4339 // while(!feof($fp)){
4340 // $data .= fread($fp,1024);
4341 // }
4342 // fclose($fp);
4346 }
4360 }
4361 }
4366 // set pointer
4371 // cycle through the file, identifying chunks
4386 // echo $chunkType.' - '.$chunkLen.'<br>';
4392 // this is where all the file information comes from
4407 //print_r($info);
4415 }
4422 }
4440 //this chunk can only occur once and it must occur after the PLTE chunk and before IDAT chunk
4441 //print "tRNS found, color type = ".$info['colorType']."\n";
4445 // indexed color, rbg
4446 /* corresponding to entries in the plte chunk
4447 Alpha for palette index 0: 1 byte
4448 Alpha for palette index 1: 1 byte
4449 ...etc...
4450 */
4451 // there will be one entry for each palette entry. up until the last non-opaque entry.
4452 // set up an array, stretching over all palette entries which will be o (opaque) or 1 (transparent)
4464 }
4465 }
4469 // grayscale
4470 /* corresponding to entries in the plte chunk
4471 Gray: 2 bytes, range 0 .. (2^bitdepth)-1
4472 */
4473 // $transparency['grayscale'] = $this->PRVT_getBytes($data,$p+8,2); // g = grayscale
4478 // truecolor
4479 /* corresponding to entries in the plte chunk
4480 Red: 2 bytes, range 0 .. (2^bitdepth)-1
4481 Green: 2 bytes, range 0 .. (2^bitdepth)-1
4482 Blue: 2 bytes, range 0 .. (2^bitdepth)-1
4483 */
4485 // r from truecolor
4487 // g from truecolor
4489 // b from truecolor
4495 //unsupported transparency type
4497 }
4499 // KS End new code
4505 }
4509 }
4517 }
4524 }
4525 }
4533 }
4542 $errormsg = 'transparancey alpha channel not supported, transparency only supported for palette images.';
4570 }
4571 }
4572 }
4579 }
4584 }
4589 }
4591 //print_r($info);
4592 // so this image is ok... add it in.
4601 // $this->o_image($this->numObj,'new',array('label' => $label,'data' => $idata,'iw' => $w,'ih' => $h,'type' => 'png','ic' => $info['width']));
4602 $options = array('label' => $label, 'data' => $idata, 'bitsPerComponent' => $info['bitDepth'], 'pdata' => $pdata, 'iw' => $info['width'], 'ih' => $info['height'], 'type' => 'png', 'color' => $color, 'ncolor' => $ncolor);
4607 }
4614 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $w) ." 0 0 ".sprintf('%.3f', $h) ." ".sprintf('%.3f', $x) ." ".sprintf('%.3f', $y) ." cm";
4619 }
4622 /**
4623 * add a JPEG image into the document, from a file
4624 */
4627 // attempt to add a jpeg image straight from a file, using no GD commands
4628 // note that this function is unable to operate on a remote file.
4633 }
4649 }
4655 }
4660 }
4665 }
4668 //$fp = fopen($img,'rb');
4676 //fread($fp,filesize($img));
4680 //fclose($fp);
4683 }
4686 /**
4687 * add an image into the document, from a GD object
4688 * this function is not all that reliable, and I would probably encourage people to use
4689 * the file based functions
4690 */
4693 // add a new image into the current location, as an external object
4694 // add the image at $x,$y, and with width and height as defined by $w & $h
4696 // note that this will only work with full colour images and makes them jpg images for display
4697 // later versions could present lossless image formats if there is interest.
4699 // there seems to be some problem here in that images that have quality set above 75 do not appear
4700 // not too sure why this is, but in the meantime I have restricted this to 75.
4704 }
4707 // if the width or height are set to zero, then set the other one based on keeping the image
4708 // height/width ratio the same, if they are both zero, then give up :)
4717 }
4722 }
4727 }
4730 // gotta get the data out of the img..
4732 // so I write to a temp file, and then read it back.. soo ugly, my apologies.
4739 //$fp = fopen($tmpName,'rb');
4747 // $fp = @fopen($tmpName,'rb');
4748 // if ($fp){
4749 // $data = '';
4750 // while(!feof($fp)){
4751 // $data .= fread($fp,1024);
4752 // }
4753 // fclose($fp);
4757 }
4759 // $data = fread($fp,filesize($tmpName));
4762 // fclose($fp);
4766 }
4769 /**
4770 * common code used by the two JPEG adding functions
4771 *
4772 * @access private
4773 */
4774 function addJpegImage_common(&$data, $x, $y, $w = 0, $h = 0, $imageWidth, $imageHeight, $channels = 3) {
4776 // note that this function is not to be called externally
4777 // it is just the common code between the GD and the file options
4786 $this->o_image($this->numObj, 'new', array('label' => $label, 'data' => &$data, 'iw' => $imageWidth, 'ih' => $imageHeight, 'channels' => $channels));
4791 $this->objects[$this->currentContents]['c'].= "\n".sprintf('%.3f', $w) ." 0 0 ".sprintf('%.3f', $h) ." ".sprintf('%.3f', $x) ." ".sprintf('%.3f', $y) ." cm";
4796 }
4799 /**
4800 * specify where the document should open when it first starts
4801 */
4804 // this function will open the document at a specified page, in a specified style
4805 // the values for style, and the required paramters are:
4806 // 'XYZ' left, top, zoom
4807 // 'Fit'
4808 // 'FitH' top
4809 // 'FitV' left
4810 // 'FitR' left,bottom,right
4811 // 'FitB'
4812 // 'FitBH' top
4813 // 'FitBV' left
4816 $this->o_destination($this->numObj, 'new', array('page' => $this->currentPage, 'type' => $style, 'p1' => $a, 'p2' => $b, 'p3' => $c));
4821 }
4824 /**
4825 * create a labelled destination within the document
4826 */
4829 // associates the given label with the destination, it is done this way so that a destination can be specified after
4830 // it has been linked to
4831 // styles are the same as the 'openHere' function
4834 $this->o_destination($this->numObj, 'new', array('page' => $this->currentPage, 'type' => $style, 'p1' => $a, 'p2' => $b, 'p3' => $c));
4838 // store the label->idf relationship, note that this means that labels can be used only once
4840 }
4843 /**
4844 * define font families, this is used to initialize the font families for the default fonts
4845 * and for the user to add new ones for their fonts. The default bahavious can be overridden should
4846 * that be desired.
4847 */
4854 // set the known family groups
4855 // these font families will be used to enable bold and italic markers to be included
4856 // within text streams. html forms will be used... <b></b> <i></i>
4874 }
4877 // the user is trying to set a font family
4878 // note that this can also be used to set the base ones to something else
4882 }
4883 }
4884 }
4887 /**
4888 * used to add messages for use in debugging
4889 */
4893 }
4896 /**
4897 * a few functions which should allow the document to be treated transactionally.
4898 */
4905 // store all the data away into the checkpoint variable
4926 }
4932 // do not destroy the current checkpoint, but move us back to the state then, so that we can try again
4935 // can only abort if were inside a checkpoint
4943 }
4944 }
4947 }
4955 // can only abort if were inside a checkpoint
4961 }
4964 }
4967 }
4968 }
4969 }
4970 // end of class
4972 ?>