1 package C4::Labels::Label;
7 use Algorithm::CheckDigits;
10 use Library::CallNumber::LC;
11 use Text::Bidi qw( log2vis );
18 use version; our $VERSION = qv('3.07.00.049');
21 my $possible_decimal = qr/\d{3,}(?:\.\d+)?/; # at least three digits for a DDCN
24 my $given_params = {};
26 my @valid_label_params = (
48 foreach my $key (keys %{$given_params}) {
49 if (!(grep m/$key/, @valid_label_params)) {
50 warn sprintf('Unrecognized parameter type of "%s".', $key);
56 if (!(grep m/$_/, @valid_label_params)) {
57 warn sprintf('Unrecognized parameter type of "%s".', $_);
65 my ( $llx, $lly, $width, $height ) = @_;
66 return unless ( defined $llx and defined $lly and
67 defined $width and defined $height );
68 my $obj_stream = "q\n"; # save the graphic state
69 $obj_stream .= "0.5 w\n"; # border line width
70 $obj_stream .= "1.0 0.0 0.0 RG\n"; # border color red
71 $obj_stream .= "1.0 1.0 1.0 rg\n"; # fill color white
72 $obj_stream .= "$llx $lly $width $height re\n"; # a rectangle
73 $obj_stream .= "B\n"; # fill (and a little more)
74 $obj_stream .= "Q\n"; # restore the graphic state
79 my $item_number = shift;
80 my $barcode_only = shift || 0;
81 my $dbh = C4::Context->dbh;
82 # FIXME This makes for a very bulky data structure; data from tables w/duplicate col names also gets overwritten.
83 # Something like this, perhaps, but this also causes problems because we need more fields sometimes.
84 # SELECT i.barcode, i.itemcallnumber, i.itype, bi.isbn, bi.issn, b.title, b.author
85 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;");
86 $sth->execute($item_number);
88 warn sprintf('Database returned the following error: %s', $sth->errstr);
90 my $data = $sth->fetchrow_hashref;
91 # Replaced item's itemtype with the more user-friendly description...
92 my $sth1 = $dbh->prepare("SELECT itemtype,description FROM itemtypes WHERE itemtype = ?");
93 $sth1->execute($data->{'itemtype'});
95 warn sprintf('Database returned the following error: %s', $sth1->errstr);
97 my $data1 = $sth1->fetchrow_hashref;
98 $data->{'itemtype'} = $data1->{'description'};
99 $data->{'itype'} = $data1->{'description'};
100 $barcode_only ? return $data->{'barcode'} : return $data;
103 sub _get_text_fields {
104 my $format_string = shift;
105 my $csv = Text::CSV_XS->new({allow_whitespace => 1});
106 my $status = $csv->parse($format_string);
107 my @sorted_fields = map {{ 'code' => $_, desc => $_ }}
108 map { $_ eq 'callnumber' ? 'itemcallnumber' : $_ } # see bug 5653
110 my $error = $csv->error_input();
111 warn sprintf('Text field sort failed with this error: %s', $error) if $error;
112 return \@sorted_fields;
119 # lccn examples: 'HE8700.7 .P6T44 1983', 'BS2545.E8 H39 1996';
120 my @parts = Library::CallNumber::LC->new($lccn)->components();
121 unless (scalar @parts && defined $parts[0]) {
122 warn sprintf('regexp failed to match string: %s', $_);
123 @parts = $_; # if no match, just use the whole string.
125 push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
126 $debug and warn "split_lccn array: ", join(" | ", @parts), "\n";
133 s/\///g; # in theory we should be able to simply remove all segmentation markers and arrive at the correct call number...
135 ^([-a-zA-Z]*\s?(?:$possible_decimal)?) # R220.3 CD-ROM 787.87 # will require extra splitting
137 (.+) # H2793Z H32 c.2 EAS # everything else (except bracketing spaces)
140 unless (scalar @parts) {
141 warn sprintf('regexp failed to match string: %s', $_);
142 push @parts, $_; # if no match, just push the whole string.
145 if ($parts[0] =~ /^([-a-zA-Z]+)\s?($possible_decimal)$/) {
146 shift @parts; # pull off the mathching first element, like example 1
147 unshift @parts, $1, $2; # replace it with the two pieces
150 push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
151 $debug and print STDERR "split_ddcn array: ", join(" | ", @parts), "\n";
155 ## NOTE: Custom call number types go here. It may be necessary to create additional splitting algorithms if some custom call numbers
156 ## cannot be made to work here. Presently this splits standard non-ddcn, non-lccn fiction and biography call numbers.
161 # Split call numbers based on spaces
162 push @parts, split /\s+/, $fcn; # split the call number into an arbitrary number of pieces at spaces
163 if ($parts[-1] !~ /^.*\d-\d.*$/ && $parts[-1] =~ /^(.*\d+)(\D.*)$/) {
164 pop @parts; # pull off the matching last element
165 push @parts, $1, $2; # replace it with the two pieces
167 unless (scalar @parts) {
168 warn sprintf('regexp failed to match string: %s', $_);
171 $debug and print STDERR "split_ccn array: ", join(" | ", @parts), "\n";
175 sub _get_barcode_data {
176 my ( $f, $item, $record ) = @_;
177 my $kohatables = _desc_koha_tables();
179 my $match_kohatable = join(
182 @{ $kohatables->{'biblio'} },
183 @{ $kohatables->{'biblioitems'} },
184 @{ $kohatables->{'items'} },
185 @{ $kohatables->{'branches'} }
192 if ( $f =~ /^'(.*)'.*/ ) {
193 # single quotes indicate a static text string.
198 elsif ( $f =~ /^($match_kohatable).*/ ) {
200 $datastring .= $item->{$f};
202 $debug and warn sprintf("The '%s' field contains no data.", $f);
207 elsif ( $f =~ /^([0-9a-z]{3})(\w)(\W?).*?/ ) {
208 my ($field,$subf,$ws) = ($1,$2,$3);
210 my ($itemtag, $itemsubfieldcode) = &GetMarcFromKohaField("items.itemnumber",'');
211 my @marcfield = $record->field($field);
213 if($field eq $itemtag) { # item-level data, we need to get the right item.
215 foreach my $itemfield (@marcfield) {
216 if ( $itemfield->subfield($itemsubfieldcode) eq $item->{'itemnumber'} ) {
217 if ($itemfield->subfield($subf)) {
218 $datastring .= $itemfield->subfield($subf) . $ws;
221 warn sprintf("The '%s' field contains no data.", $f);
226 } else { # bib-level data, we'll take the first matching tag/subfield.
227 if ($marcfield[0]->subfield($subf)) {
228 $datastring .= $marcfield[0]->subfield($subf) . $ws;
231 warn sprintf("The '%s' field contains no data.", $f);
239 warn sprintf('Failed to parse label format string: %s', $f);
240 last FIELD_LIST; # Failed to match
246 sub _desc_koha_tables {
247 my $dbh = C4::Context->dbh();
249 for my $table ( 'biblio','biblioitems','items','branches' ) {
250 my $sth = $dbh->column_info(undef,undef,$table,'%');
251 while (my $info = $sth->fetchrow_hashref()){
252 push @{$kohatables->{$table}} , $info->{'COLUMN_NAME'} ;
259 ### This series of functions calculates the position of text and barcode on individual labels
260 ### 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
261 ### in labels/label-create-pdf.pl as an example.
262 ### NOTE: Each function must be passed seven parameters and return seven even if some are 0 or undef
266 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.).
267 my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
268 return $self->{'llx'}, $text_lly, $line_spacer, 0, 0, 0, 0;
273 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)
274 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)
275 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
276 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
277 return 0, 0, 0, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
282 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'})
283 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)
284 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
285 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
286 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.).
287 my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
288 $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";
289 return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
294 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'})
295 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'})
296 my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
297 my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
298 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.).
299 my $text_lly = (($self->{'lly'} + $self->{'height'}) - $self->{'top_text_margin'} - (($self->{'lly'} + $self->{'height'}) - $barcode_lly));
300 return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
304 my ($invocant, %params) = @_;
305 my $type = ref($invocant) || $invocant;
307 batch_id => $params{'batch_id'},
308 item_number => $params{'item_number'},
309 llx => $params{'llx'},
310 lly => $params{'lly'},
311 height => $params{'height'},
312 width => $params{'width'},
313 top_text_margin => $params{'top_text_margin'},
314 left_text_margin => $params{'left_text_margin'},
315 barcode_type => $params{'barcode_type'},
316 printing_type => $params{'printing_type'},
317 guidebox => $params{'guidebox'},
318 font => $params{'font'},
319 font_size => $params{'font_size'},
320 callnum_split => $params{'callnum_split'},
321 justify => $params{'justify'},
322 format_string => $params{'format_string'},
323 text_wrap_cols => $params{'text_wrap_cols'},
326 if ($self->{'guidebox'}) {
327 $self->{'guidebox'} = _guide_box($self->{'llx'}, $self->{'lly'}, $self->{'width'}, $self->{'height'});
329 bless ($self, $type);
335 return $self->{'printing_type'};
340 if (_check_params(@_) eq 1) {
344 if (exists($self->{$attr})) {
345 return $self->{$attr};
356 my ($text_llx, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor);
359 ($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
361 if ($self->{'printing_type'} =~ /BIB/) {
362 $label_text = draw_label_text( $self,
365 line_spacer => $line_spacer,
368 if ($self->{'printing_type'} =~ /BAR/) {
372 width => $barcode_width,
373 y_scale_factor => $barcode_y_scale_factor,
376 return $label_text if $label_text;
380 sub draw_label_text {
381 my ($self, %params) = @_;
384 my $text_lly = $params{'lly'};
385 my $font = $self->{'font'};
386 my $item = _get_label_item($self->{'item_number'});
387 my $label_fields = _get_text_fields($self->{'format_string'});
388 my $record = GetMarcBiblio($item->{'biblionumber'});
389 # FIXME - returns all items, so you can't get data from an embedded holdings field.
390 # TODO - add a GetMarcBiblio1item(bibnum,itemnum) or a GetMarcItem(itemnum).
391 my $cn_source = ($item->{'cn_source'} ? $item->{'cn_source'} : C4::Context->preference('DefaultClassificationSource'));
392 LABEL_FIELDS: # process data for requested fields on current label
393 for my $field (@$label_fields) {
394 if ($field->{'code'} eq 'itemtype') {
395 $field->{'data'} = C4::Context->preference('item-level_itypes') ? $item->{'itype'} : $item->{'itemtype'};
398 $field->{'data'} = _get_barcode_data($field->{'code'},$item,$record);
400 #FIXME: We should not force the title to oblique; this should be selectible in the layout configuration
401 ($field->{'code'} eq 'title') ? (($font =~ /T/) ? ($font = 'TI') : ($font = ($font . 'O'))) : ($font = $font);
402 my $field_data = $field->{'data'};
404 $field_data =~ s/\n//g;
405 $field_data =~ s/\r//g;
408 # Fields which hold call number data FIXME: ( 060? 090? 092? 099? )
409 my @callnumber_list = qw(itemcallnumber 050a 050b 082a 952o 995k);
410 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
411 if ($cn_source eq 'lcc' || $cn_source eq 'nlm') { # NLM and LCC should be split the same way
412 @label_lines = _split_lccn($field_data);
413 @label_lines = _split_ccn($field_data) if !@label_lines; # If it was not a true lccn, try it as a custom call number
414 push (@label_lines, $field_data) if !@label_lines; # If it was not that, send it on unsplit
415 } elsif ($cn_source eq 'ddc') {
416 @label_lines = _split_ddcn($field_data);
417 @label_lines = _split_ccn($field_data) if !@label_lines;
418 push (@label_lines, $field_data) if !@label_lines;
420 warn sprintf('Call number splitting failed for: %s. Please add this call number to bug #2500 at bugs.koha-community.org', $field_data);
421 push @label_lines, $field_data;
426 $field_data =~ s/\/$//g; # Here we will strip out all trailing '/' in fields other than the call number...
427 # Escaping the parens was causing odd output, see bug 13124
428 # $field_data =~ s/\(/\\\(/g; # Escape '(' and ')' for the pdf object stream...
429 # $field_data =~ s/\)/\\\)/g;
431 eval{$Text::Wrap::columns = $self->{'text_wrap_cols'};};
432 my @line = split(/\n/ ,wrap('', '', $field_data));
433 # If this is a title field, limit to two lines; all others limit to one... FIXME: this is rather arbitrary
434 if ($field->{'code'} eq 'title' && scalar(@line) >= 2) {
435 while (scalar(@line) > 2) {
439 while (scalar(@line) > 1) {
443 push(@label_lines, @line);
445 LABEL_LINES: # generate lines of label text for current field
446 foreach my $line (@label_lines) {
447 next LABEL_LINES if $line eq '';
448 my $fontName = C4::Creators::PDF->Font($font);
449 $line = log2vis( $line );
450 my $string_width = C4::Creators::PDF->StrWidth($line, $fontName, $self->{'font_size'});
451 if ($self->{'justify'} eq 'R') {
452 $text_llx = $params{'llx'} + $self->{'width'} - ($self->{'left_text_margin'} + $string_width);
454 elsif($self->{'justify'} eq 'C') {
455 # some code to try and center each line on the label based on font size and string point width...
456 my $whitespace = ($self->{'width'} - ($string_width + (2 * $self->{'left_text_margin'})));
457 $text_llx = (($whitespace / 2) + $params{'llx'} + $self->{'left_text_margin'});
460 $text_llx = ($params{'llx'} + $self->{'left_text_margin'});
463 text_llx => $text_llx,
464 text_lly => $text_lly,
466 font_size => $self->{'font_size'},
469 $text_lly = $text_lly - $params{'line_spacer'};
471 $font = $self->{'font'}; # reset font for next field
477 return $_[0]->{'guidebox'};
483 $params{'barcode_data'} = _get_label_item($self->{'item_number'}, 1) if !$params{'barcode_data'};
484 $params{'barcode_type'} = $self->{'barcode_type'} if !$params{'barcode_type'};
485 my $x_scale_factor = 1;
486 my $num_of_bars = length($params{'barcode_data'});
487 my $tot_bar_length = 0;
489 my $guard_length = 10;
490 my $hide_text = 'yes';
491 if ($params{'barcode_type'} =~ m/CODE39/) {
492 $bar_length = '17.5';
493 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
494 $x_scale_factor = ($params{'width'} / $tot_bar_length);
495 if ($params{'barcode_type'} eq 'CODE39MOD') {
496 my $c39 = CheckDigits('code_39'); # get modulo43 checksum
497 $params{'barcode_data'} = $c39->complete($params{'barcode_data'});
499 elsif ($params{'barcode_type'} eq 'CODE39MOD10') {
500 my $c39_10 = CheckDigits('siret'); # get modulo43 checksum
501 $params{'barcode_data'} = $c39_10->complete($params{'barcode_data'});
505 PDF::Reuse::Barcode::Code39(
508 value => "*$params{barcode_data}*",
509 xSize => $x_scale_factor,
510 ySize => $params{'y_scale_factor'},
517 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
520 elsif ($params{'barcode_type'} eq 'COOP2OF5') {
521 $bar_length = '9.43333333333333';
522 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
523 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
525 PDF::Reuse::Barcode::COOP2of5(
528 value => "*$params{barcode_data}*",
529 xSize => $x_scale_factor,
530 ySize => $params{'y_scale_factor'},
535 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
538 elsif ( $params{'barcode_type'} eq 'INDUSTRIAL2OF5' ) {
539 $bar_length = '13.1333333333333';
540 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
541 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
543 PDF::Reuse::Barcode::Industrial2of5(
546 value => "*$params{barcode_data}*",
547 xSize => $x_scale_factor,
548 ySize => $params{'y_scale_factor'},
553 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
556 elsif ($params{'barcode_type'} eq 'EAN13') {
557 $bar_length = 4; # FIXME
559 $tot_bar_length = ($bar_length * $num_of_bars) + ($guard_length * 2);
560 $x_scale_factor = ($params{'width'} / $tot_bar_length) * 0.9;
562 PDF::Reuse::Barcode::EAN13(
565 value => sprintf('%013d',$params{barcode_data}),
566 # xSize => $x_scale_factor,
567 # ySize => $params{'y_scale_factor'},
572 warn sprintf('Barcode generation failed for item %s with this error: %s', $self->{'item_number'}, $@);
576 warn "unknown barcode_type: $params{barcode_type}";
582 my $label_fields = _get_text_fields($self->{'format_string'});
583 my $item = _get_label_item($self->{'item_number'});
584 my $bib_record = GetMarcBiblio($item->{biblionumber});
585 my @csv_data = (map { _get_barcode_data($_->{'code'},$item,$bib_record) } @$label_fields);
594 C4::Labels::Label - A class for creating and manipulating label objects in Koha
598 This module provides methods for creating, and otherwise manipulating single label objects used by Koha to create and export labels.
604 Invoking the I<new> method constructs a new label object containing the supplied values. Depending on the final output format of the label data
605 the minimal required parameters change. (See the implimentation of this object type in labels/label-create-pdf.pl and labels/label-create-csv.pl
606 and labels/label-create-xml.pl for examples.) The following parameters are optionally accepted as key => value pairs:
608 C<batch_id> Batch id with which this label is associated
609 C<item_number> Item number of item to be the data source for this label
610 C<height> Height of this label (All measures passed to this method B<must> be supplied in postscript points)
611 C<width> Width of this label
612 C<top_text_margin> Top margin of this label
613 C<left_text_margin> Left margin of this label
614 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:
622 CODE39MOD = Code 3 of 9 with modulo 43 checksum
625 CODE39MOD10 = Code 3 of 9 with modulo 10 checksum
628 COOP2OF5 = A varient of 2 of 5 barcode based on NEC's "Process 8000" code
631 INDUSTRIAL2OF5 = The standard 2 of 5 barcode (a binary level bar code developed by Identicon Corp. and Computer Identics Corp. in 1970)
634 EAN13 = The standard EAN-13 barcode
638 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:
643 BIB = Only the bibliographic data is printed
646 BARBIB = Barcode proceeds bibliographic data
649 BIBBAR = Bibliographic data proceeds barcode
652 ALT = Barcode and bibliographic data are printed on alternating labels
655 BAR = Only the barcode is printed
659 C<guidebox> Setting this to '1' will result in a guide box being drawn around the labels marking the edge of each label
660 C<font> Defines the type of font to be used on labels. NOTE: The following fonts are available by default on most systems:
674 TBI = Times Bold Italic
683 CO = Courier Oblique (Italic)
686 CBO = Courier Bold Oblique
695 HBO = Helvetical Bold Oblique
699 C<font_size> Defines the size of the font in postscript points to be used on labels
700 C<callnum_split> Setting this to '1' will enable call number splitting on labels
701 C<text_justify> Defines the text justification to be used on labels. NOTE: The following justification styles are currently supported by label creator code:
716 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
717 to your MARC frameworks. Specify MARC subfields as a 4-character tag-subfield string: ie. 254a Enclose a whitespace-separated list of fields
718 to concatenate on one line in double quotes. ie. "099a 099b" or "itemcallnumber barcode" Static text strings may be entered in single-quotes:
719 ie. 'Some static text here.'
720 C<text_wrap_cols> Defines the column after which the text will wrap to the next line.
722 =head2 get_label_type()
724 Invoking the I<get_label_type> method will return the printing type of the label object.
727 C<my $label_type = $label->get_label_type();>
729 =head2 get_attr($attribute)
731 Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
734 C<my $value = $label->get_attr($attribute);>
736 =head2 create_label()
738 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
739 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
740 code is responsible to properly format the text for insertion into the pdf stream as well as the actual insertion.
743 my $label_text = $label->create_label();
745 =head2 draw_label_text()
747 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
748 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)
750 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)
751 C<lly> The lower-left y coordinate for the text block
752 C<top_text_margin> The top margin for the text block.
753 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)
754 C<font> The font to use for this label. See documentation on the new() method for supported fonts.
755 C<font_size> The font size in points to use for this label.
756 C<justify> The style of justification to use for this label. See documentation on the new() method for supported justification styles.
759 C<my $label_text = $label->draw_label_text(
762 top_text_margin => $label_top_text_margin,
763 line_spacer => $text_leading,
765 font_size => $text_font_size,
766 justify => $text_justification,
771 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
772 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
773 type of the current template being used.):
775 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)
776 C<lly> The lower-left y coordinate for the barcode block
777 C<width> The width of the barcode block
778 C<y_scale_factor> The scale factor to be applied to the y axis of the barcode block
779 C<barcode_data> The data to be encoded in the barcode
780 C<barcode_type> The barcode type (See the C<new()> method for supported barcode types)
786 width => $barcode_width,
787 y_scale_factor => $barcode_y_scale_factor,
788 barcode_data => $barcode,
789 barcode_type => $barcodetype,
794 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.
797 C<my $csv_data = $label->csv_data();>
801 Mason James <mason@katipo.co.nz>
803 Chris Nighswonger <cnighswonger AT foundations DOT edu>
807 Copyright 2006 Katipo Communications.
809 Copyright 2009 Foundations Bible College.
813 This file is part of Koha.
815 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
816 Foundation; either version 2 of the License, or (at your option) any later version.
818 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,
819 Fifth Floor, Boston, MA 02110-1301 USA.
821 =head1 DISCLAIMER OF WARRANTY
823 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
824 A PARTICULAR PURPOSE. See the GNU General Public License for more details.