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