Koha/Config/SysPref.pm

   1 package Koha::Config::SysPref;
   2
   3 # Copyright ByWater Solutions 2014
   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 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use C4::Log;
  27
  28 use base qw(Koha::Object);
  29
  30 =head1 NAME
  31
  32 Koha::Config::SysPref - Koha System Preference Object class
  33
  34 =head1 API
  35
  36 =head2 Class Methods
  37
  38 =cut
  39
  40 =head3 get_yaml_pref_hash
  41
  42 Turn a pref defined via YAML as a hash
  43
  44 =cut
  45
  46 sub get_yaml_pref_hash {
  47     my ( $self ) = @_;
  48     return if !defined( $self );
  49
  50     my @lines = split /\n/, $self->value//'';
  51     my $pref_as_hash;
  52     foreach my $line (@lines){
  53         my ($field,$array) = split /:/, $line;
  54         next if !$array;
  55         $field =~ s/^\s*|\s*$//g;
  56         $array =~ s/[ [\]\r]//g;
  57         my @array = split /,/, $array;
  58         @array = map { $_ eq '""' || $_ eq "''" ? '' : $_ } @array;
  59         @array = map { $_ eq 'NULL' ? undef : $_ } @array;
  60         $pref_as_hash->{$field} = \@array;
  61     }
  62
  63     return $pref_as_hash;
  64 }
  65
  66
  67 =head3 store
  68
  69 =cut
  70
  71 sub store {
  72     my ($self) = @_;
  73
  74     my $action = $self->in_storage ? 'MODIFY' : 'ADD';
  75
  76     C4::Log::logaction( 'SYSTEMPREFERENCE', $action, undef, $self->variable . ' | ' . $self->value );
  77
  78     return $self->SUPER::store($self);
  79 }
  80
  81 =head3 delete
  82
  83 =cut
  84
  85 sub delete {
  86     my ($self) = @_;
  87
  88     my $variable = $self->variable;
  89     my $value    = $self->value;
  90     my $deleted  = $self->SUPER::delete($self);
  91
  92     C4::Log::logaction( 'SYSTEMPREFERENCE', 'DELETE', undef, " $variable | $value" );
  93
  94     return $deleted;
  95 }
  96
  97 =head3 type
  98
  99 =cut
 100
 101 sub _type {
 102     return 'Systempreference';
 103 }
 104
 105 =head1 AUTHOR
 106
 107 Kyle M Hall <kyle@bywatersolutions.com>
 108
 109 =cut
 110
 111 1;