diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..0a04128 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..26bc6d7 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# PDF_Label + +This class is a modified version of `PDF_Label` that adds support for +unicode and ttf. + +Documentation and source for the upstream class can be found here: +http://www.fpdf.org/en/script/script29.php + + +## Installation with [Composer](https://packagist.org/packages/rocketman/pdf-label) + +If you are using composer to manage dependencies, you can use + + $ composer require rocketman/pdf-label:1.6+rocketman.1 + +or you can include the following in your `composer.json` file: + +```json +{ + "require": { + "rocketman/pdf-label": "1.6+rocketman.1" + } +} +``` + +## Usage + +```php +$label = "5160"; // pre-defined label name or form-spec array +$pdf = new \PDF_Label($label); +$pdf->AddFont(...); // see tFPDF documentation for AddFont and SetFont +$pdf->SetFont(...); +$pdf->AddPage(); +$pdf->Add_Label("label content here"); +$pdf->Add_Label("second label"); +$pdf->Output(); +``` diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..b1144e6 --- /dev/null +++ b/composer.json @@ -0,0 +1,26 @@ +{ + "name": "rocketman/pdf-label", + "description": "This class is a modified version of PDF_Label that adds support for unicode and ttf.", + "license": "LGPL-3.0-or-later", + "authors": [ + { + "name": "Jim Mason", + "email": "jmason@ibinx.com" + }, + { + "name": "Laurent PASSEBECQ (LPA)" + }, + { + "name": "Steve Dillon" + } + ], + "type": "library", + "autoload": { + "classmap": [ + "src/PDF_Label.php" + ] + }, + "require": { + "setasign/tfpdf": "^1.32" + } +} diff --git a/src/PDF_Label.php b/src/PDF_Label.php new file mode 100644 index 0000000..52b88b8 --- /dev/null +++ b/src/PDF_Label.php @@ -0,0 +1,209 @@ + Now, just modify the size of the font +// 1.3: + Labels are now printed horizontally +// = 'in' as document unit didn't work +// 1.4: + Page scaling is disabled in printing options +// 1.5: + Added 3422 format +// 1.6: + FPDF 1.8 compatibility +// 1.6+rocketman.1: +// + Migrated from FPDF to tFPDF (for unicode and ttf) +// + Added optional orientation property to format descriptor +////////////////////////////////////////////////////////////////////////////// + +/** + * PDF_Label - PDF label maker with support for unicode and ttf + * @author Jim Mason + * @copyright 2021 Jim Mason + * @author Laurent PASSEBECQ + * @copyright 2003 Laurent PASSEBECQ + * @license https://www.gnu.org/licenses/lgpl-3.0.html + */ +class PDF_Label extends tFPDF { + // Private properties + protected $_Margin_Left; // Left margin of labels + protected $_Margin_Top; // Top margin of labels + protected $_X_Space; // Horizontal space between 2 labels + protected $_Y_Space; // Vertical space between 2 labels + protected $_X_Number; // Number of labels horizontally + protected $_Y_Number; // Number of labels vertically + protected $_Width; // Width of label + protected $_Height; // Height of label + protected $_Line_Height; // Line height + protected $_Padding; // Padding + protected $_Metric_Doc; // Type of metric for the document + protected $_COUNTX; // Current x position + protected $_COUNTY; // Current y position + + // List of label formats + protected $_Avery_Labels = array( + '5160' => array('paper-size'=>'letter', 'metric'=>'mm', + 'marginLeft'=>1.762, 'marginTop'=>10.7, + 'NX'=>3, 'NY'=>10, + 'SpaceX'=>3.175, 'SpaceY'=>0, + 'width'=>66.675, 'height'=>25.4, 'font-size'=>8), + '5161' => array('paper-size'=>'letter', 'metric'=>'mm', + 'marginLeft'=>8,/*0.967,*/ 'marginTop'=>10.7, + 'NX'=>2, 'NY'=>10, + 'SpaceX'=>3.967, 'SpaceY'=>0, + 'width'=>101.6, 'height'=>25.4, 'font-size'=>8), + '5162' => array('paper-size'=>'letter', 'metric'=>'mm', + 'marginLeft'=>0.97, 'marginTop'=>20.224, + 'NX'=>2, 'NY'=>7, + 'SpaceX'=>4.762, 'SpaceY'=>0, + 'width'=>100.807, 'height'=>35.72, 'font-size'=>8), + '5163' => array('paper-size'=>'letter', 'metric'=>'mm', + 'marginLeft'=>1.762, 'marginTop'=>10.7, + 'NX'=>2, 'NY'=>5, + 'SpaceX'=>3.175, 'SpaceY'=>0, + 'width'=>101.6, 'height'=>50.8, 'font-size'=>8), + '5164' => array('paper-size'=>'letter', 'metric'=>'in', + 'marginLeft'=>0.148, 'marginTop'=>0.5, + 'NX'=>2, 'NY'=>3, + 'SpaceX'=>0.2031, 'SpaceY'=>0, + 'width'=>4.0, 'height'=>3.33, 'font-size'=>12), + '8600' => array('paper-size'=>'letter', 'metric'=>'mm', + 'marginLeft'=>7.1, 'marginTop'=>19, + 'NX'=>3, 'NY'=>10, + 'SpaceX'=>9.5, 'SpaceY'=>3.1, + 'width'=>66.6, 'height'=>25.4, 'font-size'=>8), + 'L7163'=> array('paper-size'=>'A4', 'metric'=>'mm', + 'marginLeft'=>5, 'marginTop'=>15, + 'NX'=>2, 'NY'=>7, + 'SpaceX'=>25, 'SpaceY'=>0, + 'width'=>99.1, 'height'=>38.1, + 'font-size'=>9), + '3422' => array('paper-size'=>'A4', 'metric'=>'mm', + 'marginLeft'=>0, 'marginTop'=>8.5, + 'NX'=>3, 'NY'=>8, + 'SpaceX'=>0, 'SpaceY'=>0, + 'width'=>70, 'height'=>35, 'font-size'=>9) + ); + + // Constructor + function __construct($format, $unit='mm', $posX=1, $posY=1) { + if (is_array($format)) { + // Custom format + $Tformat = $format; + } else { + // Built-in format + if (!isset($this->_Avery_Labels[$format])) + $this->Error('Unknown label format: '.$format); + $Tformat = $this->_Avery_Labels[$format]; + } + + $orientation = isset($Tformat['orientation'])? + $Tformat['orientation']:'P'; + + parent::__construct($orientation, $unit, $Tformat['paper-size']); + $this->_Metric_Doc = $unit; + $this->_Set_Format($Tformat); + $this->SetFont('Arial'); + $this->SetMargins(0,0); + $this->SetAutoPageBreak(false); + $this->_COUNTX = $posX-2; + $this->_COUNTY = $posY-1; + } + + function _Set_Format($format) { + $this->_Margin_Left = $this->_Convert_Metric($format['marginLeft'], $format['metric']); + $this->_Margin_Top = $this->_Convert_Metric($format['marginTop'], $format['metric']); + $this->_X_Space = $this->_Convert_Metric($format['SpaceX'], $format['metric']); + $this->_Y_Space = $this->_Convert_Metric($format['SpaceY'], $format['metric']); + $this->_X_Number = $format['NX']; + $this->_Y_Number = $format['NY']; + $this->_Width = $this->_Convert_Metric($format['width'], $format['metric']); + $this->_Height = $this->_Convert_Metric($format['height'], $format['metric']); + $this->Set_Font_Size($format['font-size']); + $this->_Padding = $this->_Convert_Metric(3, 'mm'); + } + + // convert units (in to mm, mm to in) + // $src must be 'in' or 'mm' + function _Convert_Metric($value, $src) { + $dest = $this->_Metric_Doc; + if ($src != $dest) { + $a['in'] = 39.37008; + $a['mm'] = 1000; + return $value * $a[$dest] / $a[$src]; + } else { + return $value; + } + } + + // Give the line height for a given font size + function _Get_Height_Chars($pt) { + $a = array(6=>2, 7=>2.5, 8=>3, 9=>4, 10=>5, 11=>6, 12=>7, 13=>8, 14=>9, 15=>10); + if (!isset($a[$pt])) + $this->Error('Invalid font size: '.$pt); + return $this->_Convert_Metric($a[$pt], 'mm'); + } + + // Set the character size + // This changes the line height too + function Set_Font_Size($pt) { + $this->_Line_Height = $this->_Get_Height_Chars($pt); + $this->SetFontSize($pt); + } + + // Print a label + function Add_Label($text) { + $this->_COUNTX++; + if ($this->_COUNTX == $this->_X_Number) { + // Row full, we start a new one + $this->_COUNTX=0; + $this->_COUNTY++; + if ($this->_COUNTY == $this->_Y_Number) { + // End of page reached, we start a new one + $this->_COUNTY=0; + $this->AddPage(); + } + } + + $_PosX = $this->_Margin_Left + $this->_COUNTX*($this->_Width+$this->_X_Space) + $this->_Padding; + $_PosY = $this->_Margin_Top + $this->_COUNTY*($this->_Height+$this->_Y_Space) + $this->_Padding; + $this->SetXY($_PosX, $_PosY); + $this->MultiCell($this->_Width - $this->_Padding, $this->_Line_Height, $text, 0, 'L'); + } + + function _putcatalog() + { + parent::_putcatalog(); + // Disable the page scaling option in the printing dialog + $this->_put('/ViewerPreferences <>'); + } +}