Bug 23830: Make Koha::AuthorisedValues use Koha::Objects::Limit::Library
[srvgit] / Koha / AuthorisedValues.pm
index e690d8c..b23190d 100644 (file)
@@ -4,18 +4,18 @@ package Koha::AuthorisedValues;
 #
 # 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 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.
+# 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.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use Modern::Perl;
 
@@ -24,12 +24,14 @@ use Carp;
 use Koha::Database;
 
 use Koha::AuthorisedValue;
+use Koha::MarcSubfieldStructures;
+use Koha::Cache::Memory::Lite;
 
-use base qw(Koha::Objects);
+use base qw(Koha::Objects Koha::Objects::Limit::Library);
 
 =head1 NAME
 
-Koha::AuthorisedValues - Koha AuthorisedValue Object set class
+Koha::AuthorisedValues - Koha Authorised value Object set class
 
 =head1 API
 
@@ -37,29 +39,100 @@ Koha::AuthorisedValues - Koha AuthorisedValue Object set class
 
 =cut
 
-=head3 Koha::AuthorisedValues->search();
+sub search_by_marc_field {
+    my ( $self, $params ) = @_;
+    my $frameworkcode = $params->{frameworkcode} || '';
+    my $tagfield      = $params->{tagfield};
+    my $tagsubfield   = $params->{tagsubfield};
 
-my @objects = Koha::AuthorisedValues->search($params);
+    return unless $tagfield or $tagsubfield;
 
-=cut
+    return $self->SUPER::search(
+        {   'marc_subfield_structures.frameworkcode' => $frameworkcode,
+            ( defined $tagfield    ? ( 'marc_subfield_structures.tagfield'    => $tagfield )    : () ),
+            ( defined $tagsubfield ? ( 'marc_subfield_structures.tagsubfield' => $tagsubfield ) : () ),
+        },
+        { join => { category => 'marc_subfield_structures' } }
+    );
+}
+
+sub search_by_koha_field {
+    my ( $self, $params ) = @_;
+    my $frameworkcode    = $params->{frameworkcode} || '';
+    my $kohafield        = $params->{kohafield};
+    my $category         = $params->{category};
+
+    return unless $kohafield;
+
+    return $self->SUPER::search(
+        {   'marc_subfield_structures.frameworkcode' => $frameworkcode,
+            'marc_subfield_structures.kohafield'     => $kohafield,
+            ( defined $category ? ( category_name    => $category )         : () ),
+        },
+        {   join     => { category => 'marc_subfield_structures' },
+            distinct => 1,
+        }
+    );
+}
+
+sub find_by_koha_field {
+    my ( $self, $params ) = @_;
+    my $frameworkcode    = $params->{frameworkcode} || '';
+    my $kohafield        = $params->{kohafield};
+    my $authorised_value = $params->{authorised_value};
+
+    my $av = $self->SUPER::search(
+        {   'marc_subfield_structures.frameworkcode' => $frameworkcode,
+            'marc_subfield_structures.kohafield'     => $kohafield,
+            'me.authorised_value'                    => $authorised_value,
+        },
+        {   join     => { category => 'marc_subfield_structures' },
+            distinct => 1,
+        }
+    );
+    return $av->count ? $av->next : undef;
+}
+
+sub get_description_by_koha_field {
+    my ( $self, $params ) = @_;
+    my $frameworkcode    = $params->{frameworkcode} || '';
+    my $kohafield        = $params->{kohafield};
+    my $authorised_value = $params->{authorised_value};
+
+    return {} unless defined $authorised_value;
+
+    my $memory_cache = Koha::Cache::Memory::Lite->get_instance;
+    my $cache_key    = "AV_descriptions:$frameworkcode:$kohafield:$authorised_value";
+    my $cached       = $memory_cache->get_from_cache($cache_key);
+    return $cached if $cached;
+
+    my $av = $self->find_by_koha_field($params);
+    return {} unless defined $av;
+    my $descriptions = { lib => $av->lib, opac_description => $av->opac_description };
+    $memory_cache->set_in_cache( $cache_key, $descriptions );
+    return $descriptions;
+}
 
-sub search {
+sub get_descriptions_by_koha_field {
     my ( $self, $params ) = @_;
+    my $frameworkcode = $params->{frameworkcode} || '';
+    my $kohafield = $params->{kohafield};
+
+    my $memory_cache = Koha::Cache::Memory::Lite->get_instance;
+    my $cache_key    = "AV_descriptions:$frameworkcode:$kohafield";
+    my $cached       = $memory_cache->get_from_cache($cache_key);
+    return @$cached if $cached;
 
-    my $branchcode = $params->{branchcode};
-    delete( $params->{branchcode} );
-
-    my $or =
-      $branchcode
-      ? {
-        '-or' => [
-            'authorised_values_branches.branchcode' => undef,
-            'authorised_values_branches.branchcode' => $branchcode,
-        ]
-      }
-      : {};
-    my $join = $branchcode ? { join => 'authorised_values_branches' } : {};
-    return $self->SUPER::search( { %$params, %$or, }, $join );
+    my @avs          = $self->search_by_koha_field($params);
+    my @descriptions = map {
+        {
+            authorised_value => $_->authorised_value,
+            lib              => $_->lib,
+            opac_description => $_->opac_description
+        }
+    } @avs;
+    $memory_cache->set_in_cache( $cache_key, \@descriptions );
+    return @descriptions;
 }
 
 sub categories {
@@ -79,7 +152,7 @@ sub categories {
 
 =cut
 
-sub type {
+sub _type {
     return 'AuthorisedValue';
 }