Feature: Labelprint für Kistenetiketten hinzugefügt

This commit is contained in:
2025-10-27 12:14:44 +01:00
parent 43bc416554
commit 14bae6c9ef
1068 changed files with 229014 additions and 1807 deletions

View File

@@ -0,0 +1,392 @@
<?php
/**
* Box.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
use Com\Tecnick\Color\Pdf as Color;
use Com\Tecnick\Pdf\Page\Exception as PageException;
/**
* Com\Tecnick\Pdf\Page\Box
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* @phpstan-type PageBci array{
* 'color': string,
* 'width': float,
* 'style': string,
* 'dash': array<int>,
* }
*
* @phpstan-type PageBox array{
* 'llx': float,
* 'lly': float,
* 'urx': float,
* 'ury': float,
* 'bci'?: PageBci,
* }
*
* @phpstan-type MarginData array{
* 'CB': float,
* 'CT': float,
* 'FT': float,
* 'HB': float,
* 'PB': float,
* 'PL': float,
* 'PR': float,
* 'PT': float,
* }
*
* @phpstan-type RegionData array{
* 'RB': float,
* 'RH': float,
* 'RL': float,
* 'RR': float,
* 'RT': float,
* 'RW': float,
* 'RX': float,
* 'RY': float,
* 'x' : float,
* 'y' : float,
* }
*
* @phpstan-type TransitionData array{
* 'B': bool,
* 'D': int,
* 'Di': string|int,
* 'Dm': string,
* 'Dur': float,
* 'M': string,
* 'S': string,
* 'SS': float,
* }
*
* @phpstan-type PageData array{
* 'annotrefs': array<int,int>,
* 'autobreak': bool,
* 'box': array<string, array{
* 'llx': float,
* 'lly': float,
* 'urx': float,
* 'ury': float,
* 'bci': PageBci,
* }>,
* 'columns': int,
* 'content': array<string>,
* 'content_mark': array<int>,
* 'ContentHeight': float,
* 'ContentWidth': float,
* 'FooterHeight': float,
* 'HeaderHeight': float,
* 'currentRegion': int,
* 'format': string,
* 'group': int,
* 'height': float,
* 'margin': MarginData,
* 'n': int,
* 'num': int,
* 'orientation': string,
* 'pagenum': int,
* 'pheight': float,
* 'pid': int,
* 'pwidth': float,
* 'region': array<int, RegionData>,
* 'rotation': int,
* 'time': int,
* 'transition': TransitionData,
* 'width': float,
* 'zoom': float,
* }
*
* @phpstan-type PageInputData array{
* 'annotrefs'?: array<int,int>,
* 'autobreak'?: bool,
* 'box'?: array<string, array{
* 'llx'?: float,
* 'lly'?: float,
* 'urx'?: float,
* 'ury'?: float,
* 'bci'?: array{
* 'color'?: string,
* 'width'?: float,
* 'style'?: string,
* 'dash'?: array<int>,
* },
* }>,
* 'columns'?: int,
* 'content'?: array<string>,
* 'content_mark'?: array<int>,
* 'ContentHeight'?: float,
* 'ContentWidth'?: float,
* 'FooterHeight'?: float,
* 'HeaderHeight'?: float,
* 'currentRegion'?: int,
* 'format'?: string,
* 'group'?: int,
* 'height'?: float,
* 'margin'?: array{
* 'booklet'?: bool,
* 'CB'?: float,
* 'CT'?: float,
* 'FT'?: float,
* 'HB'?: float,
* 'PB'?: float,
* 'PL'?: float,
* 'PR'?: float,
* 'PT'?: float,
* },
* 'n'?: int,
* 'num'?: int,
* 'orientation'?: string,
* 'pagenum'?: int,
* 'pheight'?: float,
* 'pid'?: int,
* 'pwidth'?: float,
* 'region'?: array<int, array{
* 'RB'?: float,
* 'RH'?: float,
* 'RL'?: float,
* 'RR'?: float,
* 'RT'?: float,
* 'RW'?: float,
* 'RX'?: float,
* 'RY'?: float,
* 'x' ?: float,
* 'y' ?: float,
* }>,
* 'rotation'?: int,
* 'time'?: int,
* 'transition'?: array{
* 'B'?: bool,
* 'D'?: int,
* 'Di'?: string|int,
* 'Dm'?: string,
* 'Dur'?: float,
* 'M'?: string,
* 'S'?: string,
* 'SS'?: float,
* },
* 'width'?: float,
* 'zoom'?: float,
* }
*/
abstract class Box extends \Com\Tecnick\Pdf\Page\Mode
{
/**
* Unit of measure conversion ratio.
*/
protected float $kunit = 1.0;
/**
* Color object.
*/
protected Color $col;
/**
* Page box names.
*
* @var array<string>
*/
public const BOX = [
'MediaBox',
'CropBox',
'BleedBox',
'TrimBox',
'ArtBox',
];
/**
* Swap X and Y coordinates of page boxes (change page boxes orientation).
*
* @param array<string, PageBox> $dims Array of page dimensions.
*
* @return array<string, PageBox> Page dimensions.
*/
public function swapCoordinates(array $dims): array
{
foreach (self::BOX as $type) {
// swap X and Y coordinates
if (isset($dims[$type])) {
$tmp = $dims[$type]['llx'];
$dims[$type]['llx'] = $dims[$type]['lly'];
$dims[$type]['lly'] = $tmp;
$tmp = $dims[$type]['urx'];
$dims[$type]['urx'] = $dims[$type]['ury'];
$dims[$type]['ury'] = $tmp;
}
}
return $dims;
}
/**
* Set page boundaries.
*
* @param array<string, PageBox> $dims Array of page dimensions to modify.
* @param string $type Box type: MediaBox, CropBox, BleedBox, TrimBox, ArtBox.
* @param float $llx Lower-left x coordinate in user units.
* @param float $lly Lower-left y coordinate in user units.
* @param float $urx Upper-right x coordinate in user units.
* @param float $ury Upper-right y coordinate in user units.
* @param PageBci $bci BoxColorInfo: guideline style (color, width, style, dash).
*
* @return array<string, PageBox> Page dimensions.
*/
public function setBox(
array $dims,
string $type,
float $llx,
float $lly,
float $urx,
float $ury,
?array $bci = null,
): array {
if ($dims === []) {
// initialize array
$dims = [];
}
if (! in_array($type, self::BOX)) {
throw new PageException('unknown page box type: ' . $type);
}
$dims[$type]['llx'] = $llx;
$dims[$type]['lly'] = $lly;
$dims[$type]['urx'] = $urx;
$dims[$type]['ury'] = $ury;
if ($bci === null) {
// set default values
$bci = [
'color' => '#000000',
'width' => (1.0 / $this->kunit),
'style' => 'S', // S = solid; D = dash
'dash' => [3],
];
}
$dims[$type]['bci'] = $bci;
return $dims;
}
/**
* Initialize page boxes.
*
* @param float $width Page width in points.
* @param float $height Page height in points.
*
* @return array<string, PageBox> Page boxes.
*/
public function setPageBoxes(float $width, float $height): array
{
$dims = [];
foreach (self::BOX as $type) {
$dims = $this->setBox($dims, $type, 0, 0, $width, $height);
}
return $dims;
}
/**
* Returns the PDF command to output the specified page boxes.
*
* @param array<string, array{
* 'llx': float,
* 'lly': float,
* 'urx': float,
* 'ury': float,
* }> $dims Array of page dimensions.
*/
protected function getBox(array $dims): string
{
$out = '';
foreach (self::BOX as $box) {
if (empty($dims[$box])) {
// @codeCoverageIgnoreStart
continue;
// @codeCoverageIgnoreEnd
}
$out .= '/' . $box . ' [' . sprintf(
'%F %F %F %F',
$dims[$box]['llx'],
$dims[$box]['lly'],
$dims[$box]['urx'],
$dims[$box]['ury']
) . ']' . "\n";
}
return $out;
}
/**
* Returns the PDF command to output the specified page BoxColorInfo.
*
* @param array<string, array{
* 'bci': PageBci,
* }> $dims Array of page dimensions.
*
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
*/
protected function getBoxColorInfo(array $dims): string
{
$out = '/BoxColorInfo <<' . "\n";
foreach (self::BOX as $box) {
if (empty($dims[$box])) {
continue;
}
$out .= '/' . $box . ' <<' . "\n";
if (! empty($dims[$box]['bci']['color'])) {
$out .= '/C [' . $this->col->getPdfRgbComponents($dims[$box]['bci']['color']) . ']' . "\n";
}
if (! empty($dims[$box]['bci']['width'])) {
$out .= '/W ' . sprintf('%F', ($dims[$box]['bci']['width'] * $this->kunit)) . "\n";
}
if (! empty($dims[$box]['bci']['style'])) {
$mode = strtoupper($dims[$box]['bci']['style'][0]);
if ($mode !== 'D') {
$mode = 'S';
}
$out .= '/S /' . $mode . "\n";
}
if (! empty($dims[$box]['bci']['dash'])) {
$out .= '/D [';
foreach ($dims[$box]['bci']['dash'] as $dash) {
$out .= sprintf(' %F', ((float) $dash * $this->kunit));
}
$out .= ' ]' . "\n";
}
$out .= '>>' . "\n";
}
return $out . ('>>' . "\n");
}
}

View File

@@ -0,0 +1,34 @@
<?php
/**
* Exception.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
/**
* Com\Tecnick\Pdf\Page\Exception
*
* Custom Exception class.
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*/
class Exception extends \Exception
{
}

View File

