Bug 26922: Regression tests
[koha.git] / Koha / SearchEngine.pm
blobd2d58bbb35d04012d03d5bccffd1700954813e89
1 package Koha::SearchEngine;
2 # This handles generic search-engine related functions
4 # Copyright 2015 Catalyst IT
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
21 use Modern::Perl;
22 use Readonly;
24 =head1 NAME
26 Koha::SearchEngine - non-engine-specific data and functions
28 =head1 VARIABLES / CONSTANTS
30 =head2 BIBLIOS_INDEX
32 Use this constant when creating a new L<Koha::SearchEngine::Search> instance
33 to indicate that you want to be working with the biblio index.
35 =head2 AUTHORITIES_INDEX
37 Use this constant when creating a new L<Koha::SearchEngine::Search> instance to
38 indicate that you want to be working with the authorities index.
40 =cut
42 # Search engine implementations should compare against these to determine
43 # what bit of storage is being requested. They will be sensible strings so
44 # may be used for, e.g., directory names.
45 Readonly our $BIBLIOS_INDEX => 'biblios';
46 Readonly our $AUTHORITIES_INDEX => 'authorities';