Koha/SearchEngine/Search.pm

   1 package Koha::SearchEngine::Search;
   2
   3 # This file is part of Koha.
   4 #
   5 # Copyright 2015 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 search object for your
  21 # system preference.
  22
  23 =head1 NAME
  24
  25 Koha::SearchEngine::Search - instantiate the search object that corresponds to
  26 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 search object you need.
  32
  33 =head1 SYNOPSIS
  34
  35     use Koha::SearchEngine::Search;
  36     my $searcher = Koha::SearchEngine::Search->new();
  37
  38 =head1 METHODS
  39
  40 =head2 new
  41
  42 Creates a new C<Search> of whatever the relevant type is.
  43
  44 =cut
  45
  46 use Modern::Perl;
  47 use C4::Context;
  48 use C4::Biblio qw//;
  49
  50 sub new {
  51     my $engine = C4::Context->preference("SearchEngine") // 'Zebra';
  52     my $file = "Koha/SearchEngine/${engine}/Search.pm";
  53     my $class = "Koha::SearchEngine::${engine}::Search";
  54     require $file;
  55     shift @_;
  56     return $class->new(@_);
  57 }
  58
  59 =head2 extract_biblionumber
  60
  61     my $biblionumber = $searcher->extract_biblionumber( $marc );
  62
  63 Returns the biblionumber from $marc. The routine is called from the
  64 extract_biblionumber method of the specific search engine.
  65
  66 =cut
  67
  68 sub extract_biblionumber {
  69     my ( $record ) = @_;
  70     return if ref($record) ne 'MARC::Record';
  71     my ( $biblionumbertagfield, $biblionumbertagsubfield ) = C4::Biblio::GetMarcFromKohaField( 'biblio.biblionumber' );
  72     if( $biblionumbertagfield < 10 ) {
  73         my $controlfield = $record->field( $biblionumbertagfield );
  74         return $controlfield ? $controlfield->data : undef;
  75     }
  76     return $record->subfield( $biblionumbertagfield, $biblionumbertagsubfield );
  77 }
  78
  79 1;