@@ -0,0 +1,574 @@
<?php
/**
* Format.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
use Com\Tecnick\Pdf\Page\Exception as PageException;
/**
* Com\Tecnick\Pdf\Page\Format
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*/
abstract class Format
{
/**
* Array of conversion ratios relative to points.
* 72 is the default DPI (Dot Per Inch) document resolution.
*
* @var array<string, float>
*/
public const UNITRATIO = [
'' => 1.0, // default to points
'px' => 1.0,
'pt' => 1.0,
'points' => 1.0,
'millimeters' => 2.83464566929134, // (72 / 25.4)
'mm' => 2.83464566929134, // (72 / 25.4)
'centimeters' => 28.3464566929134, // (72 / 2.54)
'cm' => 28.3464566929134, // (72 / 2.54)
'inches' => 72.0,
'in' => 72.0,
];
/**
* Array of page formats (width, height).
* Measures are calculated in this way: (inches * 72) or (millimeters * 72 / 25.4)
*
* @var array<string, array{0:float, 1:float}>
*/
public const FORMAT = [
// ISO 216 A Series + 2 SIS 014711 extensions
'A0' => [2383.937, 3370.394], // = ( 841 x 1189 ) mm = ( 33.11 x 46.81 ) in
'A1' => [1683.780, 2383.937], // = ( 594 x 841 ) mm = ( 23.39 x 33.11 ) in
'A2' => [1190.551, 1683.780], // = ( 420 x 594 ) mm = ( 16.54 x 23.39 ) in
'A3' => [841.890, 1190.551], // = ( 297 x 420 ) mm = ( 11.69 x 16.54 ) in
'A4' => [595.276, 841.890], // = ( 210 x 297 ) mm = ( 8.27 x 11.69 ) in
'A5' => [419.528, 595.276], // = ( 148 x 210 ) mm = ( 5.83 x 8.27 ) in
'A6' => [297.638, 419.528], // = ( 105 x 148 ) mm = ( 4.13 x 5.83 ) in
'A7' => [209.764, 297.638], // = ( 74 x 105 ) mm = ( 2.91 x 4.13 ) in
'A8' => [147.402, 209.764], // = ( 52 x 74 ) mm = ( 2.05 x 2.91 ) in
'A9' => [104.882, 147.402], // = ( 37 x 52 ) mm = ( 1.46 x 2.05 ) in
'A10' => [73.701, 104.882], // = ( 26 x 37 ) mm = ( 1.02 x 1.46 ) in
'A11' => [51.024, 73.701], // = ( 18 x 26 ) mm = ( 0.71 x 1.02 ) in
'A12' => [36.850, 51.024], // = ( 13 x 18 ) mm = ( 0.51 x 0.71 ) in
// ISO 216 B Series + 2 SIS 014711 extensions
'B0' => [2834.646, 4008.189], // = ( 1000 x 1414 ) mm = ( 39.37 x 55.67 ) in
'B1' => [2004.094, 2834.646], // = ( 707 x 1000 ) mm = ( 27.83 x 39.37 ) in
'B2' => [1417.323, 2004.094], // = ( 500 x 707 ) mm = ( 19.69 x 27.83 ) in
'B3' => [1000.630, 1417.323], // = ( 353 x 500 ) mm = ( 13.90 x 19.69 ) in
'B4' => [708.661, 1000.630], // = ( 250 x 353 ) mm = ( 9.84 x 13.90 ) in
'B5' => [498.898, 708.661], // = ( 176 x 250 ) mm = ( 6.93 x 9.84 ) in
'B6' => [354.331, 498.898], // = ( 125 x 176 ) mm = ( 4.92 x 6.93 ) in
'B7' => [249.449, 354.331], // = ( 88 x 125 ) mm = ( 3.46 x 4.92 ) in
'B8' => [175.748, 249.449], // = ( 62 x 88 ) mm = ( 2.44 x 3.46 ) in
'B9' => [124.724, 175.748], // = ( 44 x 62 ) mm = ( 1.73 x 2.44 ) in
'B10' => [87.874, 124.724], // = ( 31 x 44 ) mm = ( 1.22 x 1.73 ) in
'B11' => [62.362, 87.874], // = ( 22 x 31 ) mm = ( 0.87 x 1.22 ) in
'B12' => [42.520, 62.362], // = ( 15 x 22 ) mm = ( 0.59 x 0.87 ) in
// ISO 216 C Series + 2 SIS 014711 extensions + 5 EXTENSION
'C0' => [2599.370, 3676.535], // = ( 917 x 1297 ) mm = ( 36.10 x 51.06 ) in
'C1' => [1836.850, 2599.370], // = ( 648 x 917 ) mm = ( 25.51 x 36.10 ) in
'C2' => [1298.268, 1836.850], // = ( 458 x 648 ) mm = ( 18.03 x 25.51 ) in
'C3' => [918.425, 1298.268], // = ( 324 x 458 ) mm = ( 12.76 x 18.03 ) in
'C4' => [649.134, 918.425], // = ( 229 x 324 ) mm = ( 9.02 x 12.76 ) in
'C5' => [459.213, 649.134], // = ( 162 x 229 ) mm = ( 6.38 x 9.02 ) in
'C6' => [323.150, 459.213], // = ( 114 x 162 ) mm = ( 4.49 x 6.38 ) in
'C7' => [229.606, 323.150], // = ( 81 x 114 ) mm = ( 3.19 x 4.49 ) in
'C8' => [161.575, 229.606], // = ( 57 x 81 ) mm = ( 2.24 x 3.19 ) in
'C9' => [113.386, 161.575], // = ( 40 x 57 ) mm = ( 1.57 x 2.24 ) in
'C10' => [79.370, 113.386], // = ( 28 x 40 ) mm = ( 1.10 x 1.57 ) in
'C11' => [56.693, 79.370], // = ( 20 x 28 ) mm = ( 0.79 x 1.10 ) in
'C12' => [39.685, 56.693], // = ( 14 x 20 ) mm = ( 0.55 x 0.79 ) in
'C76' => [229.606, 459.213], // = ( 81 x 162 ) mm = ( 3.19 x 6.38 ) in
'DL' => [311.811, 623.622], // = ( 110 x 220 ) mm = ( 4.33 x 8.66 ) in
'DLE' => [323.150, 637.795], // = ( 114 x 225 ) mm = ( 4.49 x 8.86 ) in
'DLX' => [340.158, 666.142], // = ( 120 x 235 ) mm = ( 4.72 x 9.25 ) in
'DLP' => [280.630, 595.276], // = ( 99 x 210 ) mm = ( 3.90 x 8.27 ) in (A4/3)
// SIS 014711 E Series
'E0' => [2491.654, 3517.795], // = ( 879 x 1241 ) mm = ( 34.61 x 48.86 ) in
'E1' => [1757.480, 2491.654], // = ( 620 x 879 ) mm = ( 24.41 x 34.61 ) in
'E2' => [1247.244, 1757.480], // = ( 440 x 620 ) mm = ( 17.32 x 24.41 ) in
'E3' => [878.740, 1247.244], // = ( 310 x 440 ) mm = ( 12.20 x 17.32 ) in
'E4' => [623.622, 878.740], // = ( 220 x 310 ) mm = ( 8.66 x 12.20 ) in
'E5' => [439.370, 623.622], // = ( 155 x 220 ) mm = ( 6.10 x 8.66 ) in
'E6' => [311.811, 439.370], // = ( 110 x 155 ) mm = ( 4.33 x 6.10 ) in
'E7' => [221.102, 311.811], // = ( 78 x 110 ) mm = ( 3.07 x 4.33 ) in
'E8' => [155.906, 221.102], // = ( 55 x 78 ) mm = ( 2.17 x 3.07 ) in
'E9' => [110.551, 155.906], // = ( 39 x 55 ) mm = ( 1.54 x 2.17 ) in
'E10' => [76.535, 110.551], // = ( 27 x 39 ) mm = ( 1.06 x 1.54 ) in
'E11' => [53.858, 76.535], // = ( 19 x 27 ) mm = ( 0.75 x 1.06 ) in
'E12' => [36.850, 53.858], // = ( 13 x 19 ) mm = ( 0.51 x 0.75 ) in
// SIS 014711 G Series
'G0' => [2715.591, 3838.110], // = ( 958 x 1354 ) mm = ( 37.72 x 53.31 ) in
'G1' => [1919.055, 2715.591], // = ( 677 x 958 ) mm = ( 26.65 x 37.72 ) in
'G2' => [1357.795, 1919.055], // = ( 479 x 677 ) mm = ( 18.86 x 26.65 ) in
'G3' => [958.110, 1357.795], // = ( 338 x 479 ) mm = ( 13.31 x 18.86 ) in
'G4' => [677.480, 958.110], // = ( 239 x 338 ) mm = ( 9.41 x 13.31 ) in
'G5' => [479.055, 677.480], // = ( 169 x 239 ) mm = ( 6.65 x 9.41 ) in
'G6' => [337.323, 479.055], // = ( 119 x 169 ) mm = ( 4.69 x 6.65 ) in
'G7' => [238.110, 337.323], // = ( 84 x 119 ) mm = ( 3.31 x 4.69 ) in
'G8' => [167.244, 238.110], // = ( 59 x 84 ) mm = ( 2.32 x 3.31 ) in
'G9' => [119.055, 167.244], // = ( 42 x 59 ) mm = ( 1.65 x 2.32 ) in
'G10' => [82.205, 119.055], // = ( 29 x 42 ) mm = ( 1.14 x 1.65 ) in
'G11' => [59.528, 82.205], // = ( 21 x 29 ) mm = ( 0.83 x 1.14 ) in
'G12' => [39.685, 59.528], // = ( 14 x 21 ) mm = ( 0.55 x 0.83 ) in
// ISO Press
'RA0' => [2437.795, 3458.268], // = ( 860 x 1220 ) mm = ( 33.86 x 48.03 ) in
'RA1' => [1729.134, 2437.795], // = ( 610 x 860 ) mm = ( 24.02 x 33.86 ) in
'RA2' => [1218.898, 1729.134], // = ( 430 x 610 ) mm = ( 16.93 x 24.02 ) in
'RA3' => [864.567, 1218.898], // = ( 305 x 430 ) mm = ( 12.01 x 16.93 ) in
'RA4' => [609.449, 864.567], // = ( 215 x 305 ) mm = ( 8.46 x 12.01 ) in
'SRA0' => [2551.181, 3628.346], // = ( 900 x 1280 ) mm = ( 35.43 x 50.39 ) in
'SRA1' => [1814.173, 2551.181], // = ( 640 x 900 ) mm = ( 25.20 x 35.43 ) in
'SRA2' => [1275.591, 1814.173], // = ( 450 x 640 ) mm = ( 17.72 x 25.20 ) in
'SRA3' => [907.087, 1275.591], // = ( 320 x 450 ) mm = ( 12.60 x 17.72 ) in
'SRA4' => [637.795, 907.087], // = ( 225 x 320 ) mm = ( 8.86 x 12.60 ) in
// German DIN 476
'4A0' => [4767.874, 6740.787], // = ( 1682 x 2378 ) mm = ( 66.22 x 93.62 ) in
'2A0' => [3370.394, 4767.874], // = ( 1189 x 1682 ) mm = ( 46.81 x 66.22 ) in
// Variations on the ISO Standard
'A2_EXTRA' => [1261.417, 1754.646], // = ( 445 x 619 ) mm = ( 17.52 x 24.37 ) in
'A3+' => [932.598, 1369.134], // = ( 329 x 483 ) mm = ( 12.95 x 19.02 ) in
'A3_EXTRA' => [912.756, 1261.417], // = ( 322 x 445 ) mm = ( 12.68 x 17.52 ) in
'A3_SUPER' => [864.567, 1440.000], // = ( 305 x 508 ) mm = ( 12.01 x 20.00 ) in
'SUPER_A3' => [864.567, 1380.472], // = ( 305 x 487 ) mm = ( 12.01 x 19.17 ) in
'A4_EXTRA' => [666.142, 912.756], // = ( 235 x 322 ) mm = ( 9.25 x 12.68 ) in
'A4_SUPER' => [649.134, 912.756], // = ( 229 x 322 ) mm = ( 9.02 x 12.68 ) in
'SUPER_A4' => [643.465, 1009.134], // = ( 227 x 356 ) mm = ( 8.94 x 14.02 ) in
'A4_LONG' => [595.276, 986.457], // = ( 210 x 348 ) mm = ( 8.27 x 13.70 ) in
'F4' => [595.276, 935.433], // = ( 210 x 330 ) mm = ( 8.27 x 12.99 ) in
'SO_B5_EXTRA' => [572.598, 782.362], // = ( 202 x 276 ) mm = ( 7.95 x 10.87 ) in
'A5_EXTRA' => [490.394, 666.142], // = ( 173 x 235 ) mm = ( 6.81 x 9.25 ) in
// ANSI Series
'ANSI_E' => [2448.000, 3168.000], // = ( 864 x 1118 ) mm = ( 34.00 x 44.00 ) in
'ANSI_D' => [1584.000, 2448.000], // = ( 559 x 864 ) mm = ( 22.00 x 34.00 ) in
'ANSI_C' => [1224.000, 1584.000], // = ( 432 x 559 ) mm = ( 17.00 x 22.00 ) in
'ANSI_B' => [792.000, 1224.000], // = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'ANSI_A' => [612.000, 792.000], // = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
// Traditional 'Loose' North American Paper Sizes
'USLEDGER' => [1224.000, 792.000], // = ( 432 x 279 ) mm = ( 17.00 x 11.00 ) in
'LEDGER' => [1224.000, 792.000], // = ( 432 x 279 ) mm = ( 17.00 x 11.00 ) in
'ORGANIZERK' => [792.000, 1224.000], // = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'BIBLE' => [792.000, 1224.000], // = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'USTABLOID' => [792.000, 1224.000], // = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'TABLOID' => [792.000, 1224.000], // = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'ORGANIZERM' => [612.000, 792.000], // = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'USLETTER' => [612.000, 792.000], // = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'LETTER' => [612.000, 792.000], // = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'USLEGAL' => [612.000, 1008.000], // = ( 216 x 356 ) mm = ( 8.50 x 14.00 ) in
'LEGAL' => [612.000, 1008.000], // = ( 216 x 356 ) mm = ( 8.50 x 14.00 ) in
'GOVERNMENTLETTER' => [576.000, 756.000], // = ( 203 x 267 ) mm = ( 8.00 x 10.50 ) in
'GLETTER' => [576.000, 756.000], // = ( 203 x 267 ) mm = ( 8.00 x 10.50 ) in
'JUNIORLEGAL' => [576.000, 360.000], // = ( 203 x 127 ) mm = ( 8.00 x 5.00 ) in
'JLEGAL' => [576.000, 360.000], // = ( 203 x 127 ) mm = ( 8.00 x 5.00 ) in
// Other North American Paper Sizes
'QUADDEMY' => [2520.000, 3240.000], // = ( 889 x 1143 ) mm = ( 35.00 x 45.00 ) in
'SUPER_B' => [936.000, 1368.000], // = ( 330 x 483 ) mm = ( 13.00 x 19.00 ) in
'QUARTO' => [648.000, 792.000], // = ( 229 x 279 ) mm = ( 9.00 x 11.00 ) in
'GOVERNMENTLEGAL' => [612.000, 936.000], // = ( 216 x 330 ) mm = ( 8.50 x 13.00 ) in
'FOLIO' => [612.000, 936.000], // = ( 216 x 330 ) mm = ( 8.50 x 13.00 ) in
'MONARCH' => [522.000, 756.000], // = ( 184 x 267 ) mm = ( 7.25 x 10.50 ) in
'EXECUTIVE' => [522.000, 756.000], // = ( 184 x 267 ) mm = ( 7.25 x 10.50 ) in
'ORGANIZERL' => [396.000, 612.000], // = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'STATEMENT' => [396.000, 612.000], // = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'MEMO' => [396.000, 612.000], // = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'FOOLSCAP' => [595.440, 936.000], // = ( 210 x 330 ) mm = ( 8.27 x 13.00 ) in
'COMPACT' => [306.000, 486.000], // = ( 108 x 171 ) mm = ( 4.25 x 6.75 ) in
'ORGANIZERJ' => [198.000, 360.000], // = ( 70 x 127 ) mm = ( 2.75 x 5.00 ) in
// Canadian standard CAN 2-9.60M
'P1' => [1587.402, 2437.795], // = ( 560 x 860 ) mm = ( 22.05 x 33.86 ) in
'P2' => [1218.898, 1587.402], // = ( 430 x 560 ) mm = ( 16.93 x 22.05 ) in
'P3' => [793.701, 1218.898], // = ( 280 x 430 ) mm = ( 11.02 x 16.93 ) in
'P4' => [609.449, 793.701], // = ( 215 x 280 ) mm = ( 8.46 x 11.02 ) in
'P5' => [396.850, 609.449], // = ( 140 x 215 ) mm = ( 5.51 x 8.46 ) in
'P6' => [303.307, 396.850], // = ( 107 x 140 ) mm = ( 4.21 x 5.51 ) in
// North American Architectural Sizes
'ARCH_E' => [2592.000, 3456.000], // = ( 914 x 1219 ) mm = ( 36.00 x 48.00 ) in
'ARCH_E1' => [2160.000, 3024.000], // = ( 762 x 1067 ) mm = ( 30.00 x 42.00 ) in
'ARCH_D' => [1728.000, 2592.000], // = ( 610 x 914 ) mm = ( 24.00 x 36.00 ) in
'BROADSHEET' => [1296.000, 1728.000], // = ( 457 x 610 ) mm = ( 18.00 x 24.00 ) in
'ARCH_C' => [1296.000, 1728.000], // = ( 457 x 610 ) mm = ( 18.00 x 24.00 ) in
'ARCH_B' => [864.000, 1296.000], // = ( 305 x 457 ) mm = ( 12.00 x 18.00 ) in
'ARCH_A' => [648.000, 864.000], // = ( 229 x 305 ) mm = ( 9.00 x 12.00 ) in
// -- North American Envelope Sizes
// - Announcement Envelopes
'ANNENV_A2' => [314.640, 414.000], // = ( 111 x 146 ) mm = ( 4.37 x 5.75 ) in
'ANNENV_A6' => [342.000, 468.000], // = ( 121 x 165 ) mm = ( 4.75 x 6.50 ) in
'ANNENV_A7' => [378.000, 522.000], // = ( 133 x 184 ) mm = ( 5.25 x 7.25 ) in
'ANNENV_A8' => [396.000, 584.640], // = ( 140 x 206 ) mm = ( 5.50 x 8.12 ) in
'ANNENV_A10' => [450.000, 692.640], // = ( 159 x 244 ) mm = ( 6.25 x 9.62 ) in
'ANNENV_SLIM' => [278.640, 638.640], // = ( 98 x 225 ) mm = ( 3.87 x 8.87 ) in
// - Commercial Envelopes
'COMMENV_N6_1/4' => [252.000, 432.000], // = ( 89 x 152 ) mm = ( 3.50 x 6.00 ) in
'COMMENV_N6_3/4' => [260.640, 468.000], // = ( 92 x 165 ) mm = ( 3.62 x 6.50 ) in
'COMMENV_N8' => [278.640, 540.000], // = ( 98 x 191 ) mm = ( 3.87 x 7.50 ) in
'COMMENV_N9' => [278.640, 638.640], // = ( 98 x 225 ) mm = ( 3.87 x 8.87 ) in
'COMMENV_N10' => [296.640, 684.000], // = ( 105 x 241 ) mm = ( 4.12 x 9.50 ) in
'COMMENV_N11' => [324.000, 746.640], // = ( 114 x 263 ) mm = ( 4.50 x 10.37 ) in
'COMMENV_N12' => [342.000, 792.000], // = ( 121 x 279 ) mm = ( 4.75 x 11.00 ) in
'COMMENV_N14' => [360.000, 828.000], // = ( 127 x 292 ) mm = ( 5.00 x 11.50 ) in
// - Catalogue Envelopes
'CATENV_N1' => [432.000, 648.000], // = ( 152 x 229 ) mm = ( 6.00 x 9.00 ) in
'CATENV_N1_3/4' => [468.000, 684.000], // = ( 165 x 241 ) mm = ( 6.50 x 9.50 ) in
'CATENV_N2' => [468.000, 720.000], // = ( 165 x 254 ) mm = ( 6.50 x 10.00 ) in
'CATENV_N3' => [504.000, 720.000], // = ( 178 x 254 ) mm = ( 7.00 x 10.00 ) in
'CATENV_N6' => [540.000, 756.000], // = ( 191 x 267 ) mm = ( 7.50 x 10.50 ) in
'CATENV_N7' => [576.000, 792.000], // = ( 203 x 279 ) mm = ( 8.00 x 11.00 ) in
'CATENV_N8' => [594.000, 810.000], // = ( 210 x 286 ) mm = ( 8.25 x 11.25 ) in
'CATENV_N9_1/2' => [612.000, 756.000], // = ( 216 x 267 ) mm = ( 8.50 x 10.50 ) in
'CATENV_N9_3/4' => [630.000, 810.000], // = ( 222 x 286 ) mm = ( 8.75 x 11.25 ) in
'CATENV_N10_1/2' => [648.000, 864.000], // = ( 229 x 305 ) mm = ( 9.00 x 12.00 ) in
'CATENV_N12_1/2' => [684.000, 900.000], // = ( 241 x 318 ) mm = ( 9.50 x 12.50 ) in
'CATENV_N13_1/2' => [720.000, 936.000], // = ( 254 x 330 ) mm = ( 10.00 x 13.00 ) in
'CATENV_N14_1/4' => [810.000, 882.000], // = ( 286 x 311 ) mm = ( 11.25 x 12.25 ) in
'CATENV_N14_1/2' => [828.000, 1044.000], // = ( 292 x 368 ) mm = ( 11.50 x 14.50 ) in
// Japanese (JIS P 0138-61) Standard B-Series
'JIS_B0' => [2919.685, 4127.244], // = ( 1030 x 1456 ) mm = ( 40.55 x 57.32 ) in
'JIS_B1' => [2063.622, 2919.685], // = ( 728 x 1030 ) mm = ( 28.66 x 40.55 ) in
'JIS_B2' => [1459.843, 2063.622], // = ( 515 x 728 ) mm = ( 20.28 x 28.66 ) in
'JIS_B3' => [1031.811, 1459.843], // = ( 364 x 515 ) mm = ( 14.33 x 20.28 ) in
'JIS_B4' => [728.504, 1031.811], // = ( 257 x 364 ) mm = ( 10.12 x 14.33 ) in
'JIS_B5' => [515.906, 728.504], // = ( 182 x 257 ) mm = ( 7.17 x 10.12 ) in
'JIS_B6' => [362.835, 515.906], // = ( 128 x 182 ) mm = ( 5.04 x 7.17 ) in
'JIS_B7' => [257.953, 362.835], // = ( 91 x 128 ) mm = ( 3.58 x 5.04 ) in
'JIS_B8' => [181.417, 257.953], // = ( 64 x 91 ) mm = ( 2.52 x 3.58 ) in
'JIS_B9' => [127.559, 181.417], // = ( 45 x 64 ) mm = ( 1.77 x 2.52 ) in
'JIS_B10' => [90.709, 127.559], // = ( 32 x 45 ) mm = ( 1.26 x 1.77 ) in
'JIS_B11' => [62.362, 90.709], // = ( 22 x 32 ) mm = ( 0.87 x 1.26 ) in
'JIS_B12' => [45.354, 62.362], // = ( 16 x 22 ) mm = ( 0.63 x 0.87 ) in
// PA Series
'PA0' => [2381.102, 3174.803], // = ( 840 x 1120 ) mm = ( 33.07 x 44.09 ) in
'PA1' => [1587.402, 2381.102], // = ( 560 x 840 ) mm = ( 22.05 x 33.07 ) in
'PA2' => [1190.551, 1587.402], // = ( 420 x 560 ) mm = ( 16.54 x 22.05 ) in
'PA3' => [793.701, 1190.551], // = ( 280 x 420 ) mm = ( 11.02 x 16.54 ) in
'PA4' => [595.276, 793.701], // = ( 210 x 280 ) mm = ( 8.27 x 11.02 ) in
'PA5' => [396.850, 595.276], // = ( 140 x 210 ) mm = ( 5.51 x 8.27 ) in
'PA6' => [297.638, 396.850], // = ( 105 x 140 ) mm = ( 4.13 x 5.51 ) in
'PA7' => [198.425, 297.638], // = ( 70 x 105 ) mm = ( 2.76 x 4.13 ) in
'PA8' => [147.402, 198.425], // = ( 52 x 70 ) mm = ( 2.05 x 2.76 ) in
'PA9' => [99.213, 147.402], // = ( 35 x 52 ) mm = ( 1.38 x 2.05 ) in
'PA10' => [73.701, 99.213], // = ( 26 x 35 ) mm = ( 1.02 x 1.38 ) in
// Standard Photographic Print Sizes
'PASSPORT_PHOTO' => [99.213, 127.559], // = ( 35 x 45 ) mm = ( 1.38 x 1.77 ) in
'E' => [233.858, 340.157], // = ( 82 x 120 ) mm = ( 3.25 x 4.72 ) in
'L' => [252.283, 360.000], // = ( 89 x 127 ) mm = ( 3.50 x 5.00 ) in
'3R' => [252.283, 360.000], // = ( 89 x 127 ) mm = ( 3.50 x 5.00 ) in
'KG' => [289.134, 430.866], // = ( 102 x 152 ) mm = ( 4.02 x 5.98 ) in
'4R' => [289.134, 430.866], // = ( 102 x 152 ) mm = ( 4.02 x 5.98 ) in
'4D' => [340.157, 430.866], // = ( 120 x 152 ) mm = ( 4.72 x 5.98 ) in
'2L' => [360.000, 504.567], // = ( 127 x 178 ) mm = ( 5.00 x 7.01 ) in
'5R' => [360.000, 504.567], // = ( 127 x 178 ) mm = ( 5.00 x 7.01 ) in
'8P' => [430.866, 575.433], // = ( 152 x 203 ) mm = ( 5.98 x 7.99 ) in
'6R' => [430.866, 575.433], // = ( 152 x 203 ) mm = ( 5.98 x 7.99 ) in
'6P' => [575.433, 720.000], // = ( 203 x 254 ) mm = ( 7.99 x 10.00 ) in
'8R' => [575.433, 720.000], // = ( 203 x 254 ) mm = ( 7.99 x 10.00 ) in
'6PW' => [575.433, 864.567], // = ( 203 x 305 ) mm = ( 7.99 x 12.01 ) in
'S8R' => [575.433, 864.567], // = ( 203 x 305 ) mm = ( 7.99 x 12.01 ) in
'4P' => [720.000, 864.567], // = ( 254 x 305 ) mm = ( 10.00 x 12.01 ) in
'10R' => [720.000, 864.567], // = ( 254 x 305 ) mm = ( 10.00 x 12.01 ) in
'4PW' => [720.000, 1080.000], // = ( 254 x 381 ) mm = ( 10.00 x 15.00 ) in
'S10R' => [720.000, 1080.000], // = ( 254 x 381 ) mm = ( 10.00 x 15.00 ) in
'11R' => [790.866, 1009.134], // = ( 279 x 356 ) mm = ( 10.98 x 14.02 ) in
'S11R' => [790.866, 1224.567], // = ( 279 x 432 ) mm = ( 10.98 x 17.01 ) in
'12R' => [864.567, 1080.000], // = ( 305 x 381 ) mm = ( 12.01 x 15.00 ) in
'S12R' => [864.567, 1292.598], // = ( 305 x 456 ) mm = ( 12.01 x 17.95 ) in
// Common Newspaper Sizes
'NEWSPAPER_BROADSHEET' => [2125.984, 1700.787], // = ( 750 x 600 ) mm = ( 29.53 x 23.62 ) in
'NEWSPAPER_BERLINER' => [1332.283, 892.913], // = ( 470 x 315 ) mm = ( 18.50 x 12.40 ) in
'NEWSPAPER_TABLOID' => [1218.898, 793.701], // = ( 430 x 280 ) mm = ( 16.93 x 11.02 ) in
'NEWSPAPER_COMPACT' => [1218.898, 793.701], // = ( 430 x 280 ) mm = ( 16.93 x 11.02 ) in
// Business Cards
'CREDIT_CARD' => [153.014, 242.646], // = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD' => [153.014, 242.646], // = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD_ISO7810' => [153.014, 242.646], // = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD_ISO216' => [147.402, 209.764], // = ( 52 x 74 ) mm = ( 2.05 x 2.91 ) in
'BUSINESS_CARD_IT' => [155.906, 240.945], // = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_UK' => [155.906, 240.945], // = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_FR' => [155.906, 240.945], // = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_DE' => [155.906, 240.945], // = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_ES' => [155.906, 240.945], // = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_CA' => [144.567, 252.283], // = ( 51 x 89 ) mm = ( 2.01 x 3.50 ) in
'BUSINESS_CARD_US' => [144.567, 252.283], // = ( 51 x 89 ) mm = ( 2.01 x 3.50 ) in
'BUSINESS_CARD_JP' => [155.906, 257.953], // = ( 55 x 91 ) mm = ( 2.17 x 3.58 ) in
'BUSINESS_CARD_HK' => [153.071, 255.118], // = ( 54 x 90 ) mm = ( 2.13 x 3.54 ) in
'BUSINESS_CARD_AU' => [155.906, 255.118], // = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_DK' => [155.906, 255.118], // = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_SE' => [155.906, 255.118], // = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_RU' => [141.732, 255.118], // = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_CZ' => [141.732, 255.118], // = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_FI' => [141.732, 255.118], // = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_HU' => [141.732, 255.118], // = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_IL' => [141.732, 255.118], // = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
// Billboards
'4SHEET' => [2880.000, 4320.000], // = ( 1016 x 1524 ) mm = ( 40.00 x 60.00 ) in
'6SHEET' => [3401.575, 5102.362], // = ( 1200 x 1800 ) mm = ( 47.24 x 70.87 ) in
'12SHEET' => [8640.000, 4320.000], // = ( 3048 x 1524 ) mm = (120.00 x 60.00 ) in
'16SHEET' => [5760.000, 8640.000], // = ( 2032 x 3048 ) mm = ( 80.00 x 120.00) in
'32SHEET' => [11520.000, 8640.000], // = ( 4064 x 3048 ) mm = (160.00 x 120.00) in
'48SHEET' => [17280.000, 8640.000], // = ( 6096 x 3048 ) mm = (240.00 x 120.00) in
'64SHEET' => [23040.000, 8640.000], // = ( 8128 x 3048 ) mm = (320.00 x 120.00) in
'96SHEET' => [34560.000, 8640.000], // = (12192 x 3048 ) mm = (480.00 x 120.00) in
// -- Old European Sizes
// - Old Imperial English Sizes
'EN_EMPEROR' => [3456.000, 5184.000], // = ( 1219 x 1829 ) mm = ( 48.00 x 72.00 ) in
'EN_ANTIQUARIAN' => [2232.000, 3816.000], // = ( 787 x 1346 ) mm = ( 31.00 x 53.00 ) in
'EN_GRAND_EAGLE' => [2070.000, 3024.000], // = ( 730 x 1067 ) mm = ( 28.75 x 42.00 ) in
'EN_DOUBLE_ELEPHANT' => [1926.000, 2880.000], // = ( 679 x 1016 ) mm = ( 26.75 x 40.00 ) in
'EN_ATLAS' => [1872.000, 2448.000], // = ( 660 x 864 ) mm = ( 26.00 x 34.00 ) in
'EN_COLOMBIER' => [1692.000, 2484.000], // = ( 597 x 876 ) mm = ( 23.50 x 34.50 ) in
'EN_ELEPHANT' => [1656.000, 2016.000], // = ( 584 x 711 ) mm = ( 23.00 x 28.00 ) in
'EN_DOUBLE_DEMY' => [1620.000, 2556.000], // = ( 572 x 902 ) mm = ( 22.50 x 35.50 ) in
'EN_IMPERIAL' => [1584.000, 2160.000], // = ( 559 x 762 ) mm = ( 22.00 x 30.00 ) in
'EN_PRINCESS' => [1548.000, 2016.000], // = ( 546 x 711 ) mm = ( 21.50 x 28.00 ) in
'EN_CARTRIDGE' => [1512.000, 1872.000], // = ( 533 x 660 ) mm = ( 21.00 x 26.00 ) in
'EN_DOUBLE_LARGE_POST' => [1512.000, 2376.000], // = ( 533 x 838 ) mm = ( 21.00 x 33.00 ) in
'EN_ROYAL' => [1440.000, 1800.000], // = ( 508 x 635 ) mm = ( 20.00 x 25.00 ) in
'EN_SHEET' => [1404.000, 1692.000], // = ( 495 x 597 ) mm = ( 19.50 x 23.50 ) in
'EN_HALF_POST' => [1404.000, 1692.000], // = ( 495 x 597 ) mm = ( 19.50 x 23.50 ) in
'EN_SUPER_ROYAL' => [1368.000, 1944.000], // = ( 483 x 686 ) mm = ( 19.00 x 27.00 ) in
'EN_DOUBLE_POST' => [1368.000, 2196.000], // = ( 483 x 775 ) mm = ( 19.00 x 30.50 ) in
'EN_MEDIUM' => [1260.000, 1656.000], // = ( 445 x 584 ) mm = ( 17.50 x 23.00 ) in
'EN_DEMY' => [1260.000, 1620.000], // = ( 445 x 572 ) mm = ( 17.50 x 22.50 ) in
'EN_LARGE_POST' => [1188.000, 1512.000], // = ( 419 x 533 ) mm = ( 16.50 x 21.00 ) in
'EN_COPY_DRAUGHT' => [1152.000, 1440.000], // = ( 406 x 508 ) mm = ( 16.00 x 20.00 ) in
'EN_POST' => [1116.000, 1386.000], // = ( 394 x 489 ) mm = ( 15.50 x 19.25 ) in
'EN_CROWN' => [1080.000, 1440.000], // = ( 381 x 508 ) mm = ( 15.00 x 20.00 ) in
'EN_PINCHED_POST' => [1062.000, 1332.000], // = ( 375 x 470 ) mm = ( 14.75 x 18.50 ) in
'EN_BRIEF' => [972.000, 1152.000], // = ( 343 x 406 ) mm = ( 13.50 x 16.00 ) in
'EN_FOOLSCAP' => [972.000, 1224.000], // = ( 343 x 432 ) mm = ( 13.50 x 17.00 ) in
'EN_SMALL_FOOLSCAP' => [954.000, 1188.000], // = ( 337 x 419 ) mm = ( 13.25 x 16.50 ) in
'EN_POTT' => [900.000, 1080.000], // = ( 318 x 381 ) mm = ( 12.50 x 15.00 ) in
// - Old Imperial Belgian Sizes
'BE_GRAND_AIGLE' => [1984.252, 2948.031], // = ( 700 x 1040 ) mm = ( 27.56 x 40.94 ) in
'BE_COLOMBIER' => [1757.480, 2409.449], // = ( 620 x 850 ) mm = ( 24.41 x 33.46 ) in
'BE_DOUBLE_CARRE' => [1757.480, 2607.874], // = ( 620 x 920 ) mm = ( 24.41 x 36.22 ) in
'BE_ELEPHANT' => [1746.142, 2182.677], // = ( 616 x 770 ) mm = ( 24.25 x 30.31 ) in
'BE_PETIT_AIGLE' => [1700.787, 2381.102], // = ( 600 x 840 ) mm = ( 23.62 x 33.07 ) in
'BE_GRAND_JESUS' => [1559.055, 2069.291], // = ( 550 x 730 ) mm = ( 21.65 x 28.74 ) in
'BE_JESUS' => [1530.709, 2069.291], // = ( 540 x 730 ) mm = ( 21.26 x 28.74 ) in
'BE_RAISIN' => [1417.323, 1842.520], // = ( 500 x 650 ) mm = ( 19.69 x 25.59 ) in
'BE_GRAND_MEDIAN' => [1303.937, 1714.961], // = ( 460 x 605 ) mm = ( 18.11 x 23.82 ) in
'BE_DOUBLE_POSTE' => [1233.071, 1601.575], // = ( 435 x 565 ) mm = ( 17.13 x 22.24 ) in
'BE_COQUILLE' => [1218.898, 1587.402], // = ( 430 x 560 ) mm = ( 16.93 x 22.05 ) in
'BE_PETIT_MEDIAN' => [1176.378, 1502.362], // = ( 415 x 530 ) mm = ( 16.34 x 20.87 ) in
'BE_RUCHE' => [1020.472, 1303.937], // = ( 360 x 460 ) mm = ( 14.17 x 18.11 ) in
'BE_PROPATRIA' => [977.953, 1218.898], // = ( 345 x 430 ) mm = ( 13.58 x 16.93 ) in
'BE_LYS' => [898.583, 1125.354], // = ( 317 x 397 ) mm = ( 12.48 x 15.63 ) in
'BE_POT' => [870.236, 1088.504], // = ( 307 x 384 ) mm = ( 12.09 x 15.12 ) in
'BE_ROSETTE' => [765.354, 983.622], // = ( 270 x 347 ) mm = ( 10.63 x 13.66 ) in
// - Old Imperial French Sizes
'FR_UNIVERS' => [2834.646, 3685.039], // = ( 1000 x 1300 ) mm = ( 39.37 x 51.18 ) in
'FR_DOUBLE_COLOMBIER' => [2551.181, 3571.654], // = ( 900 x 1260 ) mm = ( 35.43 x 49.61 ) in
'FR_GRANDE_MONDE' => [2551.181, 3571.654], // = ( 900 x 1260 ) mm = ( 35.43 x 49.61 ) in
'FR_DOUBLE_SOLEIL' => [2267.717, 3401.575], // = ( 800 x 1200 ) mm = ( 31.50 x 47.24 ) in
'FR_DOUBLE_JESUS' => [2154.331, 3174.803], // = ( 760 x 1120 ) mm = ( 29.92 x 44.09 ) in
'FR_GRAND_AIGLE' => [2125.984, 3004.724], // = ( 750 x 1060 ) mm = ( 29.53 x 41.73 ) in
'FR_PETIT_AIGLE' => [1984.252, 2664.567], // = ( 700 x 940 ) mm = ( 27.56 x 37.01 ) in
'FR_DOUBLE_RAISIN' => [1842.520, 2834.646], // = ( 650 x 1000 ) mm = ( 25.59 x 39.37 ) in
'FR_JOURNAL' => [1842.520, 2664.567], // = ( 650 x 940 ) mm = ( 25.59 x 37.01 ) in
'FR_COLOMBIER_AFFICHE' => [1785.827, 2551.181], // = ( 630 x 900 ) mm = ( 24.80 x 35.43 ) in
'FR_DOUBLE_CAVALIER' => [1757.480, 2607.874], // = ( 620 x 920 ) mm = ( 24.41 x 36.22 ) in
'FR_CLOCHE' => [1700.787, 2267.717], // = ( 600 x 800 ) mm = ( 23.62 x 31.50 ) in
'FR_SOLEIL' => [1700.787, 2267.717], // = ( 600 x 800 ) mm = ( 23.62 x 31.50 ) in
'FR_DOUBLE_CARRE' => [1587.402, 2551.181], // = ( 560 x 900 ) mm = ( 22.05 x 35.43 ) in
'FR_DOUBLE_COQUILLE' => [1587.402, 2494.488], // = ( 560 x 880 ) mm = ( 22.05 x 34.65 ) in
'FR_JESUS' => [1587.402, 2154.331], // = ( 560 x 760 ) mm = ( 22.05 x 29.92 ) in
'FR_RAISIN' => [1417.323, 1842.520], // = ( 500 x 650 ) mm = ( 19.69 x 25.59 ) in
'FR_CAVALIER' => [1303.937, 1757.480], // = ( 460 x 620 ) mm = ( 18.11 x 24.41 ) in
'FR_DOUBLE_COURONNE' => [1303.937, 2040.945], // = ( 460 x 720 ) mm = ( 18.11 x 28.35 ) in
'FR_CARRE' => [1275.591, 1587.402], // = ( 450 x 560 ) mm = ( 17.72 x 22.05 ) in
'FR_COQUILLE' => [1247.244, 1587.402], // = ( 440 x 560 ) mm = ( 17.32 x 22.05 ) in
'FR_DOUBLE_TELLIERE' => [1247.244, 1927.559], // = ( 440 x 680 ) mm = ( 17.32 x 26.77 ) in
'FR_DOUBLE_CLOCHE' => [1133.858, 1700.787], // = ( 400 x 600 ) mm = ( 15.75 x 23.62 ) in
'FR_DOUBLE_POT' => [1133.858, 1757.480], // = ( 400 x 620 ) mm = ( 15.75 x 24.41 ) in
'FR_ECU' => [1133.858, 1474.016], // = ( 400 x 520 ) mm = ( 15.75 x 20.47 ) in
'FR_COURONNE' => [1020.472, 1303.937], // = ( 360 x 460 ) mm = ( 14.17 x 18.11 ) in
'FR_TELLIERE' => [963.780, 1247.244], // = ( 340 x 440 ) mm = ( 13.39 x 17.32 ) in
'FR_POT' => [878.740, 1133.858], // = ( 310 x 400 ) mm = ( 12.20 x 15.75 ) in
// Colombian Sizes
'CO_CARTA' => [612.283, 790.866], // = ( 216 x 279 ) mm = ( 8.50 x 10.98 ) in
'CO_EXTRA_TABLOIDE' => [864.000, 1296.000], // = ( 304 x 457 ) mm = ( 12.00 x 18.00 ) in
'CO_OFICIO' => [612.283, 935.433], // = ( 216 x 330 ) mm = ( 8.50 x 12.99 ) in
'CO_PLIEGO' => [1984.252, 2834.646], // = ( 700 x 1000 ) mm = ( 27.56 x 39.37 ) in
'CO_PLIEGO2' => [1417.323, 1984.252], // = ( 500 x 700 ) mm = ( 19.69 x 27.56 ) in
'CO_PLIEGO4' => [992.126, 1417.323], // = ( 350 x 500 ) mm = ( 13.78 x 19.69 ) in
'CO_PLIEGO8' => [708.661, 992.126], // = ( 250 x 350 ) mm = ( 9.84 x 13.78 ) in
// Japanese Sizes
'JP_AB_BAN' => [2494.488, 3075.591], // = ( 880 x 1085 ) mm = ( 34.65 x 42.72 ) in
'JP_AIBAN' => [637.795, 977.953], // = ( 225 x 345 ) mm = ( 8.86 x 13.58 ) in
'JP_A_KO_BAN' => [1723.465, 2454.803], // = ( 608 x 866 ) mm = ( 23.94 x 34.09 ) in
'JP_B_KO_BAN' => [2137.323, 2967.874], // = ( 754 x 1047 ) mm = ( 29.69 x 41.22 ) in
'JP_CHOUBO_BAN' => [2318.740, 3092.598], // = ( 818 x 1091 ) mm = ( 32.20 x 42.95 ) in
'JP_CHUBAN' => [538.583, 722.835], // = ( 190 x 255 ) mm = ( 7.48 x 10.04 ) in
'JP_CHU_TANZAKU' => [368.504, 1077.165], // = ( 130 x 380 ) mm = ( 5.12 x 14.96 ) in
'JP_DAI OBAN' => [977.953, 1289.764], // = ( 345 x 455 ) mm = ( 13.58 x 17.91 ) in
'JP_EBANKIRI' => [538.583, 1459.843], // = ( 190 x 515 ) mm = ( 7.48 x 20.28 ) in
'JP_FUURUSU_KO_BAN' => [943.937, 1201.890], // = ( 333 x 424 ) mm = ( 13.11 x 16.69 ) in
'JP_GAYOUSHI' => [1649.764, 2148.661], // = ( 582 x 758 ) mm = ( 22.91 x 29.84 ) in
'JP_HASHIRE_E' => [368.504, 2069.291], // = ( 130 x 730 ) mm = ( 5.12 x 28.74 ) in
'JP_HATORON_BAN' => [2551.181, 3401.575], // = ( 900 x 1200 ) mm = ( 35.43 x 47.24 ) in
'JP_HOM_BAN' => [1842.520, 2211.024], // = ( 650 x 780 ) mm = ( 25.59 x 30.71 ) in
'JP_HOSOBAN' => [411.024, 935.433], // = ( 145 x 330 ) mm = ( 5.71 x 12.99 ) in
'JP_JIS_A_BAN' => [1771.654, 2494.488], // = ( 625 x 880 ) mm = ( 24.61 x 34.65 ) in
'JP_JIS_B_BAN' => [2168.504, 3075.591], // = ( 765 x 1085 ) mm = ( 30.12 x 42.72 ) in
'JP_KAKEMONO_E' => [651.969, 2154.331], // = ( 230 x 760 ) mm = ( 9.06 x 29.92 ) in
'JP_KAKUBAN' => [504.567, 575.433], // = ( 178 x 203 ) mm = ( 7.01 x 7.99 ) in
'JP_KAKU_SURIMONO' => [510.236, 609.449], // = ( 180 x 215 ) mm = ( 7.09 x 8.46 ) in
'JP_KENTO_BAN' => [1374.803, 1768.819], // = ( 485 x 624 ) mm = ( 19.09 x 24.57 ) in
'JP_KIKU_BAN' => [1802.835, 2661.732], // = ( 636 x 939 ) mm = ( 25.04 x 36.97 ) in
'JP_KIKU_BAN4' => [643.465, 867.402], // = ( 227 x 306 ) mm = ( 8.94 x 12.05 ) in
'JP_KIKU_BAN5' => [428.031, 643.465], // = ( 151 x 227 ) mm = ( 5.94 x 8.94 ) in
'JP_KIKU_BAN5_OLD' => [430.866, 617.953], // = ( 152 x 218 ) mm = ( 5.98 x 8.58 ) in
'JP_KIKU_BAN_A20_DORI' => [419.528, 473.386], // = ( 148 x 167 ) mm = ( 5.83 x 6.57 ) in
'JP_KOBAN' => [481.890, 651.969], // = ( 170 x 230 ) mm = ( 6.69 x 9.06 ) in
'JP_KO_BAN_B6' => [317.480, 493.228], // = ( 112 x 174 ) mm = ( 4.41 x 6.85 ) in
'JP_KO_TANZAKU' => [215.433, 977.953], // = ( 76 x 345 ) mm = ( 2.99 x 13.58 ) in
'JP_MOKUTANSHI' => [1332.283, 1760.315], // = ( 470 x 621 ) mm = ( 18.50 x 24.45 ) in
'JP_NAGA_BAN' => [651.969, 1459.843], // = ( 230 x 515 ) mm = ( 9.06 x 20.28 ) in
'JP_OBAN' => [720.000, 1077.165], // = ( 254 x 380 ) mm = ( 10.00 x 14.96 ) in
'JP_OGATA_CHUBAN' => [615.118, 830.551], // = ( 217 x 293 ) mm = ( 8.54 x 11.54 ) in
'JP_O_HOSOBAN' => [481.890, 1077.165], // = ( 170 x 380 ) mm = ( 6.69 x 14.96 ) in
'JP_POSTCARD' => [283.465, 419.528], // = ( 100 x 148 ) mm = ( 3.94 x 5.83 ) in
'JP_SANGO_BAN' => [238.110, 419.528], // = ( 84 x 148 ) mm = ( 3.31 x 5.83 ) in
'JP_SANGO_BAN_A48_DORI' => [209.764, 396.850], // = ( 74 x 140 ) mm = ( 2.91 x 5.51 ) in
'JP_SANGO_BAN_B20_DORI' => [515.906, 583.937], // = ( 182 x 206 ) mm = ( 7.17 x 8.11 ) in
'JP_SANGO_BAN_B36_DORI' => [342.992, 484.724], // = ( 121 x 171 ) mm = ( 4.76 x 6.73 ) in
'JP_SANGO_BAN_B40_DORI' => [238.110, 419.528], // = ( 84 x 148 ) mm = ( 3.31 x 5.83 ) in
'JP_SANROKU_BAN_B48_DORI' => [257.953, 484.724], // = ( 91 x 171 ) mm = ( 3.58 x 6.73 ) in
'JP_SANSAN_BAN' => [1975.748, 2834.646], // = ( 697 x 1000 ) mm = ( 27.44 x 39.37 ) in
'JP_SANSHI_BAN' => [2060.787, 2834.646], // = ( 727 x 1000 ) mm = ( 28.62 x 39.37 ) in
'JP_SHIKISHIBAN' => [581.102, 651.969], // = ( 205 x 230 ) mm = ( 8.07 x 9.06 ) in
'JP_SHIMBUNYOUSHI' => [2304.567, 1547.717], // = ( 813 x 546 ) mm = ( 32.01 x 21.50 ) in
'JP_SHINSHO_BAN_B40_A' => [300.472, 490.394], // = ( 106 x 173 ) mm = ( 4.17 x 6.81 ) in
'JP_SHINSHO_BAN_B40_B' => [291.969, 515.906], // = ( 103 x 182 ) mm = ( 4.06 x 7.17 ) in
'JP_SHIROKU_BAN' => [2233.701, 3092.598], // = ( 788 x 1091 ) mm = ( 31.02 x 42.95 ) in
'JP_SHIROKU_BAN4' => [748.346, 1074.331], // = ( 264 x 379 ) mm = ( 10.39 x 14.92 ) in
'JP_SHIROKU_BAN5' => [535.748, 742.677], // = ( 189 x 262 ) mm = ( 7.44 x 10.31 ) in
'JP_SHIROKU_BAN5_OLD' => [541.417, 734.173], // = ( 191 x 259 ) mm = ( 7.52 x 10.20 ) in
'JP_SHIROKU_BAN6' => [360.000, 532.913], // = ( 127 x 188 ) mm = ( 5.00 x 7.40 ) in
'JP_SHO_TANZAKU' => [269.291, 722.835], // = ( 95 x 255 ) mm = ( 3.74 x 10.04 ) in
'JP_SUITORISHI' => [1252.913, 1615.748], // = ( 442 x 570 ) mm = ( 17.40 x 22.44 ) in
'JP_TANZAKU' => [360.000, 1218.898], // = ( 127 x 430 ) mm = ( 5.00 x 16.93 ) in
'JP_TSUYA_GAMI' => [1440.000, 2160.000], // = ( 508 x 762 ) mm = ( 20.00 x 30.00 ) in
'JP_UCHIWA' => [649.134, 720.000], // = ( 229 x 254 ) mm = ( 9.02 x 10.00 ) in
'JP_WAIDO_BAN' => [595.276, 728.504], // = ( 210 x 257 ) mm = ( 8.27 x 10.12 ) in
'JP_YATSUGIRI_BAN' => [269.291, 360.000], // = ( 95 x 127 ) mm = ( 3.74 x 5.00 ) in
];
/**
* Get page dimensions.
*
* @param string $format The page format name.
* @param string $orientation Page orientation ('P' = portrait; 'L' = landscape, '' = default).
* @param string $unit Unit name (default points).
* @param int $dec Number of decimals to return.
*
* @return array{0:float, 1:float, 2:string} Page width, height and orientation in specified unit.
*/
public function getPageFormatSize(
string $format,
string $orientation = '',
string $unit = '',
int $dec = 6
): array {
if (! isset(self::FORMAT[$format])) {
throw new PageException('unknown page format: ' . $format);
}
return $this->getPageOrientedSize(
$this->convertPoints(self::FORMAT[$format][0], $unit, $dec),
$this->convertPoints(self::FORMAT[$format][1], $unit, $dec),
$orientation
);
}
/**
* Returns the page dimensions oriented as specified.
*
* @param float $width Page width.
* @param float $height Page height.
* @param string $orientation Page orientation ('P' = portrait; 'L' = landscape, '' = default).
*
* @return array{0:float, 1:float, 2:string} Page width, height in points and orientation.
*/
public function getPageOrientedSize(
float $width,
float $height,
string $orientation = ''
): array {
if ($orientation == 'P') {
return [min($width, $height), max($width, $height), 'P'];
}
if ($orientation == 'L') {
return [max($width, $height), min($width, $height), 'L'];
}
$orientation = $this->getPageOrientation($width, $height);
return [$width, $height, $orientation];
}
/**
* Returns the page orientation.
*
* @param float $width Page width.
* @param float $height Page height.
*
* @return string page orientation 'P' or 'L'.
*/
public function getPageOrientation(float $width, float $height): string
{
if ($width <= $height) {
return 'P';
}
return 'L';
}
/**
* Get the unit ratio for the specified unit of measure.
*
* @param string $unit Name of the unit of measure.
*/
public function getUnitRatio(string $unit): float
{
$unit = strtolower($unit);
if (! isset(self::UNITRATIO[$unit])) {
throw new PageException('unknown unit: ' . $unit);
}
return self::UNITRATIO[$unit];
}
/**
* Convert Points to another unit.
*
* @param float $points Value to convert.
* @param string $unit Name of the unit to convert to.
* @param int $dec Number of decimals to return.
*/
public function convertPoints(float $points, string $unit, int $dec = 6): float
{
return round(($points / $this->getUnitRatio($unit)), $dec);
}
}

