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