Koha/SearchEngine/QueryBuilder.pm

   1 package Koha::SearchEngine::QueryBuilder;
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright 2014 Catalyst IT
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 # This is a shim that gives you the appropriate query builder for your
  21 # system preference.
  22
  23 =head1 NAME
  24
  25 Koha::SearchEngine::QueryBuilder - instantiates the query builder that
  26 corresponds to the C<SearchEngine> system preference
  27
  28 =head1 DESCRIPTION
  29
  30 This allows you to be agnostic about what the search engine configuration is
  31 and just get whatever querybuilder you need.
  32
  33 =head1 SYNOPSIS
  34
  35     use Koha::SearchEngine::QueryBuilder;
  36     my $qb = Koha::SearchEngine::QueryBuilder->new({index => $Koha::SearchEngine::BIBLIOS_INDEX});
  37
  38 =head1 METHODS
  39
  40 =head2 new
  41
  42 Creates a new C<QueryBuilder> of whatever the relevant type is.
  43
  44 =cut
  45
  46 use C4::Context;
  47 use Modern::Perl;
  48 use Carp;
  49
  50 sub new {
  51     my $engine = C4::Context->preference("SearchEngine");
  52     my $file = "Koha/SearchEngine/${engine}/QueryBuilder.pm";
  53     my $class = "Koha::SearchEngine::${engine}::QueryBuilder";
  54     croak "SearchEngine system preference not set" unless $engine;
  55     require $file;
  56     shift @_;
  57     return $class->new(@_);
  58 }
  59
  60 1;