View File

@@ -0,0 +1,90 @@
<?php
/**
* Mode.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
/**
* Com\Tecnick\Pdf\Page\Mode
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*/
abstract class Mode extends \Com\Tecnick\Pdf\Page\Format
{
/**
* Map layouts with their canonical names
*
* @var array<string, string>
*/
protected const LAYOUT = [
'singlepage' => 'SinglePage', // Display one page at a time
'default' => 'SinglePage',
'single' => 'SinglePage',
'onecolumn' => 'OneColumn', // Display the pages in one column
'continuous' => 'OneColumn',
'twocolumnleft' => 'TwoColumnLeft', // Display the pages in two columns, with odd-numbered pages on the left
'two' => 'TwoColumnLeft',
'twocolumnright' => 'TwoColumnRight', // Display the pages in two columns, with odd-numbered pages on the right
'twopageleft' => 'TwoPageLeft', // Display the pages two at a time, with odd-numbered pages on the left
'twopageright' => 'TwoPageRight', // Display the pages two at a time, with odd-numbered pages on the right
];
/**
* Map display modes with their canonical names
*
* @var array<string, string>
*/
protected const DISPLAY = [
'usenone' => 'UseNone', // Neither document outline nor thumbnail images visible
'useoutlines' => 'UseOutlines', // Document outline visible
'usethumbs' => 'UseThumbs', // Thumbnail images visible
'fullscreen' => 'FullScreen', // Full-screen mode, with no menu bar or window controls
'useoc' => 'UseOC', // (PDF 1.5) Optional content group panel visible
'useattachments' => 'UseAttachments', // (PDF 1.6) Attachments panel visible
'' => 'UseAttachments', // (PDF 1.6) Attachments panel visible
];
/**
* Get the canonical page layout name.
*
* @param string $name Page layout name.
*
* @return string Canonical page layout name.
*/
public function getLayout(string $name = ''): string
{
$name = strtolower($name);
return self::LAYOUT[$name] ?? 'SinglePage';
}
/**
* Get the canonical page display mode.
*
* @param string $mode A name object specifying how the document should be displayed when opened.
*
* @return string Canonical page display mode.
*/
public function getDisplay(string $mode = ''): string
{
$mode = strtolower($mode);
return self::DISPLAY[$mode] ?? 'UseNone';
}
}

