ed3621aa47
Me, I use ed(1) for everything... Signed-off-by: Galen Charlton <galen.charlton@liblime.com>
146 lines
2.8 KiB
Perl
146 lines
2.8 KiB
Perl
package C4::Category;
|
|
|
|
# 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;
|
|
use warnings;
|
|
use C4::Context;
|
|
|
|
our $AUTOLOAD;
|
|
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
C4::Category - objects from the categories table
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use C4::Category;
|
|
my @categories = C4::Category->all;
|
|
print join("\n", map { $_->description } @categories), "\n";
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Objects of this class represent a row in the C<categories> table.
|
|
|
|
Currently, the bare minimum for using this as a read-only data source has
|
|
been implemented. The API was designed to make it easy to transition to
|
|
an ORM later on.
|
|
|
|
=head1 API
|
|
|
|
=head2 Class Methods
|
|
|
|
=cut
|
|
|
|
=head3 C4::Category->new(\%opts)
|
|
|
|
Given a hashref, a new (in-memory) C4::Category object will be instantiated.
|
|
The database is not touched.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my ($class, $opts) = @_;
|
|
bless $opts => $class;
|
|
}
|
|
|
|
|
|
|
|
|
|
=head3 C4::Category->all
|
|
|
|
This returns all the categories as objects. By default they're ordered by
|
|
C<description>.
|
|
|
|
=cut
|
|
|
|
sub all {
|
|
my ($class) = @_;
|
|
my $dbh = C4::Context->dbh;
|
|
return map { $class->new($_) } @{$dbh->selectall_arrayref(
|
|
# The categories table is small enough for
|
|
# `SELECT *` to be harmless.
|
|
"SELECT * FROM categories ORDER BY description",
|
|
{ Slice => {} },
|
|
)};
|
|
}
|
|
|
|
|
|
|
|
|
|
=head2 Object Methods
|
|
|
|
These are read-only accessors for attributes of a C4::Category object.
|
|
|
|
=head3 $category->categorycode
|
|
|
|
=head3 $category->description
|
|
|
|
=head3 $category->enrolmentperiod
|
|
|
|
=head3 $category->upperagelimit
|
|
|
|
=head3 $category->dateofbirthrequired
|
|
|
|
=head3 $category->finetype
|
|
|
|
=head3 $category->bulk
|
|
|
|
=head3 $category->enrolmentfee
|
|
|
|
=head3 $category->overduenoticerequired
|
|
|
|
=head3 $category->issuelimit
|
|
|
|
=head3 $category->reservefee
|
|
|
|
=head3 $category->category_type
|
|
|
|
=cut
|
|
|
|
sub AUTOLOAD {
|
|
my $self = shift;
|
|
my $attr = $AUTOLOAD;
|
|
$attr =~ s/.*://;
|
|
if (exists $self->{$attr}) {
|
|
return $self->{$attr};
|
|
} else {
|
|
return undef;
|
|
}
|
|
}
|
|
|
|
sub DESTROY { }
|
|
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
The following modules make reference to the C<categories> table.
|
|
|
|
L<C4::Members>, L<C4::Overdues>, L<C4::Reserves>
|
|
|
|
|
|
=head1 AUTHOR
|
|
|
|
John Beppu <john.beppu@liblime.com>
|
|
|
|
=cut
|
|
|
|
1;
|