1 package C4::Labels::Label;
7 use Algorithm::CheckDigits;
10 use Library::CallNumber::LC;
17 use version; our $VERSION = qv('3.07.00.049');
20 my $possible_decimal = qr/\d{3,}(?:\.\d+)?/; # at least three digits for a DDCN
23 my $given_params = {};
25 my @valid_label_params = (
47 foreach my $key (keys %{$given_params}) {
48 if (!(grep m/$key/, @valid_label_params)) {
49 warn sprintf('Unrecognized parameter type of "%s".', $key);
55 if (!(grep m/$_/, @valid_label_params)) {
56 warn sprintf('Unrecognized parameter type of "%s".', $_);
64 my ( $llx, $lly, $width, $height ) = @_;
65 return unless ( defined $llx and defined $lly and
66 defined $width and defined $height );
67 my $obj_stream = "q\n"; # save the graphic state
68 $obj_stream .= "0.5 w\n"; # border line width
69 $obj_stream .= "1.0 0.0 0.0 RG\n"; # border color red
70 $obj_stream .= "1.0 1.0 1.0 rg\n"; # fill color white
71 $obj_stream .= "$llx $lly $width $height re\n"; # a rectangle
72 $obj_stream .= "B\n"; # fill (and a little more)
73 $obj_stream .= "Q\n"; # restore the graphic state
78 my $item_number = shift;
79 my $barcode_only = shift || 0;
80 my $dbh = C4::Context->dbh;
81 # FIXME This makes for a very bulky data structure; data from tables w/duplicate col names also gets overwritten.
82 # Something like this, perhaps, but this also causes problems because we need more fields sometimes.
83 # SELECT i.barcode, i.itemcallnumber, i.itype, bi.isbn, bi.issn, b.title, b.author
84 my $sth = $dbh->prepare("SELECT bi.*, i.*, b.*,br.* FROM items AS i, biblioitems AS bi ,biblio AS b, branches AS br WHERE itemnumber=? AND i.biblioitemnumber=bi.biblioitemnumber AND bi.biblionumber=b.biblionumber AND i.homebranch=br.branchcode;");
85 $sth->execute($item_number);
87 warn sprintf('Database returned the following error: %s', $sth->errstr);
89 my $data = $sth->fetchrow_hashref;
90 # Replaced item's itemtype with the more user-friendly description...
91 my $sth1 = $dbh->prepare("SELECT itemtype,description FROM itemtypes WHERE itemtype = ?");
92 $sth1->execute($data->{'itemtype'});
94 warn sprintf('Database returned the following error: %s', $sth1->errstr);
96 my $data1 = $sth1->fetchrow_hashref;
97 $data->{'itemtype'} = $data1->{'description'};
98 $data->{'itype'} = $data1->{'description'};
99 $barcode_only ? return $data->{'barcode'} : return $data;
102 sub _get_text_fields {
103 my $format_string = shift;
104 my $csv = Text::CSV_XS->new({allow_whitespace => 1});
105 my $status = $csv->parse($format_string);
106 my @sorted_fields = map {{ 'code' => $_, desc => $_ }}
107 map { $_ eq 'callnumber' ? 'itemcallnumber' : $_ } # see bug 5653
109 my $error = $csv->error_input();
110 warn sprintf('Text field sort failed with this error: %s', $error) if $error;
111 return \@sorted_fields;
118 # lccn examples: 'HE8700.7 .P6T44 1983', 'BS2545.E8 H39 1996';
119 my @parts = Library::CallNumber::LC->new($lccn)->components();
120 unless (scalar @parts && defined $parts[0]) {
121 warn sprintf('regexp failed to match string: %s', $_);
122 @parts = $_; # if no match, just use the whole string.
124 push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
125 $debug and warn "split_lccn array: ", join(" | ", @parts), "\n";
132 s/\///g; # in theory we should be able to simply remove all segmentation markers and arrive at the correct call number...
134 ^([-a-zA-Z]*\s?(?:$possible_decimal)?) # R220.3 CD-ROM 787.87 # will require extra splitting
136 (.+) # H2793Z H32 c.2 EAS # everything else (except bracketing spaces)
139 unless (scalar @parts) {
140 warn sprintf('regexp failed to match string: %s', $_);
141 push @parts, $_; # if no match, just push the whole string.
144 if ($parts[0] =~ /^([-a-zA-Z]+)\s?($possible_decimal)$/) {
145 shift @parts; # pull off the mathching first element, like example 1
146 unshift @parts, $1, $2; # replace it with the two pieces
149 push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
150 $debug and print STDERR "split_ddcn array: ", join(" | ", @parts), "\n";
154 ## NOTE: Custom call number types go here. It may be necessary to create additional splitting algorithms if some custom call numbers
155 ## cannot be made to work here. Presently this splits standard non-ddcn, non-lccn fiction and biography call numbers.
160 # Split call numbers based on spaces
161 push @parts, split /\s+/, $fcn; # split the call number into an arbitrary number of pieces at spaces
162 if ($parts[-1] !~ /^.*\d-\d.*$/ && $parts[-1] =~ /^(.*\d+)(\D.*)$/) {
163 pop @parts; # pull off the matching last element
164 push @parts, $1, $2; # replace it with the two pieces
166 unless (scalar @parts) {
167 warn sprintf('regexp failed to match string: %s', $_);
170 $debug and print STDERR "split_ccn array: ", join(" | ", @parts), "\n";
174 sub _get_barcode_data {
175 my ( $f, $item, $record ) = @_;
176 my $kohatables = _desc_koha_tables();
178 my $match_kohatable = join(
181 @{ $kohatables->{'biblio'} },
182 @{ $kohatables->{'biblioitems'} },
183 @{ $kohatables->{'items'} },
184 @{ $kohatables->{'branches'} }
191 if ( $f =~ /^'(.*)'.*/ ) {
192 # single quotes indicate a static text string.
197 elsif ( $f =~ /^($match_kohatable).*/ ) {
199 $datastring .= $item->{$f};
201 $debug and warn sprintf("The '%s' field contains no data.", $f);
206 elsif ( $f =~ /^([0-9a-z]{3})(\w)(\W?).*?/ ) {
207 my ($field,$subf,$ws) = ($1,$2,$3);
209 my ($itemtag, $itemsubfieldcode) = &GetMarcFromKohaField("items.itemnumber",'');
210 my @marcfield = $record->field($field);
212 if($field eq $itemtag) { # item-level data, we need to get the right item.
214 foreach my $itemfield (@marcfield) {
215 if ( $itemfield->subfield($itemsubfieldcode) eq $item->{'itemnumber'} ) {
216 if ($itemfield->subfield($subf)) {
217 $datastring .= $itemfield->subfield($subf) . $ws;
220 warn sprintf("The '%s' field contains no data.", $f);
225 } else { # bib-level data, we'll take the first matching tag/subfield.
226 if ($marcfield[0]->subfield($subf)) {
227 $datastring .= $marcfield[0]->subfield($subf) . $ws;
230 warn sprintf("The '%s' field contains no data.", $f);
238 warn sprintf('Failed to parse label format string: %s', $f);
239 last FIELD_LIST; # Failed to match
245 sub _desc_koha_tables {
246 my $dbh = C4::Context->dbh();
248 for my $table ( 'biblio','biblioitems','items','branches' ) {
249 my $sth = $dbh->column_info(undef,undef,$table,'%');
250 while (my $info = $sth->fetchrow_hashref()){
251 push @{$kohatables->{$table}} , $info->{'COLUMN_NAME'} ;
258 ### This series of functions calculates the position of text and barcode on individual labels
259 ### Please *do not* add printing types which are non-atomic. Instead, build code which calls the necessary atomic printing types to form the non-atomic types. See the ALT type
260 ### in labels/label-create-pdf.pl as an example.
261 ### NOTE: Each function must be passed seven parameters and return seven even if some are 0 or undef
265 my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
266 my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
267 return $self->{'llx'}, $text_lly, $line_spacer, 0, 0, 0, 0;
272 my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the left edge of the label ($llx)
273 my $barcode_lly = $self->{'lly'} + $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance above the bottom of the label ($lly)
274 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
275 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
276 return 0, 0, 0, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
281 my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the left edge of the label ($self->{'llx'})
282 my $barcode_lly = $self->{'lly'} + $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance above the bottom of the label ($lly)
283 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
284 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
285 my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
286 my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
287 $debug and warn "Label: llx $self->{'llx'}, lly $self->{'lly'}, Text: lly $text_lly, $line_spacer, Barcode: llx $barcode_llx, lly $barcode_lly, $barcode_width, $barcode_y_scale_factor\n";
288 return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
293 my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the left edge of the label ($self->{'llx'})
294 my $barcode_lly = ($self->{'lly'} + $self->{'height'}) - $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance below the top of the label ($self->{'lly'})
295 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
296 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
297 my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
298 my $text_lly = (($self->{'lly'} + $self->{'height'}) - $self->{'top_text_margin'} - (($self->{'lly'} + $self->{'height'}) - $barcode_lly));
299 return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
303 my ($invocant, %params) = @_;
304 my $type = ref($invocant) || $invocant;
306 batch_id => $params{'batch_id'},
307 item_number => $params{'item_number'},
308 llx => $params{'llx'},
309 lly => $params{'lly'},
310 height => $params{'height'},
311 width => $params{'width'},
312 top_text_margin => $params{'top_text_margin'},
313 left_text_margin => $params{'left_text_margin'},
314 barcode_type => $params{'barcode_type'},
315 printing_type => $params{'printing_type'},
316 guidebox => $params{'guidebox'},
317 font => $params{'font'},
318 font_size => $params{'font_size'},
319 callnum_split => $params{'callnum_split'},
320 justify => $params{'justify'},
321 format_string => $params{'format_string'},
322 text_wrap_cols => $params{'text_wrap_cols'},
325 if ($self->{'guidebox'}) {
326 $self->{'guidebox'} = _guide_box($self->{'llx'}, $self->{'lly'}, $self->{'width'}, $self->{'height'});
328 bless ($self, $type);
334 return $self->{'printing_type'};
339 if (_check_params(@_) eq 1) {
343 if (exists($self->{$attr})) {
344 return $self->{$attr};
355 my ($text_llx, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor);
358 ($text_llx, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor) = &{"_$self->{'printing_type'}"}($self); # an obfuscated call to the correct printing type sub
360 if ($self->{'printing_type'} =~ /BIB/) {
361 $label_text = draw_label_text( $self,
364 line_spacer => $line_spacer,
367 if ($self->{'printing_type'} =~ /BAR/) {
371 width => $barcode_width,
372 y_scale_factor => $barcode_y_scale_factor,
375 return $label_text if $label_text;
379 sub draw_label_text {
380 my ($self, %params) = @_;
383 my $text_lly = $params{'lly'};
384 my $font = $self->{'font'};
385 my $item = _get_label_item($self->{'item_number'});
386 my $label_fields = _get_text_fields($self->{'format_string'});
387 my $record = GetMarcBiblio($item->{'biblionumber'});
388 # FIXME - returns all items, so you can't get data from an embedded holdings field.
389 # TODO - add a GetMarcBiblio1item(bibnum,itemnum) or a GetMarcItem(itemnum).
390 my $cn_source = ($item->{'cn_source'} ? $item->{'cn_source'} : C4::Context->preference('DefaultClassificationSource'));
391 LABEL_FIELDS: # process data for requested fields on current label
392 for my $field (@$label_fields) {
393 if ($field->{'code'} eq 'itemtype') {
394 $field->{'data'} = C4::Context->preference('item-level_itypes') ? $item->{'itype'} : $item->{'itemtype'};
397 $field->{'data'} = _get_barcode_data($field->{'code'},$item,$record);
399 ($field->{'code'} eq 'title') ? (($font =~ /T/) ? ($font = 'TI') : ($font = ($font . 'O'))) : ($font = $font);
400 my $field_data = $field->{'data'};
402 $field_data =~ s/\n//g;
403 $field_data =~ s/\r//g;
406 # Fields which hold call number data FIXME: ( 060? 090? 092? 099? )
407 my @callnumber_list = qw(itemcallnumber 050a 050b 082a 952o 995k);
408 if ((grep {$field->{'code'} =~ m/$_/} @callnumber_list) and ($self->{'printing_type'} eq 'BIB') and ($self->{'callnum_split'})) { # If the field contains the call number, we do some sp
409 if ($cn_source eq 'lcc' || $cn_source eq 'nlm') { # NLM and LCC should be split the same way
410 @label_lines = _split_lccn($field_data);
411 @label_lines = _split_ccn($field_data) if !@label_lines; # If it was not a true lccn, try it as a custom call number
412 push (@label_lines, $field_data) if !@label_lines; # If it was not that, send it on unsplit
413 } elsif ($cn_source eq 'ddc') {
414 @label_lines = _split_ddcn($field_data);
415 @label_lines = _split_ccn($field_data) if !@label_lines;
416 push (@label_lines, $field_data) if !@label_lines;
418 warn sprintf('Call number splitting failed for: %s. Please add this call number to bug #2500 at bugs.koha-community.org', $field_data);
419 push @label_lines, $field_data;
424 $field_data =~ s/\/$//g; # Here we will strip out all trailing '/' in fields other than the call number...
425 $field_data =~ s/\(/\\\(/g; # Escape '(' and ')' for the pdf object stream...
426 $field_data =~ s/\)/\\\)/g;
428 eval{$Text::Wrap::columns = $self->{'text_wrap_cols'};};
429 my @line = split(/\n/ ,wrap('', '', $field_data));
430 # If this is a title field, limit to two lines; all others limit to one... FIXME: this is rather arbitrary
431 if ($field->{'code'} eq 'title' && scalar(@line) >= 2) {
432 while (scalar(@line) > 2) {
436 while (scalar(@line) > 1) {
440 push(@label_lines, @line);
442 LABEL_LINES: # generate lines of label text for current field
443 foreach my $line (@label_lines) {
444 next LABEL_LINES if $line eq '';
445 my $string_width = C4::Creators::PDF->StrWidth($line, $font, $self->{'font_size'});
446 if ($self->{'justify'} eq 'R') {
447 $text_llx = $params{'llx'} + $self->{'width'} - ($self->{'left_text_margin'} + $string_width);
449 elsif($self->{'justify'} eq 'C') {
450 # some code to try and center each line on the label based on font size and string point width...
451 my $whitespace = ($self->{'width'} - ($string_width + (2 * $self->{'left_text_margin'})));
452 $text_llx = (($whitespace / 2) + $params{'llx'} + $self->{'left_text_margin'});
455 $text_llx = ($params{'llx'} + $self->{'left_text_margin'});
458 text_llx => $text_llx,
459 text_lly => $text_lly,
461 font_size => $self->{'font_size'},
464 $text_lly = $text_lly - $params{'line_spacer'};
466 $font = $self->{'font'}; # reset font for next field
472 return $_[0]->{'guidebox'};
478 $params{'barcode_data'} = _get_label_item($self->{'item_number'}, 1) if !$params{'barcode_data'};
479 $params{'barcode_type'} = $self->{'barcode_type'} if !$params{'barcode_type'};
480 my $x_scale_factor = 1;
481 my $num_of_bars = length($params{'barcode_data'});
482 my $tot_bar_length = 0;
484 my $guard_length = 10;
485 my $hide_text = 'yes';
486 if ($params{'barcode_type'} =~ m/CODE39/) {
487 $bar_length = '17.5';
488 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
489 $x_scale_factor = ($params{'width'} / $tot_bar_length);
490 if ($params{'barcode_type'} eq 'CODE39MOD') {
491 my $c39 = CheckDigits('code_39'); # get modulo43 checksum
492 $params{'barcode_data'} = $c39->complete($params{'barcode_data'});
494 elsif ($params{'barcode_type'} eq 'CODE39MOD10') {
495 my $c39_10 = CheckDigits('siret'); # get modulo43 checksum
496 $params{'barcode_data'} = $c39_10->complete($params{'barcode_data'});
500 PDF::Reuse::Barcode::Code39(
503 value => "*$params{barcode_data}*",
504 xSize => $x_scale_factor,
505 ySize => $params{'y_scale_factor'},
512 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
515 elsif ($params{'barcode_type'} eq 'COOP2OF5') {
516 $bar_length = '9.43333333333333';
517 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
518 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
520 PDF::Reuse::Barcode::COOP2of5(
523 value => "*$params{barcode_data}*",
524 xSize => $x_scale_factor,
525 ySize => $params{'y_scale_factor'},
530 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
533 elsif ( $params{'barcode_type'} eq 'INDUSTRIAL2OF5' ) {
534 $bar_length = '13.1333333333333';
535 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
536 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
538 PDF::Reuse::Barcode::Industrial2of5(
541 value => "*$params{barcode_data}*",
542 xSize => $x_scale_factor,
543 ySize => $params{'y_scale_factor'},
548 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
551 elsif ($params{'barcode_type'} eq 'EAN13') {
552 $bar_length = 4; # FIXME
554 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
555 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
557 PDF::Reuse::Barcode::EAN13(
560 value => sprintf('%013d',$params{barcode_data}),
561 # xSize => $x_scale_factor,
562 # ySize => $params{'y_scale_factor'},
567 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
571 warn "unknown barcode_type: $params{barcode_type}";
577 my $label_fields = _get_text_fields($self->{'format_string'});
578 my $item = _get_label_item($self->{'item_number'});
579 my $bib_record = GetMarcBiblio($item->{biblionumber});
580 my @csv_data = (map { _get_barcode_data($_->{'code'},$item,$bib_record) } @$label_fields);
589 C4::Labels::Label - A class for creating and manipulating label objects in Koha
593 This module provides methods for creating, and otherwise manipulating single label objects used by Koha to create and export labels.
599 Invoking the I<new> method constructs a new label object containing the supplied values. Depending on the final output format of the label data
600 the minimal required parameters change. (See the implimentation of this object type in labels/label-create-pdf.pl and labels/label-create-csv.pl
601 and labels/label-create-xml.pl for examples.) The following parameters are optionally accepted as key => value pairs:
603 C<batch_id> Batch id with which this label is associated
604 C<item_number> Item number of item to be the data source for this label
605 C<height> Height of this label (All measures passed to this method B<must> be supplied in postscript points)
606 C<width> Width of this label
607 C<top_text_margin> Top margin of this label
608 C<left_text_margin> Left margin of this label
609 C<barcode_type> Defines the barcode type to be used on labels. NOTE: At present only the following barcode types are supported in the label creator code:
617 CODE39MOD = Code 3 of 9 with modulo 43 checksum
620 CODE39MOD10 = Code 3 of 9 with modulo 10 checksum
623 COOP2OF5 = A varient of 2 of 5 barcode based on NEC's "Process 8000" code
626 INDUSTRIAL2OF5 = The standard 2 of 5 barcode (a binary level bar code developed by Identicon Corp. and Computer Identics Corp. in 1970)
629 EAN13 = The standard EAN-13 barcode
633 C<printing_type> Defines the general layout to be used on labels. NOTE: At present there are only five printing types supported in the label creator code:
638 BIB = Only the bibliographic data is printed
641 BARBIB = Barcode proceeds bibliographic data
644 BIBBAR = Bibliographic data proceeds barcode
647 ALT = Barcode and bibliographic data are printed on alternating labels
650 BAR = Only the barcode is printed
654 C<guidebox> Setting this to '1' will result in a guide box being drawn around the labels marking the edge of each label
655 C<font> Defines the type of font to be used on labels. NOTE: The following fonts are available by default on most systems:
669 TBI = Times Bold Italic
678 CO = Courier Oblique (Italic)
681 CBO = Courier Bold Oblique
690 HBO = Helvetical Bold Oblique
694 C<font_size> Defines the size of the font in postscript points to be used on labels
695 C<callnum_split> Setting this to '1' will enable call number splitting on labels
696 C<text_justify> Defines the text justification to be used on labels. NOTE: The following justification styles are currently supported by label creator code:
711 C<format_string> Defines what fields will be printed and in what order they will be printed on labels. These include any of the data fields that may be mapped
712 to your MARC frameworks. Specify MARC subfields as a 4-character tag-subfield string: ie. 254a Enclose a whitespace-separated list of fields
713 to concatenate on one line in double quotes. ie. "099a 099b" or "itemcallnumber barcode" Static text strings may be entered in single-quotes:
714 ie. 'Some static text here.'
715 C<text_wrap_cols> Defines the column after which the text will wrap to the next line.
717 =head2 get_label_type()
719 Invoking the I<get_label_type> method will return the printing type of the label object.
722 C<my $label_type = $label->get_label_type();>
724 =head2 get_attr($attribute)
726 Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
729 C<my $value = $label->get_attr($attribute);>
731 =head2 create_label()
733 Invoking the I<create_label> method generates the text for that label and returns it as an arrayref of an array contianing the formatted text as well as creating the barcode
734 and writing it directly to the pdf stream. The handling of the barcode is not quite good OO form due to the linear format of PDF::Reuse::Barcode. Be aware that the instantiating
735 code is responsible to properly format the text for insertion into the pdf stream as well as the actual insertion.
738 my $label_text = $label->create_label();
740 =head2 draw_label_text()
742 Invoking the I<draw_label_text> method generates the label text for the label object and returns it as an arrayref of an array containing the formatted text. The same caveats
743 apply to this method as to C<create_label()>. This method accepts the following parameters as key => value pairs: (NOTE: The unit is the postscript point - 72 per inch)
745 C<llx> The lower-left x coordinate for the text block (The point of origin for all PDF's is the lower left of the page per ISO 32000-1)
746 C<lly> The lower-left y coordinate for the text block
747 C<top_text_margin> The top margin for the text block.
748 C<line_spacer> The number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size)
749 C<font> The font to use for this label. See documentation on the new() method for supported fonts.
750 C<font_size> The font size in points to use for this label.
751 C<justify> The style of justification to use for this label. See documentation on the new() method for supported justification styles.
754 C<my $label_text = $label->draw_label_text(
757 top_text_margin => $label_top_text_margin,
758 line_spacer => $text_leading,
760 font_size => $text_font_size,
761 justify => $text_justification,
766 Invoking the I<barcode> method generates a barcode for the label object and inserts it into the current pdf stream. This method accepts the following parameters as key => value
767 pairs (C<barcode_data> is optional and omitting it will cause the barcode from the current item to be used. C<barcode_type> is also optional. Omission results in the barcode
768 type of the current template being used.):
770 C<llx> The lower-left x coordinate for the barcode block (The point of origin for all PDF's is the lower left of the page per ISO 32000-1)
771 C<lly> The lower-left y coordinate for the barcode block
772 C<width> The width of the barcode block
773 C<y_scale_factor> The scale factor to be applied to the y axis of the barcode block
774 C<barcode_data> The data to be encoded in the barcode
775 C<barcode_type> The barcode type (See the C<new()> method for supported barcode types)
781 width => $barcode_width,
782 y_scale_factor => $barcode_y_scale_factor,
783 barcode_data => $barcode,
784 barcode_type => $barcodetype,
789 Invoking the I<csv_data> method returns an arrayref of an array containing the label data suitable for passing to Text::CSV_XS->combine() to produce csv output.
792 C<my $csv_data = $label->csv_data();>
796 Mason James <mason@katipo.co.nz>
798 Chris Nighswonger <cnighswonger AT foundations DOT edu>
802 Copyright 2006 Katipo Communications.
804 Copyright 2009 Foundations Bible College.
808 This file is part of Koha.
810 Koha is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software
811 Foundation; either version 2 of the License, or (at your option) any later version.
813 You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 51 Franklin Street,
814 Fifth Floor, Boston, MA 02110-1301 USA.
816 =head1 DISCLAIMER OF WARRANTY
818 Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
819 A PARTICULAR PURPOSE. See the GNU General Public License for more details.