Koha/SuggestionEngine/Plugin/Null.pm

   1 package Koha::SuggestionEngine::Plugin::Null;
   2
   3 # Copyright 2012 C & P Bibliography Services
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 =head1 NAME
  21
  22 Koha::SuggestionEngine::Plugin::Null - an example plugin that does nothing but allow us to run tests
  23
  24 =head1 SYNOPSIS
  25
  26
  27 =head1 DESCRIPTION
  28
  29 Plugin to allow us to run unit tests and regression tests against the
  30 SuggestionEngine.
  31
  32 =cut
  33
  34 use strict;
  35 use warnings;
  36 use Carp;
  37
  38 use base qw(Koha::SuggestionEngine::Base);
  39 our $NAME    = 'Null';
  40 our $VERSION = '1.0';
  41
  42 =head2 get_suggestions
  43
  44     my $suggestions = $suggestor->get_suggestions( {search => 'books');
  45
  46 Return a boring suggestion.
  47
  48 =cut
  49
  50 sub get_suggestions {
  51     my $self  = shift;
  52     my $param = shift;
  53
  54     my @result = ();
  55
  56     push @result, { search => 'book', label => 'Book!', relevance => 1 }
  57       if ( $param->{'search'} eq 'books' );
  58
  59     return \@result;
  60 }