View File

@@ -0,0 +1,416 @@
<?php
/**
* Page.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
use Com\Tecnick\Color\Pdf as Color;
use Com\Tecnick\Pdf\Encrypt\Encrypt;
use Com\Tecnick\Pdf\Page\Exception as PageException;
/**
* Com\Tecnick\Pdf\Page\Page
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* @phpstan-import-type PageBci from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageBox from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type MarginData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type RegionData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type TransitionData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageData from \Com\Tecnick\Pdf\Page\Box
*
* @SuppressWarnings("PHPMD.TooManyPublicMethods")
*/
class Page extends \Com\Tecnick\Pdf\Page\Region
{
/**
* Initialize page data.
*
* @param string $unit Unit of measure ('pt', 'mm', 'cm', 'in').
* @param Color $color Color object.
* @param Encrypt $encrypt Encrypt object.
* @param bool $pdfa True if we are in PDF/A mode.
* @param bool $compress Set to false to disable stream compression.
* @param bool $sigapp True if the signature approval is enabled (for incremental updates).
*/
public function __construct(
string $unit,
Color $color,
Encrypt $encrypt,
bool $pdfa = false,
bool $compress = true,
bool $sigapp = false
) {
$this->kunit = $this->getUnitRatio($unit);
$this->col = $color;
$this->enc = $encrypt;
$this->pdfa = $pdfa;
$this->compress = $compress;
$this->sigapp = $sigapp;
}
/**
* Get the unit ratio.
*
* @return float Unit Ratio.
*/
public function getKUnit(): float
{
return $this->kunit;
}
/**
* Enable Signature Approval.
*
* @param bool $sigapp True if the signature approval is enabled (for incremental updates).
*/
public function enableSignatureApproval(bool $sigapp): static
{
$this->sigapp = $sigapp;
return $this;
}
/**
* Remove the specified page.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Removed page.
*/
public function delete(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
$page = $this->page[$pid];
--$this->group[$this->page[$pid]['group']];
unset($this->page[$pid]);
$this->page = array_values($this->page); // reindex array
--$this->pmaxid;
return $page;
}
/**
* Remove and return last page.
*
* @return PageData Removed page.
*/
public function pop(): array
{
return $this->delete($this->pmaxid);
}
/**
* Move a page to a previous position.
*
* @param int $from Index of the page to move.
* @param int $new Destination index.
*/
public function move(int $from, int $new): void
{
if (($from <= $new) || ($from > $this->pmaxid)) {
throw new PageException('The new position must be lower than the starting position');
}
$this->page = array_values(
[
...array_slice($this->page, 0, $new),
$this->page[$from],
...array_slice($this->page, $new, ($from - $new)),
...array_slice($this->page, ($from + 1)),
]
);
}
/**
* Returns the array (stack) containing all pages data.
*
* @return array<int, PageData> Pages.
*/
public function getPages(): array
{
return $this->page;
}
/**
* Add Annotation references.
*
* @param int $oid Annotation object IDs.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function addAnnotRef(int $oid, int $pid = -1): void
{
$pid = $this->sanitizePageID($pid);
if (in_array($oid, $this->page[$pid]['annotrefs'])) {
return;
}
$this->page[$pid]['annotrefs'][] = $oid;
}
/**
* Add page content.
*
* @param string $content Page content.
* @param int $pid Page index. Omit or set it to -1 for the current page ID.
*/
public function addContent(string $content, int $pid = -1): void
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['content'][] = $content;
}
/**
* Remove and return last page content.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function popContent(int $pid = -1): string
{
$pid = $this->sanitizePageID($pid);
$page = array_pop($this->page[$pid]['content']);
if ($page === null) {
throw new PageException('Page content is empty');
}
return $page;
}
/**
* Add page content mark.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function addContentMark(int $pid = -1): void
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['content_mark'][] = count($this->page[$pid]['content']);
}
/**
* Remove the last marked page content.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function popContentToLastMark(int $pid = -1): void
{
$pid = $this->sanitizePageID($pid);
$mark = array_pop($this->page[$pid]['content_mark']);
$this->page[$pid]['content'] = array_slice($this->page[$pid]['content'], 0, $mark, true);
}
/**
* Returns the PDF command to output all page sections.
*
* @param int $pon Current PDF object number.
*
* @return string PDF command.
*/
public function getPdfPages(int &$pon): string
{
$out = $this->getPageRootObj($pon);
foreach ($this->page as $num => $page) {
if (! isset($page['num'])) {
if ($num > 0) {
$page['num'] = (
$page['group'] == $this->page[($num - 1)]['group']
) ? (1 + $this->page[($num - 1)]['num']) : 1;
} else {
$page['num'] = (1 + $num);
}
}
$this->page[$num]['num'] = $page['num'];
$content = $this->replacePageTemplates($page);
$out .= $this->getPageContentObj($pon, $content);
$contentobjid = $pon;
$out .= $page['n'] . ' 0 obj' . "\n"
. '<<' . "\n"
. '/Type /Page' . "\n"
. '/Parent ' . $this->rootoid . ' 0 R' . "\n";
if (! $this->pdfa) {
$out .= '/Group << /Type /Group /S /Transparency /CS /DeviceRGB >>' . "\n";
}
if (! $this->sigapp) {
$out .= '/LastModified ' . $this->enc->getFormattedDate($page['time'], $pon) . "\n";
}
$out .= '/Resources ' . $this->rdoid . ' 0 R' . "\n"
. $this->getBox($page['box'])
. $this->getBoxColorInfo($page['box'])
. '/Contents ' . $contentobjid . ' 0 R' . "\n"
. '/Rotate ' . $page['rotation'] . "\n"
. '/PZ ' . sprintf('%F', $page['zoom']) . "\n"
. $this->getPageTransition($page)
. $this->getAnnotationRef($page)
. '>>' . "\n"
. 'endobj' . "\n";
}
return $out;
}
/**
* Returns the reserved Object ID for the Resource dictionary.
*
* @return int Resource dictionary Object ID.
*/
public function getResourceDictObjID(): int
{
return $this->rdoid;
}
/**
* Returns the root object ID.
*
* @return int Root Object ID.
*/
public function getRootObjID(): int
{
return $this->rootoid;
}
/**
* Returns the PDF command to output the page content.
*
* @param PageData $page Page data.
*
* @return string PDF command.
*/
protected function getPageTransition(array $page): string
{
if (empty($page['transition'])) {
return '';
}
$entries = ['B', 'D', 'Di', 'Dm', 'M', 'S', 'SS'];
$out = '';
$out .= '/Dur ' . sprintf('%F', $page['transition']['Dur']) . "\n";
$out .= '/Trans <<' . "\n"
. '/Type /Trans' . "\n";
foreach ($page['transition'] as $key => $val) {
if (in_array($key, $entries)) {
if (is_float($val)) {
$val = sprintf('%F', $val);
}
$out .= '/' . $key . ' /' . $val . "\n";
}
}
return $out . '>>' . "\n";
}
/**
* Get references to page annotations.
*
* @param PageData $page Page data.
*
* @return string PDF command.
*/
protected function getAnnotationRef(array $page): string
{
if (empty($page['annotrefs'])) {
return '';
}
$out = '/Annots [ ';
sort($page['annotrefs']);
foreach ($page['annotrefs'] as $val) {
$out .= (int) $val . ' 0 R ';
}
return $out . ']' . "\n";
}
/**
* Returns the PDF command to output the page content.
*
* @param int $pon Current PDF object number.
* @param string $content Page content.
*
* @return string PDF command.
*/
protected function getPageContentObj(int &$pon, string $content = ''): string
{
$out = ++$pon . ' 0 obj' . "\n"
. '<<';
if ($this->compress) {
$out .= ' /Filter /FlateDecode';
$cmpr = gzcompress($content);
if ($cmpr !== false) {
$content = $cmpr;
}
}
$stream = $this->enc->encryptString($content, $pon);
return $out . ' /Length ' . strlen($stream)
. ' >>' . "\n"
. 'stream' . "\n"
. $stream . "\n"
. 'endstream' . "\n"
. 'endobj' . "\n";
}
/**
* Returns the PDF command to output the page root object.
*
* @param int $pon Current PDF object number.
*
* @return string PDF command.
*/
protected function getPageRootObj(int &$pon): string
{
$this->rdoid = ++$pon; // reserve object ID for the resource dictionary
$this->rootoid = ++$pon;
$out = $this->rootoid . ' 0 obj' . "\n";
$out .= '<< /Type /Pages /Kids [ ';
$numpages = count($this->page);
for ($pid = 0; $pid < $numpages; ++$pid) {
$this->page[$pid]['n'] = ++$pon;
$out .= $this->page[$pid]['n'] . ' 0 R ';
}
return $out . '] /Count ' . $numpages . ' >>' . "\n"
. 'endobj' . "\n";
}
/**
* Replace page templates and numbers.
*
* @param PageData $data Page data.
*/
protected function replacePageTemplates(array $data): string
{
return implode(
"\n",
str_replace(
[self::PAGE_TOT, self::PAGE_NUM],
[(string) $this->group[$data['group']], (string) $data['num']],
$data['content']
)
);
}
}

