C4/ItemType.pm

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