Bug 13618: Add POD to raw.pm
[koha.git] / Koha / Template / Plugin / raw.pm
1 package Koha::Template::Plugin::raw;
2
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it
6 # under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
9 #
10 # Koha is distributed in the hope that it will be useful, but
11 # WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
17
18 use Modern::Perl;
19
20 use Template::Plugin::Filter;
21 use base qw( Template::Plugin::Filter );
22
23 our $DYNAMIC = 1;
24
25 sub filter {
26     my ( $self, $text ) = @_;
27     return $text;
28 }
29
30 1;
31
32 =head1 NAME
33
34 Koha::Template::Plugin::raw - TT Plugin for filtering variables as raw
35
36 =head1 SYNOPSIS
37
38 [% USE raw %]
39
40 [% my_var | $raw %]
41
42 The variable will not be modified and display at it.
43
44 It is required to use a filter to display any variables in .tt or .inc
45
46 In most of the case, you need to use the html filter instead.
47
48 =head1 METHODS
49
50 =head2 filter
51
52 Will return the variable as it. Nothing is changed.
53
54 =head1 AUTHOR
55
56 Jonathan Druart <jonathan.druart@biblibre.com>
57
58 =cut