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
   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 =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
  40 =head2 NAME
  41     my $name = $plugin->NAME;
  42
  43 =cut
  44
  45 sub NAME {
  46     return 'Null';
  47 }
  48
  49 =head2 VERSION
  50     my $version = $plugin->VERSION;
  51
  52 =cut
  53
  54 sub VERSION {
  55     return '1.1';
  56 }
  57
  58 =head2 get_suggestions
  59
  60     my $suggestions = $suggestor->get_suggestions( {search => 'books');
  61
  62 Return a boring suggestion.
  63
  64 =cut
  65
  66 sub get_suggestions {
  67     my $self  = shift;
  68     my $param = shift;
  69
  70     my @result = ();
  71
  72     push @result, { search => 'book', label => 'Book!', relevance => 1 }
  73       if ( $param->{'search'} eq 'books' );
  74
  75     return \@result;
  76 }
  77
  78 1;