Koha/SuggestionEngine/Plugin/ExplodedTerms.pm

   1 package Koha::SuggestionEngine::Plugin::ExplodedTerms;
   2
   3 # Copyright 2012 C & P Bibliography Services
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 =head1 NAME
  21
  22 Koha::SuggestionEngine::Plugin::ExplodedTerms - suggest searches for broader/narrower/related subjects
  23
  24 =head1 SYNOPSIS
  25
  26
  27 =head1 DESCRIPTION
  28
  29 Plugin to suggest expanding the search by adding broader/narrower/related
  30 subjects to subject searches.
  31
  32 =cut
  33
  34 use Modern::Perl;
  35
  36 use base qw(Koha::SuggestionEngine::Base);
  37
  38 use Koha::I18N qw(__);
  39
  40 =head2 NAME
  41     my $name = $plugin->NAME;
  42
  43 =cut
  44
  45 sub NAME {
  46     return 'ExplodedTerms';
  47 }
  48
  49 =head2 VERSION
  50     my $version = $plugin->VERSION;
  51
  52 =cut
  53
  54 sub VERSION {
  55     return '1.0';
  56 }
  57
  58 =head2 get_suggestions
  59
  60     my $suggestions = $plugin->get_suggestions(\%param);
  61
  62 Return suggestions for the specified search that add broader/narrower/related
  63 terms to the search.
  64
  65 =cut
  66
  67 sub get_suggestions {
  68     my ( $self, $param ) = @_;
  69
  70     my $search = $param->{'search'};
  71
  72     return if ( $search =~ m/^(ccl=|cql=|pqf=)/ );
  73     $search =~ s/(su|su-br|su-na|su-rl)[:=](\w*)/OP!$2/g;
  74     return if ( $search =~ m/\w+[:=]\w+/ );
  75
  76     my $indexes_to_label = {
  77         'su-na' => __('Search also for narrower subjects'),
  78         'su-br' => __('Search also for broader subjects'),
  79         'su-rl' => __('Search also for related subjects'),
  80     };
  81
  82     my @results;
  83     foreach my $index ( keys %{$indexes_to_label} ) {
  84         my $thissearch = $search;
  85         $thissearch = "$index:$thissearch"
  86           unless ( $thissearch =~ s/OP!/$index:/g );
  87         push @results, {
  88             'search'  => $thissearch,
  89             relevance => 100,
  90
  91             # FIXME: it'd be nice to have some empirical measure of
  92             #        "relevance" in this case, but we don't.
  93             label => $indexes_to_label->{$index}
  94         };
  95     }
  96     return \@results;
  97 }
  98
  99 1;