C4/ItemType.pm

   1 package C4::ItemType;
   2
   3 # Copyright Liblime 2009
   4 # Parts Copyright Tamil 2011
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it
   9 # under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation; either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but
  14 # WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  20
  21 use strict;
  22 use warnings;
  23 use C4::Context;
  24
  25 our $AUTOLOAD;
  26
  27
  28
  29
  30 =head1 NAME
  31
  32 C4::ItemType - objects from the itemtypes table
  33
  34 =head1 SYNOPSIS
  35
  36     use C4::ItemType;
  37     my @itemtypes = C4::ItemType->all;
  38     print join("\n", map { $_->description } @itemtypes), "\n";
  39
  40 =head1 DESCRIPTION
  41
  42 Objects of this class represent a row in the C<itemtypes> table.
  43
  44 Currently, the bare minimum for using this as a read-only data source has
  45 been implemented.  The API was designed to make it easy to transition to
  46 an ORM later on.
  47
  48 =head1 API
  49
  50 =head2 Class Methods
  51
  52 =cut
  53
  54 =head3 C4::ItemType->new(\%opts)
  55
  56 Given a hashref, a new (in-memory) C4::ItemType object will be instantiated.
  57 The database is not touched.
  58
  59 =cut
  60
  61 sub new {
  62     my ($class, $opts) = @_;
  63     bless $opts => $class;
  64 }
  65
  66
  67
  68
  69 =head3 C4::ItemType->all
  70
  71 This returns all the itemtypes as objects.  By default they're ordered by
  72 C<description>.
  73
  74 =cut
  75
  76 sub all {
  77     my ($class) = @_;
  78     my $dbh = C4::Context->dbh;
  79
  80     my @itypes;
  81     for ( @{$dbh->selectall_arrayref(
  82         "SELECT * FROM itemtypes ORDER BY description", { Slice => {} })} )
  83     {
  84         utf8::encode($_->{description});
  85         push @itypes, $class->new($_);
  86     }
  87     return @itypes;
  88 }
  89
  90
  91
  92
  93 =head3 C4::ItemType->get
  94
  95 Return the itemtype indicated by the itemtype given as argument, as
  96 an object.
  97
  98 =cut
  99
 100 sub get {
 101     my ($class, $itemtype) = @_;
 102
 103     return unless defined $itemtype;
 104
 105     my $dbh = C4::Context->dbh;
 106
 107     my $data = $dbh->selectrow_hashref(
 108         "SELECT * FROM itemtypes WHERE itemtype = ?", undef, $itemtype
 109     );
 110     if ( $data->{description} ) {
 111         utf8::encode($data->{description});
 112     }
 113     return $class->new($data);
 114 }
 115
 116
 117
 118
 119 =head2 Object Methods
 120
 121 These are read-only accessors for attributes of a C4::ItemType object.
 122
 123 =head3 $itemtype->itemtype
 124
 125 =cut
 126
 127 =head3 $itemtype->description
 128
 129 =cut
 130
 131 =head3 $itemtype->renewalsallowed
 132
 133 =cut
 134
 135 =head3 $itemtype->rentalcharge
 136
 137 =cut
 138
 139 =head3 $itemtype->notforloan
 140
 141 =cut
 142
 143 =head3 $itemtype->imageurl
 144
 145 =cut
 146
 147 =head3 $itemtype->checkinmsg
 148
 149 =cut
 150
 151 =head3 $itemtype->summary
 152
 153 =cut
 154
 155 sub AUTOLOAD {
 156     my $self = shift;
 157     my $attr = $AUTOLOAD;
 158     $attr =~ s/.*://;
 159     if (exists $self->{$attr}) {
 160         return $self->{$attr};
 161     } else {
 162         return undef;
 163     }
 164 }
 165
 166 sub DESTROY { }
 167
 168
 169
 170 # ack itemtypes | grep '\.pm' | awk '{ print $1 }' | sed 's/:.*$//' | sort | uniq | sed -e 's,/,::,g' -e 's/\.pm//' -e 's/^/L<C4::/' -e 's/$/>,/'
 171
 172 =head1 SEE ALSO
 173
 174 The following modules make reference to the C<itemtypes> table.
 175
 176 L<C4::Biblio>,
 177 L<C4::Circulation>,
 178 L<C4::Context>,
 179 L<C4::Items>,
 180 L<C4::Koha>,
 181 L<C4::Labels>,
 182 L<C4::Overdues>,
 183 L<C4::Reserves>,
 184 L<C4::Search>,
 185 L<C4::VirtualShelves::Page>,
 186 L<C4::VirtualShelves>,
 187 L<C4::XSLT>
 188
 189
 190
 191 =head1 AUTHOR
 192
 193 John Beppu <john.beppu@liblime.com>
 194
 195 =cut
 196
 197 1;