ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Pdf.php
Go to the documentation of this file.
1<?php
2
4
9
10abstract class Pdf extends Html
11{
17 protected $tempDir = '';
18
24 protected $font = 'freesans';
25
31 protected $orientation;
32
38 protected $paperSize;
39
45 protected static $paperSizes = [
46 PageSetup::PAPERSIZE_LETTER => 'LETTER', // (8.5 in. by 11 in.)
47 PageSetup::PAPERSIZE_LETTER_SMALL => 'LETTER', // (8.5 in. by 11 in.)
48 PageSetup::PAPERSIZE_TABLOID => [792.00, 1224.00], // (11 in. by 17 in.)
49 PageSetup::PAPERSIZE_LEDGER => [1224.00, 792.00], // (17 in. by 11 in.)
50 PageSetup::PAPERSIZE_LEGAL => 'LEGAL', // (8.5 in. by 14 in.)
51 PageSetup::PAPERSIZE_STATEMENT => [396.00, 612.00], // (5.5 in. by 8.5 in.)
52 PageSetup::PAPERSIZE_EXECUTIVE => 'EXECUTIVE', // (7.25 in. by 10.5 in.)
53 PageSetup::PAPERSIZE_A3 => 'A3', // (297 mm by 420 mm)
54 PageSetup::PAPERSIZE_A4 => 'A4', // (210 mm by 297 mm)
55 PageSetup::PAPERSIZE_A4_SMALL => 'A4', // (210 mm by 297 mm)
56 PageSetup::PAPERSIZE_A5 => 'A5', // (148 mm by 210 mm)
57 PageSetup::PAPERSIZE_B4 => 'B4', // (250 mm by 353 mm)
58 PageSetup::PAPERSIZE_B5 => 'B5', // (176 mm by 250 mm)
59 PageSetup::PAPERSIZE_FOLIO => 'FOLIO', // (8.5 in. by 13 in.)
60 PageSetup::PAPERSIZE_QUARTO => [609.45, 779.53], // (215 mm by 275 mm)
61 PageSetup::PAPERSIZE_STANDARD_1 => [720.00, 1008.00], // (10 in. by 14 in.)
62 PageSetup::PAPERSIZE_STANDARD_2 => [792.00, 1224.00], // (11 in. by 17 in.)
63 PageSetup::PAPERSIZE_NOTE => 'LETTER', // (8.5 in. by 11 in.)
64 PageSetup::PAPERSIZE_NO9_ENVELOPE => [279.00, 639.00], // (3.875 in. by 8.875 in.)
65 PageSetup::PAPERSIZE_NO10_ENVELOPE => [297.00, 684.00], // (4.125 in. by 9.5 in.)
66 PageSetup::PAPERSIZE_NO11_ENVELOPE => [324.00, 747.00], // (4.5 in. by 10.375 in.)
67 PageSetup::PAPERSIZE_NO12_ENVELOPE => [342.00, 792.00], // (4.75 in. by 11 in.)
68 PageSetup::PAPERSIZE_NO14_ENVELOPE => [360.00, 828.00], // (5 in. by 11.5 in.)
69 PageSetup::PAPERSIZE_C => [1224.00, 1584.00], // (17 in. by 22 in.)
70 PageSetup::PAPERSIZE_D => [1584.00, 2448.00], // (22 in. by 34 in.)
71 PageSetup::PAPERSIZE_E => [2448.00, 3168.00], // (34 in. by 44 in.)
72 PageSetup::PAPERSIZE_DL_ENVELOPE => [311.81, 623.62], // (110 mm by 220 mm)
73 PageSetup::PAPERSIZE_C5_ENVELOPE => 'C5', // (162 mm by 229 mm)
74 PageSetup::PAPERSIZE_C3_ENVELOPE => 'C3', // (324 mm by 458 mm)
75 PageSetup::PAPERSIZE_C4_ENVELOPE => 'C4', // (229 mm by 324 mm)
76 PageSetup::PAPERSIZE_C6_ENVELOPE => 'C6', // (114 mm by 162 mm)
77 PageSetup::PAPERSIZE_C65_ENVELOPE => [323.15, 649.13], // (114 mm by 229 mm)
78 PageSetup::PAPERSIZE_B4_ENVELOPE => 'B4', // (250 mm by 353 mm)
79 PageSetup::PAPERSIZE_B5_ENVELOPE => 'B5', // (176 mm by 250 mm)
80 PageSetup::PAPERSIZE_B6_ENVELOPE => [498.90, 354.33], // (176 mm by 125 mm)
81 PageSetup::PAPERSIZE_ITALY_ENVELOPE => [311.81, 651.97], // (110 mm by 230 mm)
82 PageSetup::PAPERSIZE_MONARCH_ENVELOPE => [279.00, 540.00], // (3.875 in. by 7.5 in.)
83 PageSetup::PAPERSIZE_6_3_4_ENVELOPE => [261.00, 468.00], // (3.625 in. by 6.5 in.)
84 PageSetup::PAPERSIZE_US_STANDARD_FANFOLD => [1071.00, 792.00], // (14.875 in. by 11 in.)
85 PageSetup::PAPERSIZE_GERMAN_STANDARD_FANFOLD => [612.00, 864.00], // (8.5 in. by 12 in.)
86 PageSetup::PAPERSIZE_GERMAN_LEGAL_FANFOLD => 'FOLIO', // (8.5 in. by 13 in.)
87 PageSetup::PAPERSIZE_ISO_B4 => 'B4', // (250 mm by 353 mm)
88 PageSetup::PAPERSIZE_JAPANESE_DOUBLE_POSTCARD => [566.93, 419.53], // (200 mm by 148 mm)
89 PageSetup::PAPERSIZE_STANDARD_PAPER_1 => [648.00, 792.00], // (9 in. by 11 in.)
90 PageSetup::PAPERSIZE_STANDARD_PAPER_2 => [720.00, 792.00], // (10 in. by 11 in.)
91 PageSetup::PAPERSIZE_STANDARD_PAPER_3 => [1080.00, 792.00], // (15 in. by 11 in.)
92 PageSetup::PAPERSIZE_INVITE_ENVELOPE => [623.62, 623.62], // (220 mm by 220 mm)
93 PageSetup::PAPERSIZE_LETTER_EXTRA_PAPER => [667.80, 864.00], // (9.275 in. by 12 in.)
94 PageSetup::PAPERSIZE_LEGAL_EXTRA_PAPER => [667.80, 1080.00], // (9.275 in. by 15 in.)
95 PageSetup::PAPERSIZE_TABLOID_EXTRA_PAPER => [841.68, 1296.00], // (11.69 in. by 18 in.)
96 PageSetup::PAPERSIZE_A4_EXTRA_PAPER => [668.98, 912.76], // (236 mm by 322 mm)
97 PageSetup::PAPERSIZE_LETTER_TRANSVERSE_PAPER => [595.80, 792.00], // (8.275 in. by 11 in.)
98 PageSetup::PAPERSIZE_A4_TRANSVERSE_PAPER => 'A4', // (210 mm by 297 mm)
99 PageSetup::PAPERSIZE_LETTER_EXTRA_TRANSVERSE_PAPER => [667.80, 864.00], // (9.275 in. by 12 in.)
100 PageSetup::PAPERSIZE_SUPERA_SUPERA_A4_PAPER => [643.46, 1009.13], // (227 mm by 356 mm)
101 PageSetup::PAPERSIZE_SUPERB_SUPERB_A3_PAPER => [864.57, 1380.47], // (305 mm by 487 mm)
102 PageSetup::PAPERSIZE_LETTER_PLUS_PAPER => [612.00, 913.68], // (8.5 in. by 12.69 in.)
103 PageSetup::PAPERSIZE_A4_PLUS_PAPER => [595.28, 935.43], // (210 mm by 330 mm)
104 PageSetup::PAPERSIZE_A5_TRANSVERSE_PAPER => 'A5', // (148 mm by 210 mm)
105 PageSetup::PAPERSIZE_JIS_B5_TRANSVERSE_PAPER => [515.91, 728.50], // (182 mm by 257 mm)
106 PageSetup::PAPERSIZE_A3_EXTRA_PAPER => [912.76, 1261.42], // (322 mm by 445 mm)
107 PageSetup::PAPERSIZE_A5_EXTRA_PAPER => [493.23, 666.14], // (174 mm by 235 mm)
108 PageSetup::PAPERSIZE_ISO_B5_EXTRA_PAPER => [569.76, 782.36], // (201 mm by 276 mm)
109 PageSetup::PAPERSIZE_A2_PAPER => 'A2', // (420 mm by 594 mm)
110 PageSetup::PAPERSIZE_A3_TRANSVERSE_PAPER => 'A3', // (297 mm by 420 mm)
111 PageSetup::PAPERSIZE_A3_EXTRA_TRANSVERSE_PAPER => [912.76, 1261.42], // (322 mm by 445 mm)
112 ];
113
120 {
121 parent::__construct($spreadsheet);
122 //$this->setUseInlineCss(true);
123 $this->tempDir = File::sysGetTempDir() . '/phpsppdf';
124 $this->isPdf = true;
125 }
126
132 public function getFont()
133 {
134 return $this->font;
135 }
136
148 public function setFont($fontName)
149 {
150 $this->font = $fontName;
151
152 return $this;
153 }
154
160 public function getPaperSize()
161 {
162 return $this->paperSize;
163 }
164
172 public function setPaperSize($pValue)
173 {
174 $this->paperSize = $pValue;
175
176 return $this;
177 }
178
184 public function getOrientation()
185 {
186 return $this->orientation;
187 }
188
196 public function setOrientation($pValue)
197 {
198 $this->orientation = $pValue;
199
200 return $this;
201 }
202
208 public function getTempDir()
209 {
210 return $this->tempDir;
211 }
212
220 public function setTempDir($pValue)
221 {
222 if (is_dir($pValue)) {
223 $this->tempDir = $pValue;
224 } else {
225 throw new WriterException("Directory does not exist: $pValue");
226 }
227
228 return $this;
229 }
230
238 protected function prepareForSave($pFilename)
239 {
240 // Open file
241 $this->openFileHandle($pFilename);
242
243 return $this->fileHandle;
244 }
245
249 protected function restoreStateAfterSave(): void
250 {
251 $this->maybeCloseFileHandle();
252 }
253}
An exception for terminatinating execution or to throw for unit testing.
static sysGetTempDir()
Get the systems temporary directory.
Definition: File.php:111
Paper size taken from Office Open XML Part 4 - Markup Language Reference, page 1988:.
Definition: PageSetup.php:81
openFileHandle($filename)
Open file handle.
Definition: BaseWriter.php:102
maybeCloseFileHandle()
Close file handle only if we opened it ourselves.
Definition: BaseWriter.php:123
setPaperSize($pValue)
Set Paper Size.
Definition: Pdf.php:172
getTempDir()
Get temporary storage directory.
Definition: Pdf.php:208
prepareForSave($pFilename)
Save Spreadsheet to PDF file, pre-save.
Definition: Pdf.php:238
setFont($fontName)
Set font.
Definition: Pdf.php:148
getPaperSize()
Get Paper Size.
Definition: Pdf.php:160
getOrientation()
Get Orientation.
Definition: Pdf.php:184
restoreStateAfterSave()
Save PhpSpreadsheet to PDF file, post-save.
Definition: Pdf.php:249
__construct(Spreadsheet $spreadsheet)
Create a new PDF Writer instance.
Definition: Pdf.php:119
setOrientation($pValue)
Set Orientation.
Definition: Pdf.php:196
setTempDir($pValue)
Set temporary storage directory.
Definition: Pdf.php:220