View File

@@ -0,0 +1,382 @@
<?php
/**
* Region.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
use Com\Tecnick\Pdf\Page\Exception as PageException;
/**
* Com\Tecnick\Pdf\Page\Region
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* @phpstan-import-type RegionData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageInputData from \Com\Tecnick\Pdf\Page\Box
*
* A page region defines the writable area of the page.
*/
abstract class Region extends \Com\Tecnick\Pdf\Page\Settings
{
/**
* Add a new page.
*
* @param PageInputData $data Page data:
* annotrefs : array containing the annotation object references.
* autobreak : true to automatically add a page when the content reaches the breaking point.
* box : array containing page box boundaries and settings (@see setBox).
* columns : number of equal vertical columns, if set it will automatically populate the region array.
* content : string containing the raw page content.
* format : page format name, or alternatively you can set width and height as below.
* group : page group number.
* height : page height.
* margin : page margins:
* - booklet : true to enable booklet mode
* - PL : page left margin measured from the left page edge
* - PR : page right margin measured from the right page edge
* - PT : page top or header top measured distance from the top page edge
* - HB : header bottom measured from the top page edge
* - CT : content top measured from the top page edge
* - CB : content bottom (page breaking point) measured from the top page edge
* - FT : footer top measured from the bottom page edge
* - PB : page bottom (footer bottom) measured from the bottom page edge
* num : if set overwrites the page number.
* orientation : page orientation ('P' or 'L').
* region : array containing the ordered list of rectangular areas where it is allowed to write,
* each region is defined by:
* - RX : horizontal coordinate of top-left corner
* - RY : vertical coordinate of top-left corner
* - RW : region width
* - RH : region height
* rotation : the number of degrees by which the page shall be rotated clockwise when displayed or printed.
* time : UTC page modification time in seconds.
* transition : array containing page transition data (@see getPageTransition).
* width : page width.
* zoom : preferred zoom (magnification) factor: 1.0 = 100%.
*
* NOTE: if $data is null, then the last page format will be cloned.
*
* @return PageData Page data with additional Page ID property 'pid'.
*/
public function add(array $data = []): array
{
if (($data === []) && ($this->pmaxid >= 0)) {
// clone last page data
$data = $this->page[$this->pmaxid];
unset($data['time'], $data['content'], $data['annotrefs'], $data['pagenum']);
} else {
$this->sanitizeGroup($data);
$this->sanitizeRotation($data);
$this->sanitizeZoom($data);
$this->sanitizePageFormat($data);
$this->sanitizeBoxData($data);
$this->sanitizeTransitions($data);
$this->sanitizeMargins($data);
$this->sanitizeRegions($data);
}
$this->sanitizeTime($data);
$this->sanitizeContent($data);
$this->sanitizeAnnotRefs($data);
$this->sanitizePageNumber($data);
$data['content_mark'] = [0];
$data['currentRegion'] = 0;
$data['pid'] = ++$this->pmaxid;
$this->pid = $data['pid'];
$this->page[$this->pid] = $data; // @phpstan-ignore assign.propertyType
if (isset($data['group'])) {
if (isset($this->group[$data['group']])) {
++$this->group[(int) $data['group']];
} else {
$this->group[(int) $data['group']] = 1;
}
}
return $this->page[$this->pid]; // @phpstan-ignore return.type
}
/**
* Set the current page number (move to the specified page).
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Page data.
*/
public function setCurrentPage(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
$this->pid = $pid;
return $this->page[$this->pid];
}
/**
* Returns the specified page data.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Page data.
*/
public function getPage(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
return $this->page[$pid];
}
/**
* Check if the specified page ID exist.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return int Page ID.
*/
protected function sanitizePageID(int $pid = -1): int
{
if ($pid < 0) {
$pid = $this->pid;
}
if (! isset($this->page[$pid])) {
throw new PageException('The page with index ' . $pid . ' do not exist.');
}
return $pid;
}
/**
* Select the specified page region.
*
* @param int $idr ID of the region.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return RegionData Selected region data.
*/
public function selectRegion(int $idr, int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['currentRegion'] = min(max(0, $idr), $this->page[$pid]['columns']);
return $this->getRegion();
}
/**
* Returns the current region data.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return RegionData Region.
*/
public function getRegion(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
return $this->page[$pid]['region'][$this->page[$pid]['currentRegion']];
}
/**
* Returns the next page data.
* Creates a new page if required and page break is enabled.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Page data.
*/
public function getNextPage(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
if ($pid < $this->pmaxid) {
$this->pid = ++$pid;
return $this->page[$this->pid];
}
if (! $this->isAutoPageBreakEnabled()) {
return $this->setCurrentPage($pid);
}
return $this->add();
}
/**
* Returns the page data with the next selected region.
* If there are no more regions available, then the first region on the next page is selected.
* A new page is added if required.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Current page data.
*/
public function getNextRegion(int $pid = -1): array
{
$pid = $this->sanitizePageID($pid);
$nextid = ($this->page[$pid]['currentRegion'] + 1);
if (isset($this->page[$pid]['region'][$nextid])) {
$this->page[$pid]['currentRegion'] = $nextid;
return $this->page[$pid];
}
return $this->getNextPage($pid);
}
/**
* Move to the next page region if required.
*
* @param float $height Height of the block to add.
* @param ?float $ypos Starting Y position or NULL for current position.
* @param int $pid Page index. Omit or set it to -1 for the current page ID.
*
* @return PageData Page data.
*/
public function checkRegionBreak(
float $height = 0.0,
?float $ypos = null,
int $pid = -1,
): array {
if ($this->isYOutRegion($ypos, $height, $pid)) {
return $this->getNextRegion($pid);
}
return $this->getPage($pid);
}
/**
* Return the auto-page-break status.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*
* @return bool True if the auto page break is enabled, false otherwise.
*/
public function isAutoPageBreakEnabled(int $pid = -1): bool
{
$pid = $this->sanitizePageID($pid);
return $this->page[$pid]['autobreak'];
}
/**
* Enable or disable automatic page break.
*
* @param bool $isenabled Set this to true to enable automatic page break.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function enableAutoPageBreak(bool $isenabled = true, int $pid = -1): void
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['autobreak'] = $isenabled;
}
/**
* Check if the specified position is outside the region.
*
* @param float $pos Position.
* @param string $min ID of the min region value to check.
* @param string $max ID of the max region value to check.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
private function isOutRegion(float $pos, string $min, string $max, int $pid = -1): bool
{
$region = $this->getRegion($pid);
return (($pos < ($region[$min] - self::EPS)) || ($pos > ($region[$max] + self::EPS)));
}
/**
* Check if the specified vertical position is outside the region.
*
* @param ?float $posy Y position or NULL for current position.
* @param float $height Additional height to add.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function isYOutRegion(
?float $posy = null,
float $height = 0.0,
int $pid = -1,
): bool {
if ($posy === null) {
$posy = $this->getY();
}
return $this->isOutRegion($posy + $height, 'RY', 'RT', $pid);
}
/**
* Check if the specified horizontal position is outside the region.
*
* @param ?float $posx X position or NULL for current position.
* @param float $width Additional width to add.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function isXOutRegion(
?float $posx = null,
float $width = 0.0,
int $pid = -1
): bool {
if ($posx === null) {
$posx = $this->getX();
}
return $this->isOutRegion($posx + $width, 'RX', 'RL', $pid);
}
/**
* Return the absolute horizontal cursor position for the current region.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function getX(int $pid = -1): float
{
$pid = $this->sanitizePageID($pid);
return $this->page[$pid]['region'][$this->page[$pid]['currentRegion']]['x'];
}
/**
* Return the absolute vertical cursor position for the current region.
*
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function getY(int $pid = -1): float
{
$pid = $this->sanitizePageID($pid);
return $this->page[$pid]['region'][$this->page[$pid]['currentRegion']]['y'];
}
/**
* Set the absolute horizontal cursor position for the current region.
*
* @param float $xpos X position relative to the page coordinates.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function setX(float $xpos, int $pid = -1): static
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['region'][$this->page[$pid]['currentRegion']]['x'] = $xpos;
return $this;
}
/**
* Set the absolute vertical cursor position for the current region.
*
* @param float $ypos Y position relative to the page coordinates.
* @param int $pid page index. Omit or set it to -1 for the current page ID.
*/
public function setY(float $ypos, int $pid = -1): static
{
$pid = $this->sanitizePageID($pid);
$this->page[$pid]['region'][$this->page[$pid]['currentRegion']]['y'] = $ypos;
return $this;
}
}

