Bug 18316: Add weighting/relevancy options to ES query on simple search
[koha.git] / Koha / SearchFields.pm
1 package Koha::SearchFields;
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 3 of the License, or (at your option) any later
8 # version.
9 #
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License along
15 # with Koha; if not, write to the Free Software Foundation, Inc.,
16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
17
18 use Modern::Perl;
19
20 use Carp;
21
22 use Koha::Database;
23
24 use Koha::SearchField;
25
26 use base qw(Koha::Objects);
27
28 =head1 NAME
29
30 Koha::SearchFields - Koha SearchField Object set class
31
32 =head1 API
33
34 =head2 Class Methods
35
36 =cut
37
38 =head3 weighted_fields
39
40 my (@w_fields, @weight) = Koha::SearchFields->weighted_fields();
41
42 =cut
43
44 sub weighted_fields {
45     my ($self) = @_;
46
47     my ($w_fields, $weight) = ([], []);
48     my $fields = $self->search(
49         { weight => { '>' => 0, '!=' => undef } },
50         { order_by => { -desc => 'weight' } }
51     );
52
53     while ( my $field = $fields->next ) {
54         push @$w_fields, $field->name;
55         push @$weight, $field->weight;
56     }
57
58     return ($w_fields, $weight);
59 }
60
61 =head3 type
62
63 =cut
64
65 sub _type {
66     return 'SearchField';
67 }
68
69 sub object_class {
70     return 'Koha::SearchField';
71 }
72
73 1;