Bug 19040: Refactor GetMarcBiblio parameters
[koha.git] / Koha / SearchEngine.pm
index 407156f..70ef799 100644 (file)
@@ -1,29 +1,46 @@
 package Koha::SearchEngine;
+# This handles generic search-engine related functions
 
-use Moose;
-use C4::Context;
-use Koha::SearchEngine::Config;
-
-has 'name' => (
-    is => 'ro',
-    default => sub {
-        C4::Context->preference('SearchEngine');
-    }
-);
-
-has config => (
-    is => 'rw',
-    lazy => 1,
-    default => sub {
-        Koha::SearchEngine::Config->new;
-    }
-#    lazy => 1,
-#    builder => '_build_config',
-);
-
-#sub _build_config {
-#    my ( $self ) = @_;
-#    Koha::SearchEngine::Config->new( $self->name );
-#);
-
-1;
+# Copyright 2015 Catalyst IT
+#
+# This file is part of Koha.
+#
+# Koha is free software; you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation; either version 3 of the License, or (at your option) any later
+# version.
+#
+# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
+# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+use Readonly;
+
+=head1 NAME
+
+Koha::SearchEngine - non-engine-specific data and functions
+
+=head1 VARIABLES / CONSTANTS
+
+=head2 BIBLIOS_INDEX
+
+Use this constant when creating a new L<Koha::SearchEngine::Search> instance
+to indicate that you want to be working with the biblio index.
+
+=head2 AUTHORITIES_INDEX
+
+Use this constant when creating a new L<Koha::SearchEngine::Search> instance to
+indicate that you want to be working with the authorities index.
+
+=cut
+
+# Search engine implementations should compare against these to determine
+# what bit of storage is being requested. They will be sensible strings so
+# may be used for, e.g., directory names.
+Readonly our $BIBLIOS_INDEX     => 'biblios';
+Readonly our $AUTHORITIES_INDEX => 'authorities';