Koha/C4/Koha.pm
2002-09-20 12:49:47 +00:00

170 lines
3.9 KiB
Perl

package C4::Koha;
# Copyright 2000-2002 Katipo Communications
#
# 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 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
use strict;
require Exporter;
use C4::Database;
use vars qw($VERSION @ISA @EXPORT);
$VERSION = 0.01;
=head1 NAME
C4::Koha - Perl Module containing convenience functions for Koha scripts
=head1 SYNOPSIS
use C4::Koha;
$date = slashifyDate("01-01-2002")
$ethnicity = fixEthnicity('asian');
($categories, $labels) = borrowercategories();
($categories, $labels) = ethnicitycategories();
=head1 DESCRIPTION
Koha.pm provides many functions for Koha scripts.
=head1 FUNCTIONS
=over 2
=cut
@ISA = qw(Exporter);
@EXPORT = qw(&slashifyDate
&fixEthnicity
&borrowercategories
&ethnicitycategories
$DEBUG);
use vars qw();
my $DEBUG = 0;
=item slashifyDate
$slash_date = &slashifyDate($dash_date);
Takes a string of the form "DD-MM-YYYY" (or anything separated by
dashes), converts it to the form "YYYY/MM/DD", and returns the result.
=cut
sub slashifyDate {
# accepts a date of the form xx-xx-xx[xx] and returns it in the
# form xx/xx/xx[xx]
my @dateOut = split('-', shift);
return("$dateOut[2]/$dateOut[1]/$dateOut[0]")
}
=item fixEthnicity
$ethn_name = &fixEthnicity($ethn_code);
Takes an ethnicity code (e.g., "european" or "pi") and returns the
corresponding descriptive name from the C<ethnicity> table in the
Koha database ("European" or "Pacific Islander").
=cut
#'
sub fixEthnicity($) {
my $ethnicity = shift;
my $dbh=C4Connect;
my $sth=$dbh->prepare("Select name from ethnicity where code = ?");
$sth->execute($ethnicity);
my $data=$sth->fetchrow_hashref;
$sth->finish;
$dbh->disconnect;
return $data->{'name'};
}
=item borrowercategories
($codes_arrayref, $labels_hashref) = &borrowercategories();
Looks up the different types of borrowers in the database. Returns two
elements: a reference-to-array, which lists the borrower category
codes, and a reference-to-hash, which maps the borrower category codes
to category descriptions.
=cut
#'
sub borrowercategories {
my $dbh=C4Connect;
my $sth=$dbh->prepare("Select categorycode,description from categories order by description");
$sth->execute;
my %labels;
my @codes;
while (my $data=$sth->fetchrow_hashref){
push @codes,$data->{'categorycode'};
$labels{$data->{'categorycode'}}=$data->{'description'};
}
$sth->finish;
$dbh->disconnect;
return(\@codes,\%labels);
}
=item ethnicitycategories
($codes_arrayref, $labels_hashref) = &ethnicitycategories();
Looks up the different ethnic types in the database. Returns two
elements: a reference-to-array, which lists the ethnicity codes, and a
reference-to-hash, which maps the ethnicity codes to ethnicity
descriptions.
=cut
#'
sub ethnicitycategories {
my $dbh=C4Connect;
my $sth=$dbh->prepare("Select code,name from ethnicity order by name");
$sth->execute;
my %labels;
my @codes;
while (my $data=$sth->fetchrow_hashref){
push @codes,$data->{'code'};
$labels{$data->{'code'}}=$data->{'name'};
}
$sth->finish;
$dbh->disconnect;
return(\@codes,\%labels);
}
1;
__END__
=back
=head1 AUTHOR
Pat Eyler, pate@gnu.org
=head1 SEE ALSO
perl(1).
=cut