1 package C4::Labels::Profile;
8 use C4::Labels::Lib 1.000000 qw(get_unit_values);
11 use version; our $VERSION = qv('1.0.0_1');
15 my $given_params = {};
17 my @valid_profile_params = (
29 foreach my $key (keys %{$given_params}) {
30 if (!(grep m/$key/, @valid_profile_params)) {
31 warn sprintf('Unrecognized parameter type of "%s".', $key);
37 if (!(grep m/$_/, @valid_profile_params)) {
38 warn sprintf('Unrecognized parameter type of "%s".', $_);
47 my @unit_value = grep {$_->{'type'} eq $self->{units}} @{get_unit_values()};
48 $self->{offset_horz} = $self->{offset_horz} * $unit_value[0]->{'value'};
49 $self->{offset_vert} = $self->{offset_vert} * $unit_value[0]->{'value'};
50 $self->{creep_horz} = $self->{creep_horz} * $unit_value[0]->{'value'};
51 $self->{creep_vert} = $self->{creep_vert} * $unit_value[0]->{'value'};
57 if (_check_params(@_) eq 1) {
60 my $type = ref($invocant) || $invocant;
62 printer_name => 'Default Printer',
64 paper_bin => 'Tray 1',
79 my $type = ref($invocant) || $invocant;
80 my $query = "SELECT * FROM printers_profile WHERE profile_id = ?";
81 my $sth = C4::Context->dbh->prepare($query);
82 $sth->execute($opts{profile_id});
84 warn sprintf('Database returned the following error: %s', $sth->errstr);
87 my $self = $sth->fetchrow_hashref;
88 $self = _conv_points($self) if ($opts{convert} && $opts{convert} == 1);
99 $self = shift; # check to see if this is a method call
100 $call_type = 'C4::Labels::Profile->delete';
101 $query_param = $self->{'profile_id'};
105 $call_type = 'C4::Labels::Profile::delete';
106 $query_param = $opts{'profile_id'};
108 if ($query_param eq '') { # If there is no profile id then we cannot delete it
109 warn sprintf('%s : Cannot delete layout as the profile id is invalid or non-existant.', $call_type);
112 my $query = "DELETE FROM printers_profile WHERE profile_id = ?";
113 my $sth = C4::Context->dbh->prepare($query);
114 # $sth->{'TraceLevel'} = 3;
115 $sth->execute($query_param);
120 if ($self->{'profile_id'}) { # if we have an profile_id, the record exists and needs UPDATE
122 my $query = "UPDATE printers_profile SET ";
123 foreach my $key (keys %{$self}) {
124 next if $key eq 'profile_id';
125 push (@params, $self->{$key});
126 $query .= "$key=?, ";
128 $query = substr($query, 0, (length($query)-2));
129 push (@params, $self->{'profile_id'});
130 $query .= " WHERE profile_id=?;";
131 my $sth = C4::Context->dbh->prepare($query);
132 # $sth->{'TraceLevel'} = 3;
133 $sth->execute(@params);
135 warn sprintf('Database returned the following error on attempted UPDATE: %s', $sth->errstr);
138 return $self->{'profile_id'};
140 else { # otherwise create a new record
142 my $query = "INSERT INTO printers_profile (";
143 foreach my $key (keys %{$self}) {
144 push (@params, $self->{$key});
147 $query = substr($query, 0, (length($query)-2));
148 $query .= ") VALUES (";
149 for (my $i=1; $i<=(scalar keys %$self); $i++) {
152 $query = substr($query, 0, (length($query)-1));
154 my $sth = C4::Context->dbh->prepare($query);
155 $sth->execute(@params);
157 warn sprintf('Database returned the following error on attempted INSERT: %s', $sth->errstr);
160 my $sth1 = C4::Context->dbh->prepare("SELECT MAX(profile_id) FROM printers_profile;");
162 my $tmpl_id = $sth1->fetchrow_array;
169 if (_check_params(@_) eq 1) {
173 if (exists($self->{$attr})) {
174 return $self->{$attr};
177 warn sprintf('%s is currently undefined.', $attr);
184 if (_check_params(@_) eq 1) {
188 foreach my $attrib (keys(%attrs)) {
189 $self->{$attrib} = $attrs{$attrib};
199 C4::Labels::Profile - A class for creating and manipulating profile objects in Koha
203 This module provides methods for creating, retrieving, and otherwise manipulating label profile objects used by Koha to create and export labels.
209 Invoking the I<new> method constructs a new profile object containing the default values for a template.
210 The following parameters are optionally accepted as key => value pairs:
212 C<printer_name> The name of the printer to which this profile applies.
213 C<template_id> The template to which this profile may be applied. NOTE: There may be multiple profiles which may be applied to the same template.
214 C<paper_bin> The paper bin of the above printer to which this profile applies. NOTE: printer name, template id, and paper bin must form a unique combination.
215 C<offset_horz> Amount of compensation for horizontal offset (position of text on a single label). This amount is measured in the units supplied by the units parameter in this profile.
216 C<offset_vert> Amount of compensation for vertical offset.
217 C<creep_horz> Amount of compensation for horizontal creep (tendency of text to 'creep' off of the labels over the span of the entire page).
218 C<creep_vert> Amount of compensation for vertical creep.
219 C<units> The units of measure used for this template. These B<must> match the measures you supply above or
220 bad things will happen to your document. NOTE: The only supported units at present are:
225 POINT = Postscript Points (This is the base unit in the Koha label creator.)
228 AGATE = Adobe Agates (5.1428571 points per)
231 INCH = US Inches (72 points per)
234 MM = SI Millimeters (2.83464567 points per)
237 CM = SI Centimeters (28.3464567 points per)
242 C<my $profile = C4::Labels::Profile->new(); # Creates and returns a new profile object>
244 C<my $profile = C4::Labels::Profile->new(template_id => 1, paper_bin => 'Bypass Tray', offset_horz => 0.02, units => 'POINT'); # Creates and returns a new profile object using
245 the supplied values to override the defaults>
247 B<NOTE:> This profile is I<not> written to the database until save() is invoked. You have been warned!
249 =head2 retrieve(profile_id => $profile_id, convert => 1)
251 Invoking the I<retrieve> method constructs a new profile object containing the current values for profile_id. The method returns a new object upon success and 1 upon failure.
252 Errors are logged to the Apache log. One further option maybe accessed. See the examples below for further description.
256 C<my $profile = C4::Labels::Profile->retrieve(profile_id => 1); # Retrieves profile record 1 and returns an object containing the record>
258 C<my $profile = C4::Labels::Profile->retrieve(profile_id => 1, convert => 1); # Retrieves profile record 1, converts the units to points and returns an object containing the record>
262 Invoking the delete method attempts to delete the profile from the database. The method returns -1 upon failure. Errors are logged to the Apache log.
263 NOTE: This method may also be called as a function and passed a key/value pair simply deleteing that profile from the database. See the example below.
266 C<my $exitstat = $profile->delete(); # to delete the record behind the $profile object>
267 C<my $exitstat = C4::Labels::Profile::delete(profile_id => 1); # to delete profile record 1>
271 Invoking the I<save> method attempts to insert the profile into the database if the profile is new and update the existing profile record if the profile exists. The method returns
272 the new record profile_id upon success and -1 upon failure (This avoids conflicting with a record profile_id of 1). Errors are logged to the Apache log.
275 C<my $exitstat = $profile->save(); # to save the record behind the $profile object>
277 =head2 get_attr($attribute)
279 Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
282 C<my $value = $profile->get_attr($attribute);>
284 =head2 set_attr(attribute => value, attribute_2 => value)
286 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 commas.
289 $profile->set_attr(attribute => value);
293 Chris Nighswonger <cnighswonger AT foundations DOT edu>
297 Copyright 2009 Foundations Bible College.
301 This file is part of Koha.
303 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
304 Foundation; either version 2 of the License, or (at your option) any later version.
306 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,
307 Suite 330, Boston, MA 02111-1307 USA
309 =head1 DISCLAIMER OF WARRANTY
311 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
312 A PARTICULAR PURPOSE. See the GNU General Public License for more details.
317 #drawbox( ($left_margin), ($top_margin), ($page_width-(2*$left_margin)), ($page_height-(2*$top_margin)) ); # FIXME: Breakout code to print alignment page for printer profile setup
319 #=head2 draw_boundaries
321 # sub draw_boundaries ($llx_spine, $llx_circ1, $llx_circ2,
322 # $lly, $spine_width, $label_height, $circ_width)
324 #This sub draws boundary lines where the label outlines are, to aid in printer testing, and debugging.
328 ## FIXME: Template use for profile adjustment...
329 ##sub draw_boundaries {
332 ## $llx_spine, $llx_circ1, $llx_circ2, $lly,
333 ## $spine_width, $label_height, $circ_width
336 ## my $lly_initial = ( ( 792 - 36 ) - 90 );
337 ## $lly = $lly_initial; # FIXME - why are we ignoring the y_pos parameter by redefining it?
340 ## for ( $i = 1 ; $i <= 8 ; $i++ ) {
342 ## _draw_box( $llx_spine, $lly, ($spine_width), ($label_height) );
344 ## #warn "OLD BOXES x=$llx_spine, y=$lly, w=$spine_width, h=$label_height";
345 ## _draw_box( $llx_circ1, $lly, ($circ_width), ($label_height) );
346 ## _draw_box( $llx_circ2, $lly, ($circ_width), ($label_height) );
348 ## $lly = ( $lly - $label_height );