1 package C4::Creators::Template;
6 use autouse 'Data::Dumper' => qw(Dumper);
9 use C4::Creators::Profile;
10 use C4::Creators::Lib qw( get_unit_values );
14 shift if $_[0] =~ m/::/; # this seems a bit hackish
15 my $given_params = {};
17 my @valid_template_params = (
41 foreach my $key (keys %{$given_params}) {
42 if (!(grep m/$key/, @valid_template_params)) {
43 warn sprintf('Unrecognized parameter type of "%s".', $key);
49 if (!(grep m/$_/, @valid_template_params)) {
50 warn sprintf('Unrecognized parameter type of "%s".', $_);
59 my @unit_value = grep {$_->{'type'} eq $self->{'units'}} @{get_unit_values()};
60 $self->{'page_width'} = $self->{'page_width'} * $unit_value[0]->{'value'};
61 $self->{'page_height'} = $self->{'page_height'} * $unit_value[0]->{'value'};
62 $self->{'label_width'} = $self->{'label_width'} * $unit_value[0]->{'value'};
63 $self->{'label_height'} = $self->{'label_height'} * $unit_value[0]->{'value'};
64 $self->{'top_text_margin'} = $self->{'top_text_margin'} * $unit_value[0]->{'value'};
65 $self->{'left_text_margin'} = $self->{'left_text_margin'} * $unit_value[0]->{'value'};
66 $self->{'top_margin'} = $self->{'top_margin'} * $unit_value[0]->{'value'};
67 $self->{'left_margin'} = $self->{'left_margin'} * $unit_value[0]->{'value'};
68 $self->{'col_gap'} = $self->{'col_gap'} * $unit_value[0]->{'value'};
69 $self->{'row_gap'} = $self->{'row_gap'} * $unit_value[0]->{'value'};
76 my $profile = C4::Creators::Profile->retrieve(profile_id => $self->{'profile_id'}, creator => $creator, convert => 1);
77 $self->{'top_margin'} = $self->{'top_margin'} + $profile->get_attr('offset_vert'); # controls vertical offset
78 $self->{'left_margin'} = $self->{'left_margin'} + $profile->get_attr('offset_horz'); # controls horizontal offset
79 $self->{'label_height'} = $self->{'label_height'} + $profile->get_attr('creep_vert'); # controls vertical creep
80 $self->{'label_width'} = $self->{'label_width'} + $profile->get_attr('creep_horz'); # controls horizontal creep
86 my $type = ref($invocant) || $invocant;
87 if (_check_params(@_) eq 1) {
92 template_code => 'DEFAULT TEMPLATE',
93 template_desc => 'Default description',
99 left_text_margin => 0,
107 template_stat => 0, # false if any data has changed and the db has not been updated
110 bless ($self, $type);
115 my $invocant = shift;
117 my $type = ref($invocant) || $invocant;
118 my $query = "SELECT * FROM " . $opts{'table_name'} . " WHERE template_id = ? AND creator = ?";
119 my $sth = C4::Context->dbh->prepare($query);
120 $sth->execute($opts{'template_id'}, $opts{'creator'});
122 warn sprintf('Database returned the following error: %s', $sth->errstr);
125 my $self = $sth->fetchrow_hashref;
126 $self = _conv_points($self) if (($opts{convert} && $opts{convert} == 1) || $opts{profile_id});
127 $self = _apply_profile($self, $opts{'creator'}) if $opts{profile_id} && $self->{'profile_id'}; # don't bother if there is no profile_id
128 $self->{'template_stat'} = 1;
129 bless ($self, $type);
137 my @query_params = ();
139 $self = shift; # check to see if this is a method call
140 $call_type = 'C4::Labels::Template->delete';
141 push @query_params, $self->{'template_id'}, $self->{'creator'};
145 $call_type = 'C4::Labels::Template::delete';
146 push @query_params, $opts{'template_id'}, $opts{'creator'};
148 if (scalar(@query_params) < 2) { # If there is no template id or creator type then we cannot delete it
149 warn sprintf('%s : Cannot delete template as the template id is invalid or non-existent.', $call_type) if !$query_params[0];
150 warn sprintf('%s : Cannot delete template as the creator type is invalid or non-existent.', $call_type) if !$query_params[1];
153 my $query = "DELETE FROM creator_templates WHERE template_id = ? AND creator = ?";
154 my $sth = C4::Context->dbh->prepare($query);
155 $sth->execute(@query_params);
156 $self->{'template_stat'} = 0;
162 if ($self->{'template_id'}) { # if we have an template_id, the record exists and needs UPDATE
164 my $query = "UPDATE " . $opts{'table_name'} . " SET ";
165 foreach my $key (keys %{$self}) {
166 next if ($key eq 'template_id') || ($key eq 'template_stat') || ($key eq 'creator');
167 push (@params, $self->{$key});
168 $query .= "`$key`=?, ";
170 $query = substr($query, 0, (length($query)-2));
171 push (@params, $self->{'template_id'}, $self->{'creator'});
172 $query .= " WHERE template_id=? AND creator=?;";
173 my $sth = C4::Context->dbh->prepare($query);
174 $sth->execute(@params);
176 warn sprintf('Database returned the following error: %s', $sth->errstr);
179 $self->{'template_stat'} = 1;
180 return $self->{'template_id'};
182 else { # otherwise create a new record
184 my $query = "INSERT INTO " . $opts{'table_name'} ." (";
185 foreach my $key (keys %{$self}) {
186 next if $key eq 'template_stat';
187 push (@params, $self->{$key});
188 $query .= "`$key`, ";
190 $query = substr($query, 0, (length($query)-2));
191 $query .= ") VALUES (";
192 for (my $i=1; $i<=((scalar keys %$self) - 1); $i++) { # key count less keys not db related...
195 $query = substr($query, 0, (length($query)-1));
197 my $sth = C4::Context->dbh->prepare($query);
198 $sth->execute(@params);
200 warn sprintf('Database returned the following error: %s', $sth->errstr);
203 my $sth1 = C4::Context->dbh->prepare("SELECT MAX(template_id) FROM " . $opts{'table_name'} . ";");
205 my $template_id = $sth1->fetchrow_array;
206 $self->{'template_id'} = $template_id;
207 $self->{'template_stat'} = 1;
214 if (_check_params(@_) eq 1) {
218 if (exists($self->{$attr})) {
219 return $self->{$attr};
228 if (_check_params(@_) eq 1) {
232 foreach my $attrib (keys(%attrs)) {
233 $self->{$attrib} = $attrs{$attrib};
237 sub get_label_position {
238 my ($self, $start_label) = @_;
239 my $current_label = $self->{'current_label'};
240 if ($start_label eq 1) {
241 $current_label->{'row_count'} = 1;
242 $current_label->{'col_count'} = 1;
243 $current_label->{'llx'} = $self->{'left_margin'};
244 $current_label->{'lly'} = ($self->{'page_height'} - $self->{'top_margin'} - $self->{'label_height'});
245 $self->{'current_label'} = $current_label;
246 return ($current_label->{'row_count'}, $current_label->{'col_count'}, $current_label->{'llx'}, $current_label->{'lly'});
249 $current_label->{'row_count'} = ceil($start_label / $self->{'cols'});
250 $current_label->{'col_count'} = ($start_label - (($current_label->{'row_count'} - 1) * $self->{'cols'}));
251 $current_label->{'llx'} = $self->{'left_margin'} + ($self->{'label_width'} * ($current_label->{'col_count'} - 1)) + ($self->{'col_gap'} * ($current_label->{'col_count'} - 1));
252 $current_label->{'lly'} = $self->{'page_height'} - $self->{'top_margin'} - ($self->{'label_height'} * $current_label->{'row_count'}) - ($self->{'row_gap'} * ($current_label->{'row_count'} - 1));
253 $self->{'current_label'} = $current_label;
254 return ($current_label->{'row_count'}, $current_label->{'col_count'}, $current_label->{'llx'}, $current_label->{'lly'});
258 sub get_next_label_pos {
260 my $current_label = $self->{'current_label'};
262 if ($current_label->{'col_count'} lt $self->get_attr('cols')) {
263 $current_label->{'llx'} = ($current_label->{'llx'} + $self->get_attr('label_width') + $self->get_attr('col_gap'));
264 $current_label->{'col_count'}++;
267 $current_label->{'llx'} = $self->get_attr('left_margin');
268 if ($current_label->{'row_count'} eq $self->get_attr('rows')) {
270 $current_label->{'lly'} = ($self->get_attr('page_height') - $self->get_attr('top_margin') - $self->get_attr('label_height'));
271 $current_label->{'row_count'} = 1;
274 $current_label->{'lly'} = ($current_label->{'lly'} - $self->get_attr('row_gap') - $self->get_attr('label_height'));
275 $current_label->{'row_count'}++;
277 $current_label->{'col_count'} = 1;
279 return ($current_label->{'llx'}, $current_label->{'lly'}, $new_page);
287 C4::Creators::Template - A class for creating and manipulating template objects in Koha
291 This module provides methods for creating, retrieving, and otherwise manipulating label template objects used by Koha.
297 Invoking the I<new> method constructs a new template object containing the default values for a template.
298 The following parameters are optionally accepted as key => value pairs:
300 C<profile_id> A valid profile id to be assciated with this template. NOTE: The profile must exist in the database and B<not> be assigned to another template.
301 C<template_code> A template code. ie. 'Avery 5160 | 1 x 2-5/8'
302 C<template_desc> A readable description of the template. ie. '3 columns, 10 rows of labels'
303 C<page_width> The width of the page measured in the units supplied by the units parameter in this template.
304 C<page_height> The height of the page measured in the same units.
305 C<label_width> The width of a single label on the page this template applies to.
306 C<label_height> The height of a single label on the page.
307 C<top_text_margin> The measure of the top margin on a single label on the page.
308 C<left_text_margin> The measure of the left margin on a single label on the page.
309 C<top_margin> The measure of the top margin of the page.
310 C<left_margin> The measure of the left margin of the page.
311 C<cols> The number of columns of labels on the page.
312 C<rows> The number of rows of labels on the page.
313 C<col_gap> The measure of the gap between the columns of labels on the page.
314 C<row_gap> The measure of the gap between the rows of labels on the page.
315 C<units> The units of measure used for this template. These B<must> match the measures you supply above or
316 bad things will happen to your document. NOTE: The only supported units at present are:
321 POINT = Postscript Points (This is the base unit in the Koha label creator.)
324 AGATE = Adobe Agates (5.1428571 points per)
327 INCH = US Inches (72 points per)
330 MM = SI Millimeters (2.83464567 points per)
333 CM = SI Centimeters (28.3464567 points per)
338 my $template = Template->new(); # Creates and returns a new template object with the defaults
340 my $template = C4::Labels::Template->new(profile_id => 1, page_width => 8.5, page_height => 11.0, units => 'INCH'); # Creates and returns a new template object using
341 the supplied values to override the defaults
343 B<NOTE:> This template is I<not> written to the database until save() is invoked. You have been warned!
345 =head2 retrieve(template_id => $template_id)
347 Invoking the I<retrieve> method constructs a new template object containing the current values for template_id. The method returns
348 a new object upon success and -1 upon failure. Errors are logged to the Apache log. Two further options may be accessed. See the example
349 below for further description.
353 C<my $template = C4::Labels::Template->retrieve(template_id => 1); # Retrieves template record 1 and returns an object containing the record>
355 C<my $template = C4::Labels::Template->retrieve(template_id => 1, convert => 1); # Retrieves template record 1, converts the units to points,
356 and returns an object containing the record>
358 C<my $template = C4::Labels::Template->retrieve(template_id => 1, profile_id => 1); # Retrieves template record 1, converts the units
359 to points, applies the currently associated profile id, and returns an object containing the record.>
363 Invoking the delete method attempts to delete the template from the database. The method returns -1 upon failure. Errors are logged to the Apache log.
364 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.
367 C<my $exitstat = $template->delete(); # to delete the record behind the $template object>
368 C<my $exitstat = C4::Labels::Template::delete(template_id => 1); # to delete template record 1>
372 Invoking the I<save> method attempts to insert the template into the database if the template is new and update the existing template record if
373 the template exists. The method returns the new record template_id upon success and -1 upon failure (This avoids template_ids conflicting with a
374 record template_id of 1). Errors are logged to the Apache log.
377 C<my $template_id = $template->save(); # to save the record behind the $template object>
379 =head2 get_attr($attribute)
381 Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
384 C<my $value = $template->get_attr($attribute);>
386 =head2 set_attr(attribute => value, attribute_2 => value)
388 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
392 C<$template->set_attr(attribute => value);>
394 =head2 get_label_position($start_label)
396 Invoking the I<get_label_position> method will return the row, column coordinates on the starting page and the lower left x,y coordinates on the starting
397 label for the template object.
400 C<my ($row_count, $col_count, $llx, $lly) = $template->get_label_position($start_label);>
404 Chris Nighswonger <cnighswonger AT foundations DOT edu>
408 Copyright 2009 Foundations Bible College.
412 This file is part of Koha.
414 Koha is free software; you can redistribute it and/or modify it
415 under the terms of the GNU General Public License as published by
416 the Free Software Foundation; either version 3 of the License, or
417 (at your option) any later version.
419 Koha is distributed in the hope that it will be useful, but
420 WITHOUT ANY WARRANTY; without even the implied warranty of
421 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
422 GNU General Public License for more details.
424 You should have received a copy of the GNU General Public License
425 along with Koha; if not, see <http://www.gnu.org/licenses>.
427 =head1 DISCLAIMER OF WARRANTY
429 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
430 A PARTICULAR PURPOSE. See the GNU General Public License for more details.