1 package C4::Labels::Layout;
13 use version; our $VERSION = qv('1.0.0_1');
16 # FIXME: Consider this style parameter verification instead...
20 # if (exists $default{$lc})
21 # { $default{$lc} = $param{$_};
24 # { print STDERR "Unknown parameter $_ , not used \n";
30 my @valtmpl_id_params = (
42 my %given_params = @_;
43 foreach my $key (keys %given_params) {
44 if (!(grep m/$key/, @valtmpl_id_params)) {
45 warn sprintf('(Multiple parameters) Unrecognized parameter type of "%s".', $key);
51 if (!(grep m/$_/, @valtmpl_id_params)) {
52 warn sprintf('(Single parameter) Unrecognized parameter type of "%s".', $_);
61 if (_check_params(@_) eq 1) {
64 my $type = ref($invocant) || $invocant;
66 barcode_type => 'CODE39',
67 printing_type => 'BAR',
68 layout_name => 'DEFAULT',
74 format_string => 'title, author, isbn, issn, itemtype, barcode, callnumber',
84 my $type = ref($invocant) || $invocant;
85 my $query = "SELECT * FROM labels_layouts WHERE layout_id = ?";
86 my $sth = C4::Context->dbh->prepare($query);
87 $sth->execute($opts{'layout_id'});
89 warn sprintf('Database returned the following error: %s', $sth->errstr);
92 my $self = $sth->fetchrow_hashref;
101 my $query_param = '';
103 $self = shift; # check to see if this is a method call
104 $call_type = 'C4::Labels::Layout->delete';
105 $query_param = $self->{'layout_id'};
109 $call_type = 'C4::Labels::Layout::delete';
110 $query_param = $opts{'layout_id'};
112 if ($query_param eq '') { # If there is no layout id then we cannot delete it
113 warn sprintf('%s : Cannot delete layout as the layout id is invalid or non-existant.', $call_type);
116 my $query = "DELETE FROM labels_layouts WHERE layout_id = ?";
117 my $sth = C4::Context->dbh->prepare($query);
118 $sth->execute($query_param);
120 warn sprintf('%s : Database returned the following error: %s', $call_type, $sth->errstr);
128 if ($self->{'layout_id'}) { # if we have an id, the record exists and needs UPDATE
130 my $query = "UPDATE labels_layouts SET ";
131 foreach my $key (keys %{$self}) {
132 next if $key eq 'layout_id';
133 push (@params, $self->{$key});
134 $query .= "$key=?, ";
136 $query = substr($query, 0, (length($query)-2));
137 $query .= " WHERE layout_id=?;";
138 push (@params, $self->{'layout_id'});
139 my $sth = C4::Context->dbh->prepare($query);
140 #local $sth->{TraceLevel} = "3"; # enable DBI trace and set level; outputs to STDERR
141 $sth->execute(@params);
143 warn sprintf('Database returned the following error: %s', $sth->errstr);
146 return $self->{'layout_id'};
148 else { # otherwise create a new record
150 my $query = "INSERT INTO labels_layouts (";
151 foreach my $key (keys %{$self}) {
152 push (@params, $self->{$key});
155 $query = substr($query, 0, (length($query)-2));
156 $query .= ") VALUES (";
157 for (my $i=1; $i<=(scalar keys %$self); $i++) {
160 $query = substr($query, 0, (length($query)-1));
162 my $sth = C4::Context->dbh->prepare($query);
163 $sth->execute(@params);
165 warn sprintf('Database returned the following error: %s', $sth->errstr);
168 my $sth1 = C4::Context->dbh->prepare("SELECT MAX(layout_id) FROM labels_layouts;");
170 my $id = $sth1->fetchrow_array;
177 if (_check_params(@_) eq 1) {
181 if (exists($self->{$attr})) {
182 return $self->{$attr};
192 if (_check_params(@_) eq 1) {
196 foreach my $attrib (keys(%attrs)) {
197 $self->{$attrib} = $attrs{$attrib};
202 sub get_text_wrap_cols {
208 my $textlimit = $params{'label_width'} - ( 3 * $params{'left_text_margin'});
210 while ($strwidth < $textlimit) {
213 $strwidth = C4::Labels::PDF->StrWidth( $string, $self->{'font'}, $self->{'font_size'} );
223 C4::Labels::Layout -A class for creating and manipulating layout objects in Koha
227 This module provides methods for creating, retrieving, and otherwise manipulating label layout objects used by Koha to create and export labels.
233 Invoking the I<new> method constructs a new layout object containing the default values for a layout.
234 The following parameters are optionally accepted as key => value pairs:
236 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:
244 CODE39MOD = Code 3 of 9 with modulo 43 checksum
247 CODE39MOD10 = Code 3 of 9 with modulo 10 checksum
250 COOP2OF5 = A varient of 2 of 5 barcode based on NEC's "Process 8000" code
253 INDUSTRIAL2OF5 = The standard 2 of 5 barcode (a binary level bar code developed by Identicon Corp. and Computer Identics Corp. in 1970)
257 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:
262 BIB = Only the bibliographic data is printed
265 BARBIB = Barcode proceeds bibliographic data
268 BIBBAR = Bibliographic data proceeds barcode
271 ALT = Barcode and bibliographic data are printed on alternating labels
274 BAR = Only the barcode is printed
278 C<layout_name> The descriptive name for this layout.
279 C<guidebox> Setting this to '1' will result in a guide box being drawn around the labels marking the edge of each label
280 C<font> Defines the type of font to be used on labels. NOTE: The following fonts are available by default on most systems:
294 TBI = Times Bold Italic
303 CO = Courier Oblique (Italic)
306 CBO = Courier Bold Oblique
315 HBO = Helvetical Bold Oblique
319 C<font_size> Defines the size of the font in postscript points to be used on labels
320 C<callnum_split> Setting this to '1' will enable call number splitting on labels
321 C<text_justify> Defines the text justification to be used on labels. NOTE: The following justification styles are currently supported by label creator code:
336 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
337 to your MARC frameworks. Specify MARC subfields as a 4-character tag-subfield string: ie. 254a Enclose a whitespace-separated list of fields
338 to concatenate on one line in double quotes. ie. "099a 099b" or "itemcallnumber barcode" Static text strings may be entered in single-quotes:
339 ie. 'Some static text here.'
342 C<my $layout = Layout->new(); # Creates and returns a new layout object>
344 C<my $layout = C4::Labels::Layout->new(barcode_type => 'CODE39', printing_type => 'BIBBAR', font => 'C', font_size => 6); # Creates and returns a new layout object using
345 the supplied values to override the defaults>
347 B<NOTE:> This layout is I<not> written to the database until save() is invoked. You have been warned!
349 =head2 retrieve(layout_id => layout_id)
351 Invoking the I<retrieve> method constructs a new layout object containing the current values for layout_id. The method returns a new object upon success and 1 upon failure.
352 Errors are logged to the Apache log.
355 C<my $layout = Layout->retrieve(layout_id => 1); # Retrieves layout record 1 and returns an object containing the record>
359 Invoking the delete method attempts to delete the layout from the database. The method returns 0 upon success and -1 upon failure. Errors are logged to the Apache log.
360 NOTE: This method may also be called as a function and passed a key/value pair simply deleteing that template from the database. See the example below.
363 C<my $exitstat = $layout->delete(); # to delete the record behind the $layout object>
364 C<my $exitstat = Layout->delete(layout_id => 1); # to delete layout record 1>
368 Invoking the I<save> method attempts to insert the layout into the database if the layout is new and update the existing layout record if the layout exists.
369 The method returns the new record id upon success and -1 upon failure (This avoids conflicting with a record id of 1). Errors are logged to the Apache log.
372 C<my $exitstat = $layout->save(); # to save the record behind the $layout object>
374 =head2 get_attr($attribute)
376 Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
379 C<my $value = $layout->get_attr($attribute);>
381 =head2 set_attr(attribute => value, attribute_2 => value)
383 Invoking the I<set_attr> method will set the value of the supplied attributes to the supplied values. The method accepts key/value pairs separated by
387 C<$layout->set_attr(attribute => value);>
389 =head2 get_text_wrap_cols()
391 Invoking the I<get_text_wrap_cols> method will return the number of columns that can be printed on the label before wrapping to the next line.
394 C<my $text_wrap_cols = $layout->get_text_wrap_cols();>
398 Chris Nighswonger <cnighswonger AT foundations DOT edu>
402 Copyright 2009 Foundations Bible College.
406 This file is part of Koha.
408 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
409 Foundation; either version 2 of the License, or (at your option) any later version.
411 You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
412 Suite 330, Boston, MA 02111-1307 USA
414 =head1 DISCLAIMER OF WARRANTY
416 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
417 A PARTICULAR PURPOSE. See the GNU General Public License for more details.