Koha/Library/Groups.pm

   1 package Koha::Library::Groups;
   2
   3 # Copyright ByWater Solutions 2016
   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::Library::Group;
  27
  28 use base qw(Koha::Objects);
  29
  30 =head1 NAME
  31
  32 Koha::Library::Groups - Koha Library::Group object set class
  33
  34 =head1 API
  35
  36 =head2 Class Methods
  37
  38 =head3 get_root_groups
  39
  40 my @root_groups = $self->get_root_group()
  41
  42 =cut
  43
  44 sub get_root_groups {
  45     my ( $self ) = @_;
  46
  47     return $self->search( { parent_id => undef }, { order_by => 'title' } );
  48 }
  49
  50 =head3 get_search_groups
  51
  52 my @search_groups = $self->get_search_groups({[interface => 'staff' || 'opac']}))
  53
  54 Returns search groups for the specified interface.
  55 Defaults to OPAC if no interface is specified.
  56
  57 =cut
  58
  59 sub get_search_groups {
  60     my ( $self, $params ) = @_;
  61     my $interface = $params->{interface} || q{};
  62
  63     my $title = $interface eq 'staff' ? '__SEARCH_GROUPS__' : '__SEARCH_GROUPS_OPAC__';
  64
  65     my ($search_groups_root) =
  66       $self->search( { parent_id => undef, title => $title } );
  67
  68     return unless $search_groups_root;
  69
  70     my $children = $search_groups_root->children();
  71
  72     return wantarray ? $children->as_list : $children;
  73 }
  74
  75 =head3 type
  76
  77 =cut
  78
  79 sub _type {
  80     return 'LibraryGroup';
  81 }
  82
  83 =head3 object_class
  84
  85 =cut
  86
  87 sub object_class {
  88     return 'Koha::Library::Group';
  89 }
  90
  91 =head1 AUTHOR
  92
  93 Kyle M Hall <kyle@bywatersolutions.com>
  94
  95 =cut
  96
  97 1;