Bug 15707: Add Koha::Library::Group(s) modules

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>

diff --git a/Koha/Library/Group.pm b/Koha/Library/Group.pm
new file mode 100644 (file)
index 0000000..144ee30
--- /dev/null
+++ b/Koha/Library/Group.pm
@@ -0,0 +1,121 @@
+package Koha::Library::Group;
+
+# Copyright ByWater Solutions 2016
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+
+use Carp;
+
+use Koha::Database;
+use Koha::DateUtils qw(dt_from_string);
+use Koha::Libraries;
+
+use base qw(Koha::Object);
+
+=head1 NAME
+
+Koha::Library::Group - Koha Library::Group object class
+
+=head1 API
+
+=head2 Class Methods
+
+=cut
+
+=head3 my @children = $self->get_children()
+
+=cut
+
+sub children {
+    my ($self) = @_;
+
+    my $children =
+      Koha::Library::Groups->search( { parent_id => $self->id }, { order_by => [ 'title', 'branchcode' ] } );
+
+    return $children;
+}
+
+=head3 library
+
+my $library = $group->library();
+
+Returns the library for this group if one exists
+
+=cut
+
+sub library {
+    my ($self) = @_;
+
+    return unless $self->branchcode;
+
+    return Koha::Libraries->find( $self->branchcode );
+}
+
+=head3 libraries_not_direct_children
+
+my @libraries = $group->libraries_not_direct_children();
+
+Returns the libraries *not* set as direct children of this group
+
+=cut
+
+sub libraries_not_direct_children {
+    my ($self) = @_;
+
+    my @children = Koha::Library::Groups->search(
+        {
+            parent_id  => $self->id,
+            branchcode => { '!=' => undef },
+        },
+        { order_by => 'branchcode' }
+    );
+
+    my @branchcodes = map { $_->branchcode } @children;
+
+    return Koha::Libraries->search( { branchcode => { -not_in => \@branchcodes } } );
+}
+
+=head3 store
+
+=cut
+
+sub store {
+    my ($self) = @_;
+
+    my $now = dt_from_string;
+    $self->updated_on($now);
+    $self->created_on($now) unless $self->in_storage();
+
+    return $self->SUPER::store(@_);
+}
+
+=head3 type
+
+=cut
+
+sub type {
+    return 'LibraryGroup';
+}
+
+=head1 AUTHOR
+
+Kyle M Hall <kyle@bywatersolutions.com>
+
+=cut
+
+1;

diff --git a/Koha/Library/Groups.pm b/Koha/Library/Groups.pm
new file mode 100644 (file)
index 0000000..b56baae
--- /dev/null
+++ b/Koha/Library/Groups.pm
@@ -0,0 +1,70 @@
+package Koha::Library::Groups;
+
+# Copyright ByWater Solutions 2016
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+
+use Carp;
+
+use Koha::Database;
+
+use Koha::Library::Group;
+
+use base qw(Koha::Objects);
+
+=head1 NAME
+
+Koha::Library::Groups - Koha Library::Group object set class
+
+=head1 API
+
+=head2 Class Methods
+
+=head3 my @root_groups = $self->get_root_group()
+
+=cut
+
+sub get_root_groups {
+    my ( $self ) = @_;
+
+    return $self->search( { parent_id => undef }, { order_by => 'title' } );
+}
+
+=head3 type
+
+=cut
+
+sub type {
+    return 'LibraryGroup';
+}
+
+=head3 object_class
+
+=cut
+
+sub object_class {
+    return 'Koha::Library::Group';
+}
+
+=head1 AUTHOR
+
+Kyle M Hall <kyle@bywatersolutions.com>
+
+=cut
+
+1;