Koha/SearchEngine.pm

   1 package Koha::SearchEngine;
   2 # This handles generic search-engine related functions
   3
   4 # Copyright 2015 Catalyst IT
   5 #
   6 # This file is part of Koha.
   7 #
   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.
  12 #
  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.
  17 #
  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>.
  20
  21 use Modern::Perl;
  22 use Readonly qw( Readonly );
  23
  24 =head1 NAME
  25
  26 Koha::SearchEngine - non-engine-specific data and functions
  27
  28 =head1 VARIABLES / CONSTANTS
  29
  30 =head2 BIBLIOS_INDEX
  31
  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.
  34
  35 =head2 AUTHORITIES_INDEX
  36
  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.
  39
  40 =cut
  41
  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';
  47
  48 1;