Koha/Template/Plugin/KohaNews.pm

   1 package Koha::Template::Plugin::KohaNews;
   2
   3 # Copyright ByWater Solutions 2012
   4 # Copyright BibLibre 2014
   5 # Parts copyright Athens County Public Libraries 2019
   6
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it
  10 # under the terms of the GNU General Public License as published by
  11 # the Free Software Foundation; either version 3 of the License, or
  12 # (at your option) any later version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but
  15 # WITHOUT ANY WARRANTY; without even the implied warranty of
  16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17 # GNU General Public License for more details.
  18 #
  19 # You should have received a copy of the GNU General Public License
  20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  21
  22 use Modern::Perl;
  23
  24 use Template::Plugin;
  25 use base qw( Template::Plugin );
  26
  27 use C4::Koha;
  28 use C4::Context;
  29 use Koha::News;
  30
  31 sub get {
  32     my ( $self, $params ) = @_;
  33
  34     my $display_location = $params->{location};
  35     my $blocktitle = $params->{blocktitle};
  36     my $lang = $params->{lang};
  37     my $library = $params->{library};
  38
  39     my $content = Koha::News->search_for_display({
  40             location => $display_location,
  41             lang => $lang,
  42             library_id => $library,
  43     });
  44
  45
  46     if( $content ){
  47         return {
  48             content => $content,
  49             location => $display_location,
  50             blocktitle => $blocktitle
  51         };
  52     } else {
  53         return;
  54     }
  55 }
  56
  57 1;
  58
  59 =head1 NAME
  60
  61 Koha::Template::Plugin::KohaNews - TT Plugin for displaying Koha news
  62
  63 =head1 SYNOPSIS
  64
  65 [% USE KohaNews %]
  66
  67 [% KohaNews.get() %]
  68
  69 =head1 ROUTINES
  70
  71 =head2 get
  72
  73 In a template, you can get the all categories with
  74 the following TT code: [% KohaNews.get() %]
  75
  76 =head1 AUTHOR
  77
  78 Owen Leonard <oleonard@myacpl.org>
  79
  80 =cut