Koha/Item/Template.pm

   1 package Koha::Item::Template;
   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 Encode qw(encode_utf8);
  21 use JSON   qw(encode_json decode_json);
  22
  23 use base qw(Koha::Object);
  24
  25 =head1 NAME
  26
  27 Koha::Item::Template - Koha Item Template Object class
  28
  29 =head1 API
  30
  31 =head2 Class methods
  32
  33 =head3 store
  34
  35 Override base store method
  36 to serialize the template contents as JSON
  37
  38 =cut
  39
  40 sub store {
  41     my ($self) = @_;
  42
  43     if ( ref( $self->contents ) eq 'HASH' ) {
  44         $self->contents( $self->_json->encode( $self->contents ) );
  45     }
  46
  47     $self = $self->SUPER::store;
  48 }
  49
  50 =head3 decoded_contents
  51
  52 Returns a deserilized perl structure of the JSON formatted contents
  53
  54 =cut
  55
  56 sub decoded_contents {
  57     my ($self) = @_;
  58
  59     return $self->_json->decode($self->contents) if $self->contents;
  60 }
  61
  62 =head2 Internal methods
  63
  64 =head3 _json
  65
  66 =cut
  67
  68 sub _json {
  69     my $self = shift;
  70     $self->{_json} //= JSON->new; # Keep utf8 off !
  71 }
  72
  73 =head3 _type
  74
  75 =cut
  76
  77 sub _type {
  78     return 'ItemEditorTemplate';
  79 }
  80
  81 1;