Koha/AuthorisedValues.pm

   1 package Koha::AuthorisedValues;
   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 under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 3 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use Koha::AuthorisedValue;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::AuthorisedValues - Koha AuthorisedValue Object set class
  33
  34 =head1 API
  35
  36 =head2 Class Methods
  37
  38 =cut
  39
  40 =head3 Koha::AuthorisedValues->search();
  41
  42 my @objects = Koha::AuthorisedValues->search($params);
  43
  44 =cut
  45
  46 sub search {
  47     my ( $self, $params ) = @_;
  48
  49     my $branchcode = $params->{branchcode};
  50     delete( $params->{branchcode} );
  51
  52     my $or =
  53       $branchcode
  54       ? {
  55         '-or' => [
  56             'authorised_values_branches.branchcode' => undef,
  57             'authorised_values_branches.branchcode' => $branchcode,
  58         ]
  59       }
  60       : {};
  61     my $join = $branchcode ? { join => 'authorised_values_branches' } : {};
  62     return $self->SUPER::search( { %$params, %$or, }, $join );
  63 }
  64
  65 sub categories {
  66     my ( $self ) = @_;
  67     my $rs = $self->_resultset->search(
  68         undef,
  69         {
  70             select => ['category'],
  71             distinct => 1,
  72             order_by => 'category',
  73         },
  74     );
  75     return map $_->get_column('category'), $rs->all;
  76 }
  77
  78 =head3 type
  79
  80 =cut
  81
  82 sub type {
  83     return 'AuthorisedValue';
  84 }
  85
  86 sub object_class {
  87     return 'Koha::AuthorisedValue';
  88 }
  89
  90 =head1 AUTHOR
  91
  92 Kyle M Hall <kyle@bywatersolutions.com>
  93
  94 =cut
  95
  96 1;