Koha/AuthorisedValue.pm

   1 package Koha::AuthorisedValue;
   2
   3 # Copyright ByWater Solutions 2014
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use base qw(Koha::Object Koha::Object::Limit::Library);
  27
  28 =head1 NAME
  29
  30 Koha::AuthorisedValue - Koha Authorised value Object class
  31
  32 =head1 API
  33
  34 =head2 Class methods
  35
  36 =cut
  37
  38 =head3 opac_description
  39
  40 my $description = $av->opac_description();
  41
  42 =cut
  43
  44 sub opac_description {
  45     my ( $self, $value ) = @_;
  46
  47     return $self->lib_opac() || $self->lib();
  48 }
  49
  50 =head2 Internal methods
  51
  52 =head3 _type
  53
  54 =cut
  55
  56 sub _type {
  57     return 'AuthorisedValue';
  58 }
  59
  60 =head3 _library_limits
  61
  62 =cut
  63
  64 sub _library_limits {
  65     return {
  66         class   => 'AuthorisedValuesBranch',
  67         id      => 'av_id',
  68         library => 'branchcode'
  69     };
  70 }
  71
  72 =head1 AUTHOR
  73
  74 Kyle M Hall <kyle@bywatersolutions.com>
  75
  76 =cut
  77
  78 1;