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
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.
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.
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>.
25 use Koha::Library::Group;
27 use base qw(Koha::Objects);
31 Koha::Library::Groups - Koha Library::Group object set class
37 =head3 get_root_groups
39 my @root_groups = $self->get_root_group()
46 return $self->search( { parent_id => undef }, { order_by => 'title' } );
49 =head3 get_search_groups
51 my $search_groups = $self->get_search_groups({[interface => 'staff' || 'opac']}))
53 Returns search groups for the specified interface.
54 Defaults to OPAC if no interface is specified.
58 sub get_search_groups {
59 my ( $self, $params ) = @_;
60 my $interface = $params->{interface} || q{};
62 my $field = $interface eq 'staff' ? 'ft_search_groups_staff' : 'ft_search_groups_opac';
64 return $self->search( { $field => 1 }, { order_by => 'title' } );
68 =head3 get_root_ancestor
70 my $root_ancestor = $self->get_root_ancestor( {id => $group_id } )
72 Retrieve root ancestor group for a specified id.
76 sub get_root_ancestor {
77 my ( $self, $params ) = @_;
78 my $row = $self->find($params);
79 return $row unless $row->parent_id;
80 return $self->get_root_ancestor( { id => $row->parent_id } );
89 return 'LibraryGroup';
97 return 'Koha::Library::Group';
102 Kyle M Hall <kyle@bywatersolutions.com>