PDF używa takiej samej geometrii jak PostScript. Zaczyna z lewego dolnego rogu strony, a jednostka domyślnie jest wyrażana w punktach (1/72 cala).
Rozmiar strony może być pobrany z obiektu strony:
<?php $width = $pdfPage->getWidth(); $height = $pdfPage->getHeight();
PDF ma bardzo rozbudowane możliwości reprezentowania kolorów. Zend_Pdf
wspiera palety Grey Scale, RGB oraz CMYK. Każda z nich może być użyta
wszędzie, gdzie jest wymagany obiekt Zend_Pdf_Color
. Klasy
Zend_Pdf_Color_GrayScale
, Zend_Pdf_Color_Rgb
oraz
Zend_Pdf_Color_Cmyk
zapewniają taką funkcjonalność:
<?php // $grayLevel (liczba zmiennoprzecinkowa). 0.0 (czarny) - 1.0 (biały) $color1 = new Zend_Pdf_Color_GrayScale($grayLevel); // $r, $g, $b (liczby zmiennoprzecinkowe). 0.0 (minimalna intensywność) - 1.0 (maksymalna intensywność) $color2 = new Zend_Pdf_Color_Rgb($r, $g, $b); // $c, $m, $y, $k (liczby zmiennoprzecinkowe). 0.0 (minimalna intensywność) - 1.0 (maksymalna intensywność) $color3 = new Zend_Pdf_Color_Cmyk($c, $m, $y, $k);
Wszystkie operacje rysowania mogą być przeprowadzone w kontekście strony PDF.
Klasa Zend_Pdf_Page
zapewnia zestaw podstawowych operacji rysowania:
<?php /** * Rysuje linię z punktu x1,y1 do x2,y2. * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 */ public function drawLine($x1, $y1, $x2, $y2);
<?php /** * Rysuje prostokąt. * * Typy wypełnienia: * Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE - wypełnia i obramowuje prostokąt (domyślnie) * Zend_Pdf_Page::SHAPE_DRAW_STROKE - obramowuje prostokąt * Zend_Pdf_Page::SHAPE_DRAW_FILL - wypełnia prostokąt * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 * @param integer $fillType */ public function drawRectangle($x1, $y1, $x2, $y2, $fillType = Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE);
<?php /** * Rysuje wielokąt. * * Jeśli $fillType ma wartość Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE lub Zend_Pdf_Page::SHAPE_DRAW_FILL, * wtedy wielokąt jest automatycznie zamknięty. * Zobacz szczegółową dokumentację tych metod w dokumentacji PDF * (sekcja 4.4.2 Path painting Operators, Filling) * * @param array $x - array of float (the X co-ordinates of the vertices) * @param array $y - array of float (the Y co-ordinates of the vertices) * @param integer $fillType * @param integer $fillMethod */ public function drawPolygon($x, $y, $fillType = Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE, $fillMethod = Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING);
<?php /** * Rysuje okrąg o środku w punkcie $x, $y o promieniu $radius. * * Kąty są określane w radianach. * * Sygnatury metod: * drawCircle($x, $y, $radius); * drawCircle($x, $y, $radius, $fillType); * drawCircle($x, $y, $radius, $startAngle, $endAngle); * drawCircle($x, $y, $radius, $startAngle, $endAngle, $fillType); * * * Nie jest to do końca okrąg, ponieważ PDF obsługuje jedynie kubiczne krzywe Beziera. * Ale jest to bardzo dobre przybliżenie. * Różni się od realnego okręgu maksymalnie o 0.00026 promienia * (przy kątach PI/8, 3*PI/8, 5*PI/8, 7*PI/8, 9*PI/8, 11*PI/8, 13*PI/8 oraz 15*PI/8). * Przy kątach 0, PI/4, PI/2, 3*PI/4, PI, 5*PI/4, 3*PI/2 oraz 7*PI/4 jest to dokładny okrąg. * * @param float $x * @param float $y * @param float $radius * @param mixed $param4 * @param mixed $param5 * @param mixed $param6 */ public function drawCircle($x, $y, $radius, $param4 = null, $param5 = null, $param6 = null);
<?php /** * Rysuje elipsę wewnątrz określonego prostokąta. * * Sygnatury metod: * drawEllipse($x1, $y1, $x2, $y2); * drawEllipse($x1, $y1, $x2, $y2, $fillType); * drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle); * drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle, $fillType); * * Kąty są określane w radianach * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 * @param mixed $param5 * @param mixed $param6 * @param mixed $param7 */ public function drawEllipse($x1, $y1, $x2, $y2, $param5 = null, $param6 = null, $param7 = null);
Operacje wypisywania tekstu także są przeprowadzone w kontekście strony PDF Możesz wypisać pojedynczą linię tekstu w dowolnym miejscu na stronie podając współrzędne x oraz y linii bazowej. W operacjach wypisywania tekstu używana jest czcionka o aktualnie ustawionym kroju oraz rozmiarze (zobacz poniżej szczegółowy opis).
<?php /** * Wypisuje linię tekstu w określonym miejscu. * * @param string $text * @param float $x * @param float $y * @param string $charEncoding (opcjonalny) Kodowanie znaków tekstu. * Domyślnie według ustawień lokalizacji. * @throws Zend_Pdf_Exception */ public function drawText($text, $x, $y, $charEncoding = '');
Przykład 24.5. Wypisywanie tekstu na stronie.
<?php ... $pdfPage->drawText('Hello world!', 72, 720); ... ?>
Domyślnie, łańcuchy znaków są interpretowane przy użyciu metod kodowania
znaków biężacych ustawień lokalnych. Jeśli masz łańcuch znaków używający
innych metod kodowania (na przykład dane jako łańcuch znaków UTF-8 odczytany
z pliku na dysku, lub łańcuch znaków MacRoman pobrany z bazy danych),
możesz wskazać kodowanie znaków podczas wypisywania tekstu i Zend_Pdf
przeprowadzi dla ciebie konwersję. Możesz użyć źródłowego łańcucha znaków
w dowolnym kodowaniu obsługiwanym przez funkcję PHP iconv()
:
Metoda Zend_Pdf_Page::drawText()
używa bieżącego kroju
oraz rozmiaru czcionki dla strony, które ustawia się za pomocą metody
Zend_Pdf_Page::setFont()
:
<?php /** * Ustawia bieżącą czcionkę. * * @param Zend_Pdf_Resource_Font $font * @param float $fontSize */ public function setFont(Zend_Pdf_Resource_Font $font, $fontSize);
Dokumenty PDF obsługują czionki PostScript Type 1 oraz TrueType, tak samo dobrze jak dwa wyspecjalizowane typy PDF, Type 3 oraz czcionki złożone Type 0. Jest także 14 standardowych czcionek Type 1 wbudowanych w każdą przeglądarkę PDF: Courier (4 style), Helvetica (4 style), Times (4 style), Symbol, and Zapf Dingbats.
Zend_Pdf obecnie obsługuje 14 standardowych czcionek PDF tak samo dobrze
jak twoje własne czcionki TrueType. Obiekty czcionek są obsługiwane za pomocą
jednej z dwóch metod fabryk: Zend_Pdf_Font::fontWithName($fontName)
dla 14 standardowych czcionek PDF lub Zend_Pdf_Font::fontWithPath($filePath)
dla własnych czcionek.
Przykład 24.7. Tworzenie standardowej czcionki.
<?php ... // Utwórz nową czcionkę $font = Zend_Pdf_Font::fontWithName(Zend_Pdf_Font::FONT_HELVETICA); // Ustaw czcionkę $pdfPage->setFont($font, 36); ... ?>
Stałe dla nazwa 14 standardowych czcionek PDF są zdefiniowane w klasie Zend_Pdf_Font
:
Zend_Pdf_Font::FONT_COURIER
Zend_Pdf_Font::FONT_COURIER_BOLD
Zend_Pdf_Font::FONT_COURIER_ITALIC
Zend_Pdf_Font::FONT_COURIER_BOLD_ITALIC
Zend_Pdf_Font::FONT_TIMES
Zend_Pdf_Font::FONT_TIMES_BOLD
Zend_Pdf_Font::FONT_TIMES_ITALIC
Zend_Pdf_Font::FONT_TIMES_BOLD_ITALIC
Zend_Pdf_Font::FONT_HELVETICA
Zend_Pdf_Font::FONT_HELVETICA_BOLD
Zend_Pdf_Font::FONT_HELVETICA_ITALIC
Zend_Pdf_Font::FONT_HELVETICA_BOLD_ITALIC
Zend_Pdf_Font::FONT_SYMBOL
Zend_Pdf_Font::FONT_ZAPFDINGBATS
Możesz także użyć dowolnej czcionki TrueType (która najcześciej ma rozszerzenie '.ttf') lub czcionki OpenType (rozszerzenie '.otf') jeśli zawiera czcionke zrobioną według wytycznych TrueType. Obecnie nieobsługiwane, ale planowane w przyszłych wersjach są pliki czcionek Mac OS X .dfont oraz pliki Microsoft TrueType Collection (rozszerzenie '.ttc').
Aby użyć czcionki TrueType, musisz podać pełną ścieżke do pliku czcionki. Jeśli z jakiegoś powodu nie może on być odczytany, lub nie jest to czcionka TrueType, metoda fabryki wyrzuci wyjątek:
Przykład 24.8. Tworzenie czcionki TrueType.
<?php ... // Utwórz nową czcionkę $goodDogCoolFont = Zend_Pdf_Font::fontWithPath('/path/to/GOODDC__.TTF'); // Ustaw czcionkę $pdfPage->setFont($goodDogCoolFont, 36); ... ?>
Domyślnie własne czcionki będą osadzone w wynikowym dokumencie PDF. To pozwala odbiorcom oglądać stronę taką, jaka była zamierzona, nawet gdy nie mają zainstalowanych w systemie potrzebnych czcionek. Jeśli ważny jest dla ciebie rozmiar pliku, możesz zażądać, aby plik czcionki nie był osadzony przekazując opcję 'nie osadzaj' do metody fabryki:
Przykład 24.9. Tworzenie czcionki TrueType, ale bez osadzania jej w dokumencie PDF.
<?php ... // Utwórz nową czcionkę $goodDogCoolFont = Zend_Pdf_Font::fontWithPath('/path/to/GOODDC__.TTF', Zend_Pdf_Font::EMBED_DONT_EMBED); // Ustaw czcionkę $pdfPage->setFont($goodDogCoolFont, 36); ... ?>
Jeśli plik czcionki nie jest osadzony, ale odbiorca pliku PDF posiada taką czcionkę zainstalowaną w swoim systemie, zobaczy on dokument w sposób identyczny z zamierzonym. Jeśli nie ma zainstalowanej odpowiedniej czcionki, przeglądarka PDF użyje najlepszej aby zastąpić czcionkę.
Niektóre czcionki mają bardzo specyficzne zasady licencjonowania, które uniemożliwiają osadzenie ich w dokumentach PDF. Także nie złamiesz tych zasad, ponieważ gdy spróbujesz użyć czcionkę, która nie może być osadzona metoda fabryki wyrzuci wyjątek.
Możesz wciąż użyć tych czcionek, ale musisz przekazać odpowiedni parametr w celu nieosadzenia czcionki, lub w prosty sposób zignorować wyjątek:
Przykład 24.10. Nie wyrzucanie wyjątku dla czcionek które nie mogą być osadzone.
<?php ... $font = Zend_Pdf_Font::fontWithPath('/path/to/unEmbeddableFont.ttf', Zend_Pdf_Font::EMBED_SUPPRESS_EMBED_EXCEPTION); ... ?>
Ta technika zignorowania wyjątku jest przydatna, gdy pozwalasz użytkownikowi końcowemu wybierać własne czcionki. Czcionki, ktore mogą być osadzone, będą osadzone w dokumencie PDF; te które nie mogą, nie będą.
Pliki czcionek mogą być duże, czasem osiągająć dziesiątki megabajtów. Domyślnie wszystkie osadzane czcionki są kompresowane przy użyciu schematu kompresji Flate, co powoduje zaoszczędzenie średnio 50% miejsca. Jeśli z jakiegoś powodu nie chcesz kompresować plików czcionek, możesz to zablokować opcją:
Przykład 24.11. Nie kompresowanie osadzonych czcionek.
<?php ... $font = Zend_Pdf_Font::fontWithPath('/path/to/someReallyBigFont.ttf', Zend_Pdf_Font::EMBED_DONT_COMPRESS); ... ?>
Ostatecznie, jeśli potrzebujesz, możesz łączyć opcje osadzania czcionek używając bitowego operatora LUB:
Klasa Zend_Pdf_Page
zapewnia metodę drawImage() do wstawiania
obrazów:
<?php /** * Wstawia obraz w określonym miejscu na stronie. * * @param Zend_Pdf_Resource_Image $image * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 */ public function drawImage(Zend_Pdf_Resource_Image $image, $x1, $y1, $x2, $y2);
Obiekty obrazów powinny być tworzone za pomocą metody
Zend_Pdf_Image::imageWithPath($filePath)
(obecnie
obsługiwane są obrazy JPG, PNG oraz TIFF):
Przykład 24.13. Wstawianie obrazów.
<?php ... // łądujemy obraz $image = Zend_Pdf_Image::imageWithPath('my_image.jpg'); $pdfPage->drawImage($image, 100, 100, 400, 300); ... ?>
Ważne! Obsługa JPEG wymaga rozszerzenia PHP GD. Ważne! Obsługa PNG wymaga rozszerzenia ZLIB skonfigurowanego do obsługi obrazów z kanałem Alpha.
Sprawdź dokumentację PHP aby znaleźć bardziej szczegółowe informacje. (http://www.php.net/manual/en/ref.image.php). (http://www.php.net/manual/en/ref.zlib.php).
Styl rysowania linii jest zdefiniowany przez grubość, kolor linii oraz
ozdobny wzór linii. Wszystkie te parametry mogą być zdefiniowane za pomocą
metod klasy Zend_Pdf_Page
:
<?php /** Ustaw kolor linii. */ public function setLineColor(Zend_Pdf_Color $color); /** Ustaw grubość linii. */ public function setLineWidth(float $width); /** * Ustawia ozdobny wzór linii. * * Wzór jest tablicą liczb zmiennoprzecinkowych: array(dlugosc_on, dlugosc_off, dlugosc_on, dlugosc_off, ...) * Faza jest przesunięciem od początku linii. * * @param array $pattern * @param array $phase */ public function setLineDashingPattern($pattern, $phase = 0);
Metody Zend_Pdf_Page::drawRectangle()
, Zend_Pdf_Page::drawPoligon()
,
Zend_Pdf_Page::drawCircle()
oraz Zend_Pdf_Page::drawEllipse()
przyjmują argument $fillType
jako opcjonalny parametr. Może
on mieć wartość:
Zend_Pdf_Page::SHAPE_DRAW_STROKE - obrysowuje figurę
Zend_Pdf_Page::SHAPE_DRAW_FILL - tylko wypełnia
Zend_Pdf_Page::SHAPE_DRAW_FILL_AND_STROKE - obrysowuje i wypełnia (domyślnie)
Metoda Zend_Pdf_Page::drawPoligon()
przyjmuje także dodatkowy
parametr $fillMethod
:
Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING (domyślnie)
Dokumentacja PDF opisuje tą zasadę w ten sposób:
Zasada nonzero winding number określa whether a given point is inside a path by conceptually drawing a ray from that point to infinity in any direction and then examining the places where a segment of the path crosses the ray. Starting with a count of 0, the rule adds 1 each time a path segment crosses the ray from left to right and subtracts 1 each time a segment crosses from right to left. After counting all the crossings, if the result is 0 then the point is outside the path; otherwise it is inside. Nota: Opisana właśnie metoda nie określa what to do if a path segment coincides with or is tangent to the chosen ray. Since the direction of the ray is arbitrary, the rule simply chooses a ray that does not encounter such problem intersections. For simple convex paths, the nonzero winding number rule defines the inside and outside as one would intuitively expect. The more interesting cases are those involving complex or self-intersecting paths like the ones shown in Figure 4.10 (w dokumentacji PDF). For a path consisting of a five-pointed star, drawn with five connected straight line segments intersecting each other, the rule considers the inside to be the entire area enclosed by the star, including the pentagon in the center. For a path composed of two concentric circles, the areas enclosed by both circles are considered to be inside, provided that both are drawn in the same direction. If the circles are drawn in opposite directions, only the "doughnut" shape between them is inside, according to the rule; the "doughnut hole" is outside.
Zend_Pdf_Page::FILL_METHOD_EVEN_ODD
Dokumentacja PDF opisuje tą zasadę w ten sposób:
An alternative to the nonzero winding number rule is the even-odd rule. This rule determines the "insideness" of a point by drawing a ray from that point in any direction and simply counting the number of path segments that cross the ray, regardless of direction. If this number is odd, the point is inside; if even, the point is outside. This yields the same results as the nonzero winding number rule for paths with simple shapes, but produces different results for more complex shapes. Figure 4.11 (w dokumentacji PDF) shows the effects of applying the even-odd rule to complex paths. For the five-pointed star, the rule considers the triangular points to be inside the path, but not the pentagon in the center. For the two concentric circles, only the "doughnut" shape between the two circles is considered inside, regardless of the directions in which the circles are drawn.
Strony PDF mogą być obracane zanim zostaną wykonane jakiekolwiek
operacje rysowania. Może być to zrobione za pomocą metody
Zend_Pdf_Page::rotate()
:
<?php /** * Obraca stronę dookoła punktu ($x, $y) o określony kąt (w radianach). * * @param float $angle */ public function rotate($x, $y, $angle);
W dowolnej chwili stan grafiki (bieżąca czcionka, rozmiar czcionki, kolor linii, kolor wypełnienia, styl linii, obrót strony, obszar przycinania) może być zapisany a potem przywrócony. Operacja zapisu zapisuje dane na stos stanu grafiki, operacja przywrócenia przywraca je ze stosu.
Są dwie metody w klasie Zend_Pdf_Page
do tych operacji:
<?php /** * Zapisuje stan grafiki danej strony. * Zapisuje obecny styl, pozycję, obszar przycinania oraz * ewetualny obrót/translację/skalowanie które są zastosowane. */ public function saveGS(); /** * Przywraca stan grafiki który był zapisany ostatnim wywołaniem metody saveGS(). */ public function restoreGS();
PDF oraz moduł Zend_Pdf obsługują przycięcie obszaru rysowania. Obecny przycięty obszar ogranicza obszar strony, na który wpływają operacje rysowania. Na początku jest to cała strona.
Klasa Zend_Pdf_Page
zapewnia zestaw metod dla operacji przycinania.
<?php /** * Przycięcie obszaru za pomocą prostokąta. * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 */ public function clipRectangle($x1, $y1, $x2, $y2);
<?php /** * Przycięcie obszaru za pomocą wielokąta. * * @param array $x - tablica wartości zmiennoprzecinkowych (współrzędne X) * @param array $y - tablica wartości zmiennoprzecinkowych (współrzędne Y) * @param integer $fillMethod */ public function clipPolygon($x, $y, $fillMethod = Zend_Pdf_Page::FILL_METHOD_NON_ZERO_WINDING);
<?php /** * Przycięcie obszaru za pomocą okręgu. * * @param float $x * @param float $y * @param float $radius * @param float $startAngle * @param float $endAngle */ public function clipCircle($x, $y, $radius, $startAngle = null, $endAngle = null);
<?php /** * Przycięcie obszaru za pomocą elipsy. * * Sygnatury metod: * drawEllipse($x1, $y1, $x2, $y2); * drawEllipse($x1, $y1, $x2, $y2, $startAngle, $endAngle); * * @todo obsłużyć przypadki gdy $x2-$x1 == 0 lub $y2-$y1 == 0 * * @param float $x1 * @param float $y1 * @param float $x2 * @param float $y2 * @param float $startAngle * @param float $endAngle */ public function clipEllipse($x1, $y1, $x2, $y2, $startAngle = null, $endAngle = null);
Klasa Zend_Pdf_Style
zapewnia funkcjonalność styli.
Styles mogą być użyte w celu przechowania zestawu parametrów stanu grafiki i następnie zastosowania go na stronie PDF za pomocą jednej operacji:
<?php /** * Ustawia styl dla przyszłych operacji rysowania na tej stronie * * @param Zend_Pdf_Style $style */ public function setStyle(Zend_Pdf_Style $style); /** * Zwraca styl zastosowany dla strony. * * @return Zend_Pdf_Style|null */ public function getStyle();
Klasa Zend_Pdf_Style
zapewnia zestaw metod do ustawiania oraz pobierania różnych parametrów stanu grafiki:
<?php /** * Ustawia kolor linii. * * @param Zend_Pdf_Color $color */ public function setLineColor(Zend_Pdf_Color $color);
<?php /** * Pobiera kolor linii. * * @return Zend_Pdf_Color|null */ public function getLineColor();
<?php /** * Ustawia grubość linii. * * @param float $width */ public function setLineWidth($width);
<?php /** * Pobiera grubość linii. * * @return float */ public function getLineWidth();
<?php /** * Ustawia ozdobny wzór linii * * @param array $pattern * @param float $phase */ public function setLineDashingPattern($pattern, $phase = 0);
<?php /** * Pobiera ozdobny wzór linii * * @return array */ public function getLineDashingPattern();
<?php /** * Pobiera okres ozdobnej fazy. * * @return float */ public function getLineDashingPhase();
<?php /** * Ustawia kolor wypełnienia. * * @param Zend_Pdf_Color $color */ public function setFillColor(Zend_Pdf_Color $color);
<?php /** * Pobiera kolor wypełnienia. * * @return Zend_Pdf_Color|null */ public function getFillColor();
<?php /** * Ustawia bieżącą czcionkę. * * @param Zend_Pdf_Resource_Font $font * @param float $fontSize */ public function setFont(Zend_Pdf_Resource_Font $font, $fontSize);
<?php /** * Zmienia rozmiar bieżącej czcionki * * @param float $fontSize */ public function setFontSize($fontSize);
<?php /** * Pobiera bieżącą czcionkę. * * @return Zend_Pdf_Resource_Font $font */ public function getFont();
<?php /** * Pobiera rozmiar bieżącej czcionki * * @return float $fontSize */ public function getFontSize();