View File

@@ -0,0 +1,605 @@
<?php
/**
* Settings.php
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* This file is part of tc-lib-pdf-page software library.
*/
namespace Com\Tecnick\Pdf\Page;
use Com\Tecnick\Pdf\Encrypt\Encrypt;
/**
* Com\Tecnick\Pdf\Page\Settings
*
* @since 2011-05-23
* @category Library
* @package PdfPage
* @author Nicola Asuni <info@tecnick.com>
* @copyright 2011-2024 Nicola Asuni - Tecnick.com LTD
* @license http://www.gnu.org/copyleft/lesser.html GNU-LGPL v3 (see LICENSE.TXT)
* @link https://github.com/tecnickcom/tc-lib-pdf-page
*
* @phpstan-import-type PageBci from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageBox from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type MarginData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type RegionData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type TransitionData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageData from \Com\Tecnick\Pdf\Page\Box
* @phpstan-import-type PageInputData from \Com\Tecnick\Pdf\Page\Box
*
* @SuppressWarnings("PHPMD.TooManyPublicMethods")
* @SuppressWarnings("PHPMD.ExcessiveClassComplexity")
*/
abstract class Settings extends \Com\Tecnick\Pdf\Page\Box
{
/**
* Epsilon precision used to compare floating point values.
*/
public const EPS = 0.0001;
/**
* Alias for total number of pages in a group.
*
* @var string
*/
public const PAGE_TOT = '~#PT';
/**
* Alias for page number.
*
* @var string
*/
public const PAGE_NUM = '~#PN';
/**
* Array of pages (stack).
*
* @var array<int, PageData>
*/
protected array $page = [];
/**
* Current page ID.
*/
protected int $pid = -1;
/**
* Maximum page ID.
*/
protected int $pmaxid = -1;
/**
* Count pages in each group.
*
* @var array<int, int>
*/
protected array $group = [
0 => 0,
];
/**
* Encrypt object.
*/
protected Encrypt $enc;
/**
* True if we are in PDF/A mode.
*/
protected bool $pdfa = false;
/**
* Enable stream compression.
*/
protected bool $compress = true;
/**
* True if the signature approval is enabled (for incremental updates).
*/
protected bool $sigapp = false;
/**
* Reserved Object ID for the resource dictionary.
*/
protected int $rdoid = 1;
/**
* Root object ID.
*/
protected int $rootoid = 0;
/**
* Return the current page ID.
*
* @return int Page ID.
*/
public function getPageID(): int
{
return $this->pid;
}
/**
* Sanitize or set the page modification time.
*
* @param PageInputData $data Page data.
*/
public function sanitizePageNumber(array &$data): void
{
if (! empty($data['num'])) {
$data['num'] = max(0, (int) $data['num']);
}
}
/**
* Sanitize or set the page modification time.
*
* @param PageInputData $data Page data.
*/
public function sanitizeTime(array &$data): void
{
$data['time'] = empty($data['time']) ? time() : max(0, (int) $data['time']);
}
/**
* Sanitize or set the page group.
*
* @param PageInputData $data Page data.
*/
public function sanitizeGroup(array &$data): void
{
$data['group'] = empty($data['group']) ? 0 : max(0, $data['group']);
}
/**
* Sanitize or set the page content.
*
* @param PageInputData $data Page data.
*/
public function sanitizeContent(array &$data): void
{
if (empty($data['content'])) {
$data['content'] = [''];
return;
}
if (is_string($data['content'])) {
$data['content'] = [(string) $data['content']]; // @phpstan-ignore parameterByRef.type
}
}
/**
* Sanitize or set the annotation references.
*
* @param PageInputData $data Page data.
*/
public function sanitizeAnnotRefs(array &$data): void
{
if (empty($data['annotrefs'])) {
$data['annotrefs'] = [];
}
}
/**
* Sanitize or set the page rotation.
* The number of degrees by which the page shall be rotated clockwise when displayed or printed.
* The value shall be a multiple of 90.
*
* @param PageInputData $data Page data.
*/
public function sanitizeRotation(array &$data): void
{
$data['rotation'] = empty($data['rotation']) || ($data['rotation'] % 90 != 0) ? 0 : (int) $data['rotation'];
}
/**
* Sanitize or set the page preferred zoom (magnification) factor.
*
* @param PageInputData $data Page data.
*/
public function sanitizeZoom(array &$data): void
{
$data['zoom'] = empty($data['zoom']) ? 1 : $data['zoom']; // @phpstan-ignore parameterByRef.type
}
/**
* Sanitize or set the page transitions.
*
* @param PageInputData $data Page data.
*
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
* @SuppressWarnings("PHPMD.NPathComplexity")
*/
public function sanitizeTransitions(array &$data): void
{
if (empty($data['transition'])) {
return;
}
// display duration before advancing page
if (empty($data['transition']['Dur'])) {
unset($data['transition']['Dur']);
} else {
$data['transition']['Dur'] = max(0, $data['transition']['Dur']); // @phpstan-ignore parameterByRef.type
}
// transition style
$styles = [
'Split',
'Blinds',
'Box',
'Wipe',
'Dissolve',
'Glitter',
'R',
'Fly',
'Push',
'Cover',
'Uncover',
'Fade',
];
if (empty($data['transition']['S']) || ! in_array($data['transition']['S'], $styles)) {
$data['transition']['S'] = 'R'; // @phpstan-ignore parameterByRef.type
}
// duration of the transition effect, in seconds
$data['transition']['D'] ??= 1; // @phpstan-ignore parameterByRef.type
// dimension in which the specified transition effect shall occur
if (
empty($data['transition']['Dm'])
|| ! in_array($data['transition']['S'], ['Split', 'Blinds'])
|| ! in_array($data['transition']['Dm'], ['H', 'V'])
) {
unset($data['transition']['Dm']); // @phpstan-ignore parameterByRef.type
}
// direction of motion for the specified transition effect
if (
empty($data['transition']['M'])
|| ! in_array($data['transition']['S'], ['Split', 'Box', 'Fly'])
|| ! in_array($data['transition']['M'], ['I', 'O'])
) {
unset($data['transition']['M']); // @phpstan-ignore parameterByRef.type
}
// direction in which the specified transition effect shall moves
if (
empty($data['transition']['Di'])
|| ! in_array($data['transition']['S'], ['Wipe', 'Glitter', 'Fly', 'Cover', 'Uncover', 'Push'])
|| ! in_array($data['transition']['Di'], ['None', 0, 90, 180, 270, 315])
|| (in_array($data['transition']['Di'], [90, 180]) && ($data['transition']['S'] != 'Wipe'))
|| (($data['transition']['Di'] == 315) && ($data['transition']['S'] != 'Glitter'))
|| (($data['transition']['Di'] == 'None') && ($data['transition']['S'] != 'Fly'))
) {
unset($data['transition']['Di']); // @phpstan-ignore parameterByRef.type
}
// If true, the area that shall be flown in is rectangular and opaque
$data['transition']['B'] = ! empty($data['transition']['B']); // @phpstan-ignore parameterByRef.type
}
/**
* Sanitize or set the page margins.
*
* @param PageInputData $data Page data.
*
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
* @SuppressWarnings("PHPMD.NPathComplexity")
*/
public function sanitizeMargins(array &$data): void
{
if (empty($data['margin'])) {
$data['margin'] = ['booklet' => false];
if (empty($data['width']) || empty($data['height'])) {
[$data['width'], $data['height'], $data['orientation']] = $this->getPageFormatSize('A4', 'P');
$data['width'] /= $this->kunit;
$data['height'] /= $this->kunit;
}
}
if (!isset($data['margin']['booklet'])) {
$data['margin']['booklet'] = false;
}
$dataWidth = $data['width'] ?? 0;
$dataHeight = $data['height'] ?? 0;
$margins = [
'PL' => $dataWidth,
'PR' => $dataWidth,
'PT' => $dataHeight,
'HB' => $dataHeight,
'CT' => $dataHeight,
'CB' => $dataHeight,
'FT' => $dataHeight,
'PB' => $dataHeight,
];
if (empty($data['margin'])) {
$data['margin'] = [];
}
foreach ($margins as $type => $max) {
$data['margin'][$type] = ( // @phpstan-ignore parameterByRef.type
empty($data['margin'][$type])
) ? 0 : min(max(0, $data['margin'][$type]), $max);
}
if ($data['margin']['booklet'] && ($this->pid % 2 == 0)) {
// swap margins on odd pages
// NOTE: $this->pid is the previous page (0 indexed).
$mtmp = $data['margin']['PL'];
$data['margin']['PL'] = $data['margin']['PR']; // @phpstan-ignore parameterByRef.type
$data['margin']['PR'] = $mtmp; // @phpstan-ignore parameterByRef.type
}
$data['margin']['PR'] = min( // @phpstan-ignore parameterByRef.type
$data['margin']['PR'],
($dataWidth - $data['margin']['PL'])
);
$data['margin']['HB'] = max( // @phpstan-ignore parameterByRef.type
$data['margin']['HB'],
$data['margin']['PT']
);
$data['margin']['CT'] = max( // @phpstan-ignore parameterByRef.type
$data['margin']['CT'],
$data['margin']['HB']
);
$data['margin']['CB'] = min( // @phpstan-ignore parameterByRef.type
$data['margin']['CB'],
($dataHeight - $data['margin']['CT'])
);
$data['margin']['FT'] = min( // @phpstan-ignore parameterByRef.type
$data['margin']['FT'],
$data['margin']['CB']
);
$data['margin']['PB'] = min( // @phpstan-ignore parameterByRef.type
$data['margin']['PB'],
$data['margin']['FT']
);
$data['ContentWidth'] = ( // @phpstan-ignore parameterByRef.type
$dataWidth - $data['margin']['PL'] - $data['margin']['PR']);
$data['ContentHeight'] = ( // @phpstan-ignore parameterByRef.type
$dataHeight - $data['margin']['CT'] - $data['margin']['CB']);
$data['HeaderHeight'] = ( // @phpstan-ignore parameterByRef.type
$data['margin']['HB'] - $data['margin']['PT']);
$data['FooterHeight'] = ( // @phpstan-ignore parameterByRef.type
$data['margin']['FT'] - $data['margin']['PB']);
}
/**
* Sanitize or set the page regions (columns).
*
* @param PageInputData $data Page data.
*/
public function sanitizeRegions(array &$data): void
{
if (! empty($data['columns'])) {
// set eaual columns
$data['region'] = [];
$width = (($data['ContentWidth'] ?? 0) / ($data['columns'] ?? 1));
for ($idx = 0; $idx < $data['columns']; ++$idx) {
$data['region'][] = [ // @phpstan-ignore parameterByRef.type
'RX' => (($data['margin']['PL'] ?? 0) + ($idx * $width)),
'RY' => ($data['margin']['CT'] ?? 0),
'RW' => $width,
'RH' => ($data['ContentHeight'] ?? 0),
];
}
}
if (empty($data['region'])) {
// default single region
$data['region'] = [[ // @phpstan-ignore parameterByRef.type
'RX' => ($data['margin']['PL'] ?? 0),
'RY' => ($data['margin']['CT'] ?? 0),
'RW' => ($data['ContentWidth'] ?? 0),
'RH' => ($data['ContentHeight'] ?? 0),
]];
}
$data['columns'] = 0; // @phpstan-ignore parameterByRef.type
foreach ($data['region'] as $key => $val) {
// region width
$data['region'][$key]['RW'] = min( // @phpstan-ignore parameterByRef.type
max(
0,
($val['RW'] ?? 0),
),
($data['ContentWidth'] ?? 0)
);
// horizontal coordinate of the top-left corner
$data['region'][$key]['RX'] = min( // @phpstan-ignore parameterByRef.type
max(0, ($val['RX'] ?? 0)),
(($data['width'] ?? 0) - ($data['margin']['PR'] ?? 0) - ($val['RW'] ?? 0))
);
// distance of the region right side from the left page edge
$data['region'][$key]['RL'] = ( // @phpstan-ignore parameterByRef.type
($val['RX'] ?? 0) + ($val['RW'] ?? 0));
// distance of the region right side from the right page edge
$data['region'][$key]['RR'] = ( // @phpstan-ignore parameterByRef.type
($data['width'] ?? 0) - ($val['RX'] ?? 0) - ($val['RW'] ?? 0));
// region height
$data['region'][$key]['RH'] = min( // @phpstan-ignore parameterByRef.type
max(
0,
($val['RH'] ?? 0)
),
($data['ContentHeight'] ?? 0)
);
// vertical coordinate of the top-left corner
$data['region'][$key]['RY'] = min( // @phpstan-ignore parameterByRef.type
max(0, ($val['RY'] ?? 0)),
(($data['height'] ?? 0) - ($data['margin']['CB'] ?? 0) - ($val['RH'] ?? 0))
);
// distance of the region bottom side from the top page edge
$data['region'][$key]['RT'] = ( // @phpstan-ignore parameterByRef.type
($val['RY'] ?? 0) + ($val['RH'] ?? 0));
// distance of the region bottom side from the bottom page edge
$data['region'][$key]['RB'] = ( // @phpstan-ignore parameterByRef.type
($data['height'] ?? 0) - ($val['RY'] ?? 0) - ($val['RH'] ?? 0));
// initialize cursor position inside the region
$data['region'][$key]['x'] = $data['region'][$key]['RX']; // @phpstan-ignore parameterByRef.type
$data['region'][$key]['y'] = $data['region'][$key]['RY']; // @phpstan-ignore parameterByRef.type
++$data['columns']; // @phpstan-ignore parameterByRef.type
}
if (! isset($data['autobreak'])) {
$data['autobreak'] = true; // @phpstan-ignore parameterByRef.type
}
}
/**
* Sanitize or set the page boxes containing the page boundaries.
*
* @param PageInputData $data Page data.
*
* @SuppressWarnings("PHPMD.CyclomaticComplexity")
* @SuppressWarnings("PHPMD.NPathComplexity")
*/
public function sanitizeBoxData(array &$data): void
{
if (empty($data['box'])) {
if (empty($data['pwidth']) || empty($data['pheight'])) {
[$data['pwidth'], $data['pheight'], $data['orientation']] = $this->getPageFormatSize('A4', 'P');
}
$data['box'] = $this->setPageBoxes(($data['pwidth'] ?? 0), ($data['pheight'] ?? 0));
} else {
if (isset($data['format']) && $data['format'] !== '' && ($data['format'] == 'MediaBox')) {
$data['format'] = '';
$data['width'] = abs(
($data['box']['MediaBox']['urx'] ?? 0) - ($data['box']['MediaBox']['llx'] ?? 0)
) / $this->kunit;
$data['height'] = abs(
($data['box']['MediaBox']['ury'] ?? 0) - ($data['box']['MediaBox']['lly'] ?? 0)
) / $this->kunit;
$this->sanitizePageFormat($data);
}
if (empty($data['box']['MediaBox'])) {
$data['box'] = $this->setBox(
$data['box'] ?? $this->setPageBoxes( // @phpstan-ignore argument.type
($data['pwidth'] ?? 0),
($data['pheight'] ?? 0)
),
'MediaBox',
0,
0,
($data['pwidth'] ?? 0),
($data['pheight'] ?? 0),
);
}
if (empty($data['box']['CropBox'])) {
$data['box'] = $this->setBox(
$data['box'], // @phpstan-ignore argument.type
'CropBox',
($data['box']['MediaBox']['llx'] ?? 0),
($data['box']['MediaBox']['lly'] ?? 0),
($data['box']['MediaBox']['urx'] ?? 0),
($data['box']['MediaBox']['ury'] ?? 0),
);
}
if (empty($data['box']['BleedBox'])) {
$data['box'] = $this->setBox(
$data['box'], // @phpstan-ignore argument.type
'BleedBox',
($data['box']['CropBox']['llx'] ?? 0),
($data['box']['CropBox']['lly'] ?? 0),
($data['box']['CropBox']['urx'] ?? 0),
($data['box']['CropBox']['ury'] ?? 0),
);
}
if (empty($data['box']['TrimBox'])) {
$data['box'] = $this->setBox(
$data['box'], // @phpstan-ignore argument.type
'TrimBox',
($data['box']['CropBox']['llx'] ?? 0),
($data['box']['CropBox']['lly'] ?? 0),
($data['box']['CropBox']['urx'] ?? 0),
($data['box']['CropBox']['ury'] ?? 0),
);
}
if (empty($data['box']['ArtBox'])) {
$data['box'] = $this->setBox(
$data['box'], // @phpstan-ignore argument.type
'ArtBox',
($data['box']['CropBox']['llx'] ?? 0),
($data['box']['CropBox']['lly'] ?? 0),
($data['box']['CropBox']['urx'] ?? 0),
($data['box']['CropBox']['ury'] ?? 0),
);
}
}
$orientation = $this->getPageOrientation(
abs(
($data['box']['MediaBox']['urx'] ?? 0) - ($data['box']['MediaBox']['llx'] ?? 0)
),
abs(
($data['box']['MediaBox']['ury'] ?? 0) - ($data['box']['MediaBox']['lly'] ?? 0)
)
);
if (empty($data['orientation'])) {
$data['orientation'] = $orientation;
} elseif ($data['orientation'] != $orientation) {
$data['box'] = $this->swapCoordinates($data['box']); // @phpstan-ignore argument.type
}
}
/**
* Sanitize or set the page format.
*
* @param PageInputData $data Page data.
*/
public function sanitizePageFormat(array &$data): void
{
if (empty($data['orientation'])) {
$data['orientation'] = '';
}
if (! empty($data['format'])) {
[$data['pwidth'], $data['pheight'], $data['orientation']] = $this->getPageFormatSize(
$data['format'],
$data['orientation']
);
$data['width'] = ($data['pwidth'] / $this->kunit);
$data['height'] = ($data['pheight'] / $this->kunit);
} else {
$data['format'] = 'CUSTOM';
if (empty($data['width']) || empty($data['height'])) {
// default page format
$data['format'] = 'A4';
$data['orientation'] = 'P';
$this->sanitizePageFormat($data);
return;
}
[$data['width'], $data['height'], $data['orientation']] = $this->getPageOrientedSize(
$data['width'],
$data['height'],
$data['orientation']
);
}
// convert values in points
$data['pwidth'] = ($data['width'] * $this->kunit);
$data['pheight'] = ($data['height'] * $this->kunit);
}
}