C4/Barcodes/PrinterConfig.pm

   1 package C4::Barcodes::PrinterConfig;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 2 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along with
  15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  16 # Suite 330, Boston, MA  02111-1307 USA
  17
  18 use strict;
  19 #use warnings; FIXME - Bug 2505
  20 use vars qw($VERSION @EXPORT);
  21
  22 use PDF::API2;
  23 use PDF::API2::Page;
  24
  25 BEGIN {
  26         # set the version for version checking
  27         $VERSION = 0.02;
  28         require Exporter;
  29         @EXPORT = qw(&labelsPage &getLabelPosition setPositionsForX setPositionsForY);
  30 }
  31
  32 =head1 NAME
  33
  34 C4::Barcodes::PrinterConfig - Koha module dealing with labels in a PDF.
  35
  36 =head1 SYNOPSIS
  37
  38 use C4::Barcodes::PrinterConfig;
  39
  40 =head1 DESCRIPTION
  41
  42 This package is used to deal with labels in a pdf file. Giving some parameters,
  43 this package contains several functions to handle every label considering the
  44 environment of the pdf file.
  45
  46 =head1 FUNCTIONS
  47
  48 =head2 my @positionsForX;
  49
  50 Takes all the X positions of the pdf file.
  51
  52 =head2 my @positionsForY;
  53
  54 Takes all the Y positions of the pdf file.
  55
  56 =head2 my $firstLabel = 1;
  57
  58 Test if the label passed as a parameter is the first label to be printed into the pdf file.
  59
  60 =head2 setPositionsForX
  61
  62   C4::Barcodes::PrinterConfig::setPositionsForX($marginLeft, $labelWidth, $columns, $pageType);
  63
  64 Calculate and stores all the X positions across the pdf page.
  65
  66 C<$marginLeft> Indicates how much left margin do you want in your page type.
  67
  68 C<$labelWidth> Indicates the width of the label that you are going to use.
  69
  70 C<$columns> Indicates how many columns do you want in your page type.
  71
  72 C<$pageType> Page type to print (eg: a4, legal, etc).
  73
  74 =cut
  75
  76 sub setPositionsForX {
  77         my ($marginLeft, $labelWidth, $columns, $pageType) = @_;
  78         my $defaultDpi = 72/25.4; # By default we know 25.4 mm -> 1 inch -> 72 dots per inch
  79         my $whereToStart = ($marginLeft + ($labelWidth/2));
  80         my $firstLabel = $whereToStart*$defaultDpi;
  81         my $spaceBetweenLabels = $labelWidth*$defaultDpi;
  82         my @positions;
  83         for (my $i = 0; $i < $columns ; $i++) {
  84                 push @positions, ($firstLabel+($spaceBetweenLabels*$i));
  85         }
  86         @positionsForX = @positions;
  87 }
  88
  89 =head2 setPositionsForY
  90
  91   C4::Barcodes::PrinterConfig::setPositionsForY($marginBottom, $labelHeigth, $rows, $pageType);
  92
  93 Calculate and stores all tha Y positions across the pdf page.
  94
  95 C<$marginBottom> Indicates how much bottom margin do you want in your page type.
  96
  97 C<$labelHeigth> Indicates the height of the label that you are going to use.
  98
  99 C<$rows> Indicates how many rows do you want in your page type.
 100
 101 C<$pageType> Page type to print (eg: a4, legal, etc).
 102
 103 =cut
 104
 105 sub setPositionsForY {
 106         my ($marginBottom, $labelHeigth, $rows, $pageType) = @_;
 107         my $defaultDpi = 72/25.4; # By default we know 25.4 mm -> 1 inch -> 72 dots per inch
 108         my $whereToStart = ($marginBottom + ($labelHeigth/2));
 109         my $firstLabel = $whereToStart*$defaultDpi;
 110         my $spaceBetweenLabels = $labelHeigth*$defaultDpi;
 111         my @positions;
 112         for (my $i = 0; $i < $rows; $i++) {
 113                 unshift @positions, ($firstLabel+($spaceBetweenLabels*$i));
 114         }
 115         @positionsForY = @positions;
 116 }
 117
 118 =head2 getLabelPosition
 119
 120   (my $x, my $y, $pdfObject, $pageObject, $gfxObject, $textObject, $coreObject, $labelPosition) =
 121      C4::Barcodes::PrinterConfig::getLabelPosition($labelPosition, $pdfObject, $page, $gfx, $text, $fontObject, $pageType);
 122
 123 Return the (x,y) position of the label that you are going to print considering the environment.
 124
 125 C<$labelPosition> Indicates which label positions do you want to place by x and y coordinates.
 126
 127 C<$pdfObject> The PDF object in use.
 128
 129 C<$page> The page in use.
 130
 131 C<$gfx> The gfx resource to handle with barcodes objects.
 132
 133 C<$text> The text resource to handle with text.
 134
 135 C<$fontObject> The font object
 136
 137 C<$pageType> Page type to print (eg: a4, legal, etc).
 138
 139 =cut
 140
 141 sub getLabelPosition {
 142         my ($labelNum, $pdf, $page, $gfxObject, $textObject, $fontObject, $pageType) = @_;
 143         my $indexX = $labelNum % @positionsForX;
 144         my $indexY = int($labelNum / @positionsForX);
 145         # Calculates the next label position and return that label number
 146         my $nextIndexX = $labelNum % @positionsForX;
 147         my $nextIndexY = $labelNum % @positionsForY;
 148         if ($firstLabel) {
 149           $page = $pdf->page;
 150           $page->mediabox($pageType);
 151           $gfxObject = $page->gfx;
 152           $textObject = $page->text;
 153           $textObject->font($fontObject, 7);
 154                   $firstLabel = 0;
 155         } elsif (($nextIndexX == 0) && ($nextIndexY == 0)) {
 156           $page = $pdf->page;
 157           $page->mediabox($pageType);
 158           $gfxObject = $page->gfx;
 159           $textObject = $page->text;
 160           $textObject->font($fontObject, 7);
 161         }
 162         $labelNum = $labelNum + 1;
 163         if ($labelNum == (@positionsForX*@positionsForY)) {
 164                 $labelNum = 0;
 165         }
 166         return ($positionsForX[$indexX], $positionsForY[$indexY], $pdf, $page, $gfxObject, $textObject, $fontObject, $labelNum);
 167 }
 168
 169 =head2 labelsPage
 170
 171   my @labelTable = C4::Barcodes::PrinterConfig::labelsPage($rows, $columns);
 172
 173 This function will help you to build the labels panel, where you can choose
 174 wich label position do you want to start the printer process.
 175
 176 C<$rows> Indicates how many rows do you want in your page type.
 177
 178 C<$columns> Indicates how many rows do you want in your page type.
 179
 180 =cut
 181
 182 sub labelsPage{
 183         my ($rows, $columns) = @_;
 184         my @pageType;
 185         my $tagname = 0;
 186         my $labelname = 1;
 187         my $check;
 188         for (my $i = 1; $i <= $rows; $i++) {
 189                 my @column;
 190                 for (my $j = 1; $j <= $columns; $j++) {
 191                         my %cell;
 192                         if ($tagname == 0) {
 193                                 $check = 'checked';
 194                         } else {
 195                                 $check = '';
 196                         }
 197                         %cell = (check => $check,
 198                                          tagname => $tagname,
 199                                  labelname => $labelname);
 200                         $tagname = $tagname + 1;
 201                         $labelname = $labelname + 1;
 202                         push @column, \%cell;
 203                 }
 204                 my %columns = (columns => \@column);
 205                 push @pageType, \%columns;
 206         }
 207         return @pageType;
 208 }
 209
 210 1;
 211
 212 __END__
 213
 214 =head1 AUTHOR
 215
 216 Koha Physics Library UNLP <matias_veleda@hotmail.com>
 217
 218 =cut