1 package Koha::Library::Groups;
3 # Copyright ByWater Solutions 2016
5 # This file is part of Koha.
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
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.
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.
26 use Koha::Library::Group;
28 use base qw(Koha::Objects);
32 Koha::Library::Groups - Koha Library::Group object set class
38 =head3 my @root_groups = $self->get_root_group()
45 return $self->search( { parent_id => undef }, { order_by => 'title' } );
48 =head3 my @search_groups = $self->get_search_groups({[interface => 'staff' || 'opac']}))
50 Returns search groups for the specified interface.
51 Defaults to OPAC if no interface is specified.
55 sub get_search_groups {
56 my ( $self, $params ) = @_;
57 my $interface = $params->{interface} || q{};
59 my $title = $interface eq 'staff' ? '__SEARCH_GROUPS__' : '__SEARCH_GROUPS_OPAC__';
61 my ($search_groups_root) =
62 $self->search( { parent_id => undef, title => $title } );
64 return unless $search_groups_root;
66 my $children = $search_groups_root->children();
68 return wantarray ? $children->as_list : $children;
76 return 'LibraryGroup';
84 return 'Koha::Library::Group';
89 Kyle M Hall <kyle@bywatersolutions.com>