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