*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library in the file LICENSE.LGPL; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
* 02111-1307 USA
*
* Alternatively, you may distribute this software under the terms of the
* PHP License, version 3.0 or later. A copy of this license should have
* been distributed with this file in the file LICENSE.PHP . If this is not
* the case, you can obtain a copy at http://www.php.net/license/3_0.txt.
*
* The latest version of DOMPDF might be available at:
* http://www.dompdf.com/
*
* @link http://www.dompdf.com/
* @copyright 2004 Benj Carson
* @author Benj Carson
* @package dompdf
*/
/* $Id: tcpdf_adapter.cls.php 217 2010-03-11 23:03:57Z ryan.masten $ */
require_once(DOMPDF_LIB_DIR . '/tcpdf/tcpdf.php');
/**
* TCPDF PDF Rendering interface
*
* TCPDF_Adapter provides a simple, stateless interface to TCPDF.
*
* Unless otherwise mentioned, all dimensions are in points (1/72 in).
* The coordinate origin is in the top left corner and y values
* increase downwards.
*
* See {@link http://tcpdf.sourceforge.net} for more information on
* the underlying TCPDF class.
*
* @package dompdf
*/
class TCPDF_Adapter implements Canvas {
/**
* Dimensions of paper sizes in points
*
* @var array;
*/
static public $PAPER_SIZES = array(); // Set to
// CPDF_Adapter::$PAPER_SIZES below.
/**
* Instance of the TCPDF class
*
* @var TCPDF
*/
private $_pdf;
/**
* PDF width in points
*
* @var float
*/
private $_width;
/**
* PDF height in points
*
* @var float
*/
private $_height;
/**
* Last fill colour used
*
* @var array
*/
private $_last_fill_color;
/**
* Last stroke colour used
*
* @var array
*/
private $_last_stroke_color;
/**
* Last line width used
*
* @var float
*/
private $_last_line_width;
/**
* Total number of pages
*
* @var int
*/
private $_page_count;
/**
* Text to display on every page
*
* @var array
*/
private $_page_text;
/**
* Array of pages for accessing after initial rendering is complete
*
* @var array
*/
private $_pages;
/**
* Class constructor
*
* @param mixed $paper The size of paper to use either a string (see {@link CPDF_Adapter::$PAPER_SIZES}) or
* an array(xmin,ymin,xmax,ymax)
* @param string $orientation The orientation of the document (either 'landscape' or 'portrait')
*/
function __construct($paper = "letter", $orientation = "portrait") {
if ( is_array($paper) )
$size = $paper;
else if ( isset(self::$PAPER_SIZES[mb_strtolower($paper)]) )
$size = self::$PAPER_SIZE[$paper];
else
$size = self::$PAPER_SIZE["letter"];
if ( mb_strtolower($orientation) === "landscape" ) {
$a = $size[3];
$size[3] = $size[2];
$size[2] = $a;
}
$this->_width = $size[2] - $size[0];
$this->_height = $size[3] - $size[1];
$this->_pdf = new TCPDF("P", "pt", array($this->_width, $this->_height));
$this->_pdf->Setcreator("DOMPDF Converter");
$this->_pdf->AddPage();
$this->_page_number = $this->_page_count = 1;
$this->_page_text = array();
$this->_last_fill_color =
$this->_last_stroke_color =
$this->_last_line_width = null;
}
/**
* Remaps y coords from 4th to 1st quadrant
*
* @param float $y
* @return float
*/
protected function y($y) { return $this->_height - $y; }
/**
* Sets the stroke colour
*
* @param array $color
*/
protected function _set_stroke_colour($colour) {
$colour[0] = round(255 * $colour[0]);
$colour[1] = round(255 * $colour[1]);
$colour[2] = round(255 * $colour[2]);
if ( is_null($this->_last_stroke_color) || $color != $this->_last_stroke_color ) {
$this->_pdf->SetDrawColor($color[0],$color[1],$color[2]);
$this->_last_stroke_color = $color;
}
}
/**
* Sets the fill colour
*
* @param array $color
*/
protected function _set_fill_colour($colour) {
$colour[0] = round(255 * $colour[0]);
$colour[1] = round(255 * $colour[1]);
$colour[2] = round(255 * $colour[2]);
if ( is_null($this->_last_fill_color) || $color != $this->_last_fill_color ) {
$this->_pdf->SetDrawColor($color[0],$color[1],$color[2]);
$this->_last_fill_color = $color;
}
}
/**
* Return the TCPDF instance
*
* @return TCPDF
*/
function get_tcpdf() { return $this->_pdf; }
/**
* Returns the current page number
*
* @return int
*/
function get_page_number() {
return $this->_page_number;
}
/**
* Returns the total number of pages
*
* @return int
*/
function get_page_count() {
return $this->_page_count;
}
/**
* Sets the total number of pages
*
* @param int $count
*/
function set_page_count($count) {
$this->_page_count = (int)$count;
}
/**
* Draws a line from x1,y1 to x2,y2
*
* See {@link Style::munge_colour()} for the format of the colour array.
* See {@link Cpdf::setLineStyle()} for a description of the format of the
* $style parameter (aka dash).
*
* @param float $x1
* @param float $y1
* @param float $x2
* @param float $y2
* @param array $color
* @param float $width
* @param array $style
*/
function line($x1, $y1, $x2, $y2, $color, $width, $style = null) {
if ( is_null($this->_last_line_width) || $width != $this->_last_line_width ) {
$this->_pdf->SetLineWidth($width);
$this->_last_line_width = $width;
}
$this->_set_stroke_colour($color);
// FIXME: ugh, need to handle different styles here
$this->_pdf->line($x1, $y1, $x2, $y2);
}
/**
* Draws a rectangle at x1,y1 with width w and height h
*
* See {@link Style::munge_colour()} for the format of the colour array.
* See {@link Cpdf::setLineStyle()} for a description of the $style
* parameter (aka dash)
*
* @param float $x1
* @param float $y1
* @param float $w
* @param float $h
* @param array $color
* @param float $width
* @param array $style
*/
function rectangle($x1, $y1, $w, $h, $color, $width, $style = null) {
if ( is_null($this->_last_line_width) || $width != $this->_last_line_width ) {
$this->_pdf->SetLineWidth($width);
$this->_last_line_width = $width;
}
$this->_set_stroke_colour($color);
// FIXME: ugh, need to handle styles here
$this->_pdf->rect($x1, $y1, $w, $h);
}
/**
* Draws a filled rectangle at x1,y1 with width w and height h
*
* See {@link Style::munge_colour()} for the format of the colour array.
*
* @param float $x1
* @param float $y1
* @param float $w
* @param float $h
* @param array $color
*/
function filled_rectangle($x1, $y1, $w, $h, $color) {
$this->_set_fill_colour($color);
// FIXME: ugh, need to handle styles here
$this->_pdf->rect($x1, $y1, $w, $h, "F");
}
/**
* Draws a polygon
*
* The polygon is formed by joining all the points stored in the $points
* array. $points has the following structure:
*
* array(0 => x1,
* 1 => y1,
* 2 => x2,
* 3 => y2,
* ...
* );
*
*
* See {@link Style::munge_colour()} for the format of the colour array.
* See {@link Cpdf::setLineStyle()} for a description of the $style
* parameter (aka dash)
*
* @param array $points
* @param array $color
* @param float $width
* @param array $style
* @param bool $fill Fills the polygon if true
*/
function polygon($points, $color, $width = null, $style = null, $fill = false) {
// FIXME: FPDF sucks
}
/**
* Draws a circle at $x,$y with radius $r
*
* See {@link Style::munge_colour()} for the format of the colour array.
* See {@link Cpdf::setLineStyle()} for a description of the $style
* parameter (aka dash)
*
* @param float $x
* @param float $y
* @param float $r
* @param array $color
* @param float $width
* @param array $style
* @param bool $fill Fills the circle if true
*/
function circle($x, $y, $r, $color, $width = null, $style = null, $fill = false){}
/**
* Add an image to the pdf.
*
* The image is placed at the specified x and y coordinates with the
* given width and height.
*
* @param string $img_url the path to the image
* @param string $img_type the type (e.g. extension) of the image
* @param float $x x position
* @param float $y y position
* @param int $w width (in pixels)
* @param int $h height (in pixels)
*/
function image($img_url, $img_type, $x, $y, $w, $h){}
/**
* Writes text at the specified x and y coordinates
*
* See {@link Style::munge_colour()} for the format of the colour array.
*
* @param float $x
* @param float $y
* @param string $text the text to write
* @param string $font the font file to use
* @param float $size the font size, in points
* @param array $color
* @param float $adjust word spacing adjustment
*/
function text($x, $y, $text, $font, $size, $color = array(0,0,0), $adjust = 0){}
function javascript($code){}
/**
* Add a named destination (similar to ... in html)
*
* @param string $anchorname The name of the named destination
*/
function add_named_dest($anchorname){}
/**
* Add a link to the pdf
*
* @param string $url The url to link to
* @param float $x The x position of the link
* @param float $y The y position of the link
* @param float $width The width of the link
* @param float $height The height of the link
*/
function add_link($url, $x, $y, $width, $height){}
/**
* Calculates text size, in points
*
* @param string $text the text to be sized
* @param string $font the desired font
* @param float $size the desired font size
* @param float $spacing word spacing, if any
* @return float
*/
function get_text_width($text, $font, $size, $spacing = 0){}
/**
* Calculates font height, in points
*
* @param string $font
* @param float $size
* @return float
*/
function get_font_height($font, $size){}
/**
* Starts a new page
*
* Subsequent drawing operations will appear on the new page.
*/
function new_page(){}
/**
* Streams the PDF directly to the browser
*
* @param string $filename the name of the PDF file
* @param array $options associative array, 'Attachment' => 0 or 1, 'compress' => 1 or 0
*/
function stream($filename, $options = null){}
/**
* Returns the PDF as a string
*
* @param array $options associative array: 'compress' => 1 or 0
* @return string
*/
function output($options = null){}
}
// Workaround for idiotic limitation on statics...
PDFLib_Adapter::$PAPER_SIZES = CPDF_Adapter::$PAPER_SIZES;