koha-dev.rot13.org Git - srvgit/blob - 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
  23 use Koha::Database;
  24
  25 use base qw(Koha::Object Koha::Object::Limit::Library);
  26
  27 =head1 NAME
  28
  29 Koha::AuthorisedValue - Koha Authorised value Object class
  30
  31 =head1 API
  32
  33 =head2 Class methods
  34
  35 =cut
  36
  37 =head3 opac_description
  38
  39 my $description = $av->opac_description();
  40
  41 =cut
  42
  43 sub opac_description {
  44     my ( $self, $value ) = @_;
  45
  46     return $self->lib_opac() || $self->lib();
  47 }
  48
  49 =head3 to_api_mapping
  50
  51 This method returns the mapping for representing a Koha::AuthorisedValue object
  52 on the API.
  53
  54 =cut
  55
  56 sub to_api_mapping {
  57     return {
  58         id               => 'authorised_value_id',
  59         category         => 'category_name',
  60         authorised_value => 'value',
  61         lib              => 'description',
  62         lib_opac         => 'opac_description',
  63         imageurl         => 'image_url',
  64     };
  65 }
  66
  67 =head2 Internal methods
  68
  69 =head3 _type
  70
  71 =cut
  72
  73 sub _type {
  74     return 'AuthorisedValue';
  75 }
  76
  77 =head3 _library_limits
  78
  79 =cut
  80
  81 sub _library_limits {
  82     return {
  83         class   => 'AuthorisedValuesBranch',
  84         id      => 'av_id',
  85         library => 'branchcode'
  86     };
  87 }
  88
  89 =head1 AUTHOR
  90
  91 Kyle M Hall <kyle@bywatersolutions.com>
  92
  93 =cut
  94
  95 1;