"Fossies" - the Fresh Open Source Software Archive

Member "koha-19.11.15/Koha/SearchEngine.pm" (23 Feb 2021, 1590 Bytes) of package /linux/misc/koha-19.11.15.tar.gz:


As a special service "Fossies" has tried to format the requested source page into HTML format using (guessed) Perl source code syntax highlighting (style: standard) with prefixed line numbers and code folding option. Alternatively you can here view or download the uninterpreted source code file. For more information about "SearchEngine.pm" see the Fossies "Dox" file reference documentation.

    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 under the
    9 # terms of the GNU General Public License as published by the Free Software
   10 # Foundation; either version 3 of the License, or (at your option) any later
   11 # version.
   12 #
   13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
   14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
   15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
   16 #
   17 # You should have received a copy of the GNU General Public License along
   18 # with Koha; if not, write to the Free Software Foundation, Inc.,
   19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
   20 
   21 use Modern::Perl;
   22 use 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';