#
# This file is part of Koha.
#
-# 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
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# 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 Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# 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
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# 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 A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# 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,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use strict;
use warnings;
use C4::Debug;
BEGIN {
- use version; our $VERSION = qv('1.0.0_1');
use base qw(Exporter);
- our @EXPORT_OK = qw(get_all_templates
- get_all_layouts
- get_all_profiles
- get_all_image_names
- get_batch_summary
- get_label_summary
- get_card_summary
- get_barcode_types
- get_label_types
- get_font_types
- get_text_justification_types
- get_output_formats
- get_column_names
- get_table_names
- get_unit_values
- html_table
+ our @EXPORT = qw(get_all_templates
+ get_all_layouts
+ get_all_profiles
+ get_all_image_names
+ get_batch_summary
+ get_label_summary
+ get_card_summary
+ get_barcode_types
+ get_label_types
+ get_font_types
+ get_text_justification_types
+ get_output_formats
+ get_table_names
+ get_unit_values
+ html_table
);
}
+=head1 NAME
+
+C4::Creators::Lib
+
+=cut
+
+=head1 FUNCTIONS
+
+=cut
+
#=head2 C4::Creators::Lib::_SELECT()
#
# This function returns a recordset upon success and 1 upon failure. Errors are logged to the Apache log.
{type => 'CODE39MOD', name => 'Code 39 + Modulo43', desc => 'Translates the characters 0-9, A-Z, \'-\', \'*\', \'+\', \'$\', \'%\', \'/\', \'.\' and \' \' to a barcode pattern. Encodes Mod 43 checksum.', selected => 0},
{type => 'CODE39MOD10', name => 'Code 39 + Modulo10', desc => 'Translates the characters 0-9, A-Z, \'-\', \'*\', \'+\', \'$\', \'%\', \'/\', \'.\' and \' \' to a barcode pattern. Encodes Mod 10 checksum.', selected => 0},
{type => 'COOP2OF5', name => 'COOP2of5', desc => 'Creates COOP2of5 barcodes from a string consisting of the numeric characters 0-9', selected => 0},
-# {type => 'EAN13', name => 'EAN13', desc => 'Creates EAN13 barcodes from a string of 12 or 13 digits. The check number (the 13:th digit) is calculated if not supplied.', selected => 0},
+ {type => 'EAN13', name => 'EAN13', desc => 'Creates EAN13 barcodes from a string of 12 or 13 digits. The check number (the 13:th digit) is calculated if not supplied.', selected => 0},
# {type => 'EAN8', name => 'EAN8', desc => 'Translates a string of 7 or 8 digits to EAN8 barcodes. The check number (the 8:th digit) is calculated if not supplied.', selected => 0},
# {type => 'IATA2of5', name => 'IATA2of5', desc => 'Creates IATA2of5 barcodes from a string consisting of the numeric characters 0-9', selected => 0},
{type => 'INDUSTRIAL2OF5', name => 'Industrial2of5', desc => 'Creates Industrial2of5 barcodes from a string consisting of the numeric characters 0-9', selected => 0},
{type => 'CO', name => 'Courier-Oblique', selected => 0},
{type => 'CBO', name => 'Courier-Bold-Oblique', selected => 0},
{type => 'H', name => 'Helvetica', selected => 0},
+ {type => 'HO', name => 'Helvetica-Oblique', selected => 0},
{type => 'HB', name => 'Helvetica-Bold', selected => 0},
{type => 'HBO', name => 'Helvetica-Bold-Oblique', selected => 0},
];
{type => 'csv', desc => 'CSV File'},
];
-=head2 C4::Creators::Lib::get_all_templates()
+sub _build_query {
+ my ( $params, $table ) = @_;
+ my @fields = exists $params->{fields} ? @{ $params->{fields} } : ();
+ my $query = "SELECT " . ( @fields ? join(', ', @fields ) : '*' ) . " FROM $table";
+ my @where_args;
+ if ( exists $params->{filters} ) {
+ $query .= ' WHERE 1 ';
+ while ( my ( $field, $values ) = each %{ $params->{filters} } ) {
+ if ( ref( $values ) ) {
+ $query .= " AND $field IN ( " . ( ('?,') x (@$values-1) ) . "? ) "; # a comma separates elements in a list...
+ push @where_args, @$values;
+ } else {
+ $query .= " AND $field = ? ";
+ push @where_args, $values;
+ }
+ }
+ }
+ $query .= (exists $params->{orderby} ? " ORDER BY $params->{orderby} " : '');
+ return ( $query, @where_args );
+}
- This function returns a reference to a hash containing all templates upon success and 1 upon failure. Errors are logged to the Apache log.
+=head2 C4::Creators::Lib::get_all_templates()
- examples:
+ my $templates = get_all_templates();
- my $templates = get_all_templates();
+This function returns a reference to a hash containing all templates upon success and 1 upon failure. Errors are logged to the Apache log.
=cut
sub get_all_templates {
- my %params = @_;
+ my ( $params ) = @_;
my @templates = ();
- my $query = "SELECT " . ($params{'field_list'} ? $params{'field_list'} : '*') . " FROM creator_templates";
- $query .= ($params{'filter'} ? " WHERE $params{'filter'};" : ';');
+ my ( $query, @where_args ) = _build_query( $params, 'creator_templates' );
my $sth = C4::Context->dbh->prepare($query);
- $sth->execute();
+ $sth->execute( @where_args );
if ($sth->err) {
warn sprintf('Database returned the following error: %s', $sth->errstr);
return -1;
=head2 C4::Creators::Lib::get_all_layouts()
- This function returns a reference to a hash containing all layouts upon success and 1 upon failure. Errors are logged to the Apache log.
+ my $layouts = get_all_layouts();
- examples:
-
- my $layouts = get_all_layouts();
+This function returns a reference to a hash containing all layouts upon success and 1 upon failure. Errors are logged to the Apache log.
=cut
sub get_all_layouts {
- my %params = @_;
+ my ( $params ) = @_;
my @layouts = ();
- my $query = "SELECT " . ($params{'field_list'} ? $params{'field_list'} : '*') . " FROM creator_layouts";
- $query .= ($params{'filter'} ? " WHERE $params{'filter'};" : ';');
+ my ( $query, @where_args ) = _build_query( $params, 'creator_layouts' );
my $sth = C4::Context->dbh->prepare($query);
- $sth->execute();
+ $sth->execute( @where_args );
if ($sth->err) {
warn sprintf('Database returned the following error: %s', $sth->errstr);
return -1;
=head2 C4::Creators::Lib::get_all_profiles()
- This function returns an arrayref whose elements are hashes containing all profiles upon success and 1 upon failure. Errors are logged
- to the Apache log. Two parameters are accepted. The first limits the field(s) returned. This parameter should be string of comma separted
- fields. ie. "field_1, field_2, ...field_n" The second limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $profiles = get_all_profiles();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $profiles = get_all_profiles({ fields => [@fields], filters => { filters => [$value1, $value2] } });
- examples:
+This function returns an arrayref whose elements are hashes containing all profiles upon success and 1 upon failure. Errors are logged
+to the Apache log. Two parameters are accepted. The first limits the field(s) returned. This parameter should be string of comma separted
+fields. ie. "field_1, field_2, ...field_n" The second limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $profiles = get_all_profiles();
- my $profiles = get_all_profiles(field_list => field_list, filter => filter_string);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
sub get_all_profiles {
- my %params = @_;
+ my ( $params ) = @_;
my @profiles = ();
- my $query = "SELECT " . ($params{'field_list'} ? $params{'field_list'} : '*') . " FROM printers_profile";
- $query .= ($params{'filter'} ? " WHERE $params{'filter'};" : ';');
+ my ( $query, @where_args ) = _build_query( $params, 'printers_profile' );
my $sth = C4::Context->dbh->prepare($query);
-# $sth->{'TraceLevel'} = 3 if $debug;
- $sth->execute();
+ $sth->execute( @where_args );
if ($sth->err) {
warn sprintf('Database returned the following error: %s', $sth->errstr);
return -1;
=head2 C4::Creators::Lib::get_batch_summary()
- This function returns an arrayref whose elements are hashes containing the batch_ids of current batches along with the item count
- for each batch upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $batches = get_batch_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $batches = get_batch_summary(filter => filter_string);
- examples:
+This function returns an arrayref whose elements are hashes containing the batch_ids of current batches along with the item count
+for each batch upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $batches = get_batch_summary();
- my $batches = get_batch_summary(filter => filter_string);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
sub get_batch_summary {
- my %params = @_;
+ my ( $params ) = @_;
my @batches = ();
- my $query = "SELECT DISTINCT batch_id FROM creator_batches WHERE creator=?";
- $query .= ($params{'filter'} ? " AND $params{'filter'};" : ';');
+ $params->{fields} = ['batch_id', 'count(batch_id) as _item_count'];
+ my ( $query, @where_args ) = _build_query( $params, 'creator_batches' );
+ $query .= " GROUP BY batch_id";
my $sth = C4::Context->dbh->prepare($query);
-# $sth->{'TraceLevel'} = 3;
- $sth->execute($params{'creator'});
+ $sth->execute( @where_args );
if ($sth->err) {
warn sprintf('Database returned the following error on attempted SELECT: %s', $sth->errstr);
return -1;
}
- ADD_BATCHES:
while (my $batch = $sth->fetchrow_hashref) {
- my $query = "SELECT count(batch_id) FROM creator_batches WHERE batch_id=? AND creator=?;";
- my $sth1 = C4::Context->dbh->prepare($query);
- $sth1->execute($batch->{'batch_id'}, $params{'creator'});
- if ($sth1->err) {
- warn sprintf('Database returned the following error on attempted SELECT count: %s', $sth1->errstr);
- return -1;
- }
- my $count = $sth1->fetchrow_arrayref;
- $batch->{'_item_count'} = @$count[0];
push(@batches, $batch);
}
return \@batches;
=head2 C4::Creators::Lib::get_label_summary()
- This function returns an arrayref whose elements are hashes containing the label_ids of current labels along with the item count
- for each label upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $labels = get_label_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $labels = get_label_summary(items => @item_list);
- examples:
+This function returns an arrayref whose elements are hashes containing the label_ids of current labels along with the item count
+for each label upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $labels = get_label_summary();
- my $labels = get_label_summary(items => @item_list);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
my %params = @_;
my $label_number = 0;
my @label_summaries = ();
- my $query = " SELECT b.title, b.author, bi.itemtype, i.barcode, i.biblionumber
+ my $query = " SELECT b.title, b.author, bi.itemtype, i.barcode, i.itemcallnumber, i.biblionumber, i.itype
FROM creator_batches AS c LEFT JOIN items AS i ON (c.item_number=i.itemnumber)
LEFT JOIN biblioitems AS bi ON (i.biblioitemnumber=bi.biblioitemnumber)
LEFT JOIN biblio AS b ON (bi.biblionumber=b.biblionumber)
return -1;
}
my $record = $sth->fetchrow_hashref;
- my $label_summary->{'_label_number'} = $label_number;
+ my $label_summary;
+ $label_summary->{'_label_number'} = $label_number;
$record->{'author'} =~ s/[^\.|\w]$// if $record->{'author'}; # strip off ugly trailing chars... but not periods or word chars
$record->{'title'} =~ s/\W*$//; # strip off ugly trailing chars
# FIXME contructing staff interface URLs should be done *much* higher up the stack - for the most part, C4 module code
# should not know that it's part of a web app
$record->{'title'} = '<a href="/cgi-bin/koha/catalogue/detail.pl?biblionumber=' . $record->{'biblionumber'} . '"> ' . $record->{'title'} . '</a>';
$label_summary->{'_summary'} = $record->{'title'} . " | " . ($record->{'author'} ? $record->{'author'} : 'N/A');
- $label_summary->{'_item_type'} = $record->{'itemtype'};
+ $label_summary->{'_item_type'} = C4::Context->preference("item-level_itypes") ? $record->{'itype'} : $record->{'itemtype'};
$label_summary->{'_barcode'} = $record->{'barcode'};
$label_summary->{'_item_number'} = $item->{'item_number'};
+ $label_summary->{'_item_cn'} = $record->{'itemcallnumber'};
$label_summary->{'_label_id'} = $item->{'label_id'};
push (@label_summaries, $label_summary);
}
=head2 C4::Creators::Lib::get_card_summary()
- This function returns an arrayref whose elements are hashes containing the label_ids of current cards along with the item count
- for each card upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
- One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
+ my $cards = get_card_summary();
- NOTE: Do not pass in the keyword 'WHERE.'
+ my $cards = get_card_summary(items => @item_list);
- examples:
+This function returns an arrayref whose elements are hashes containing the label_ids of current cards along with the item count
+for each card upon success and 1 upon failure. Item counts are stored under the key '_item_count' Errors are logged to the Apache log.
+One parameter is accepted which limits the records returned based on a string containing a valud SQL 'WHERE' filter.
- my $cards = get_card_summary();
- my $cards = get_card_summary(items => @item_list);
+NOTE: Do not pass in the keyword 'WHERE.'
=cut
=head2 C4::Creators::Lib::get_barcode_types()
- This function returns a reference to an array of hashes containing all barcode types along with their name and description.
+ my $barcode_types = get_barcode_types();
- examples:
-
- my $barcode_types = get_barcode_types();
+This function returns a reference to an array of hashes containing all barcode types along with their name and description.
=cut
=head2 C4::Creators::Lib::get_label_types()
- This function returns a reference to an array of hashes containing all label types along with their name and description.
-
- examples:
+ my $label_types = get_label_types();
- my $label_types = get_label_types();
+This function returns a reference to an array of hashes containing all label types along with their name and description.
=cut
=head2 C4::Creators::Lib::get_font_types()
- This function returns a reference to an array of hashes containing all font types along with their name and description.
-
- examples:
+ my $font_types = get_font_types();
- my $font_types = get_font_types();
+This function returns a reference to an array of hashes containing all font types along with their name and description.
=cut
=head2 C4::Creators::Lib::get_text_justification_types()
- This function returns a reference to an array of hashes containing all text justification types along with their name and description.
+ my $text_justification_types = get_text_justification_types();
- examples:
-
- my $text_justification_types = get_text_justification_types();
+This function returns a reference to an array of hashes containing all text justification types along with their name and description.
=cut
=head2 C4::Creators::Lib::get_unit_values()
- This function returns a reference to an array of hashes containing all unit types along with their description and multiplier. NOTE: All units are relative to a PostScript Point.
- There are 72 PS points to the inch.
-
- examples:
+ my $unit_values = get_unit_values();
- my $unit_values = get_unit_values();
+This function returns a reference to an array of hashes containing all unit types along with their description and multiplier.
+NOTE: All units are relative to a PostScript Point.
+There are 72 PS points to the inch.
=cut
=head2 C4::Creators::Lib::get_output_formats()
- This function returns a reference to an array of hashes containing all label output formats along with their description.
+ my $label_output_formats = get_output_formats();
- examples:
-
- my $label_output_formats = get_output_formats();
+This function returns a reference to an array of hashes containing all label output formats along with their description.
=cut
return $output_formats;
}
-=head2 C4::Creators::Lib::get_column_names($table_name)
-
-Return an arrayref of an array containing the column names of the supplied table.
-
-=cut
-
-sub get_column_names {
- my $table = shift;
- my $dbh = C4::Context->dbh();
- my $column_names = [];
- my $sth = $dbh->column_info(undef,undef,$table,'%');
- while (my $info = $sth->fetchrow_hashref()){
- $$column_names[$info->{'ORDINAL_POSITION'}] = $info->{'COLUMN_NAME'};
- }
- return $column_names;
-}
=head2 C4::Creators::Lib::get_table_names($search_term)
=head2 C4::Creators::Lib::html_table()
- This function returns an arrayref of an array of hashes contianing the supplied data formatted suitably to
- be passed off as a T::P template parameter and used to build an html table.
-
- examples:
+This function returns an arrayref of an array of hashes contianing the supplied data formatted suitably to
+be passed off as a template parameter and used to build an html table.
- my $table = html_table(header_fields, array_of_row_data);
- $template->param(
- TABLE => $table,
- );
+ my $table = html_table(header_fields, array_of_row_data);
+ $template->param(
+ table_loop => $table,
+ );
html example:
- <table>
- <!-- TMPL_LOOP NAME="TABLE" -->
- <!-- TMPL_IF NAME="header_fields" -->
- <tr>
- <!-- TMPL_LOOP NAME="header_fields" -->
- <th><!-- TMPL_VAR NAME="field_label" --></th>
- <!-- /TMPL_LOOP -->
- </tr>
- <!-- TMPL_ELSE -->
- <tr>
- <!-- TMPL_LOOP NAME="text_fields" -->
- <!-- TMPL_IF NAME="select_field" -->
- <td align="center"><input type="checkbox" name="action" value="<!-- TMPL_VAR NAME="field_value" -->" /></td>
- <!-- TMPL_ELSIF NAME="field_value" -->
- <td><!-- TMPL_VAR NAME="field_value" --></td>
- <!-- TMPL_ELSE -->
- <td> </td>
- <!-- /TMPL_IF -->
- <!-- /TMPL_LOOP -->
- </tr>
- <!-- /TMPL_IF -->
- <!-- /TMPL_LOOP -->
+ <table>
+ [% FOREACH table_loo IN table_loop %]
+ [% IF ( table_loo.header_fields ) %]
+ <tr>
+ [% FOREACH header_field IN table_loo.header_fields %]
+ <th>[% header_field.field_label %]</th>
+ [% END %]
+ </tr>
+ [% ELSE %]
+ <tr>
+ [% FOREACH text_field IN table_loo.text_fields %]
+ [% IF ( text_field.select_field ) %]
+ <td><input type="checkbox" name="action" value="[% text_field.field_value %]"></td>
+ [% ELSE %]
+ <td>[% text_field.field_value %]</td>
+ [% END %]
+ [% END %]
+ </tr>
+ [% END %]
+ [% END %]
</table>
=cut
projects / koha-ffzg.git / blobdiff