Bug 17600: Standardize our EXPORT_OK
[srvgit] / Koha / SuggestionEngine / Plugin / AuthorityFile.pm
1 package Koha::SuggestionEngine::Plugin::AuthorityFile;
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::AuthorityFile - get suggestions from the authority file
23
24 =head1 SYNOPSIS
25
26
27 =head1 DESCRIPTION
28
29 Plugin to get suggestions from Koha's authority file
30
31 =cut
32
33 use Modern::Perl;
34
35 use base qw(Koha::SuggestionEngine::Base);
36
37 =head2 NAME
38     my $name = $plugin->NAME;
39
40 =cut
41
42 sub NAME {
43     return 'AuthorityFile';
44 }
45
46 =head2 VERSION
47     my $version = $plugin->VERSION;
48
49 =cut
50
51 sub VERSION {
52     return '1.1';
53 }
54
55 =head2 get_suggestions
56
57     my $suggestions = $plugin->get_suggestions(\%param);
58
59 Return suggestions for the specified search by searching for the
60 search terms in the authority file and returning the results.
61
62 =cut
63
64 sub get_suggestions {
65     my $self  = shift;
66     my $param = shift;
67
68     my $search = $param->{'search'};
69
70     # Remove any CCL. This does not handle CQL or PQF, which is unfortunate,
71     # but what can you do? At some point the search will have to be passed
72     # not as a string but as some sort of data structure, at which point it
73     # will be possible to support multiple search syntaxes.
74     $search =~ s/ccl=//;
75     $search =~ s/\w*[:=](\w*)/$1/g;
76
77     my @marclist  = ['mainentry'];
78     my @and_or    = ['and'];
79     my @excluding = [];
80     my @operator  = ['any'];
81     my @value     = ["$search"];
82
83     # FIXME: calling into C4
84     require C4::AuthoritiesMarc;
85     my ( $searchresults, $count ) = C4::AuthoritiesMarc::SearchAuthorities(
86         @marclist,  @and_or, @excluding,       @operator,
87         @value,      0,        $param->{'count'}, '',
88         'Relevance', 0
89     );
90
91     my @results;
92     foreach my $auth (@$searchresults) {
93         push @results,
94           {
95             'search'  => "an:$auth->{'authid'}",
96             relevance => $count--,
97             label     => $auth->{summary}->{authorized}->[0]->{heading}
98           };
99     }
100     return \@results;
101 }
102
103 1;