1775160cb5ee5aa372afffd09704d77046e69522
[srvgit] / 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     # We want to use C4::Context->preference in any cases
51     # It's cached, and mock_preference still works from tests
52     my @lines = split /\n/, C4::Context->preference($self->variable) // '';
53     my $pref_as_hash;
54     foreach my $line (@lines){
55         my ($field,$array) = split /:/, $line;
56         next if !$array;
57         $field =~ s/^\s*|\s*$//g;
58         $array =~ s/[ [\]\r]//g;
59         my @array = split /,/, $array;
60         @array = map { $_ eq '""' || $_ eq "''" ? '' : $_ } @array;
61         @array = map { $_ eq 'NULL' ? undef : $_ } @array;
62         $pref_as_hash->{$field} = \@array;
63     }
64
65     return $pref_as_hash;
66 }
67
68
69 =head3 store
70
71 =cut
72
73 sub store {
74     my ($self) = @_;
75
76     my $action = $self->in_storage ? 'MODIFY' : 'ADD';
77
78     C4::Log::logaction( 'SYSTEMPREFERENCE', $action, undef, $self->variable . ' | ' . $self->value );
79
80     return $self->SUPER::store($self);
81 }
82
83 =head3 delete
84
85 =cut
86
87 sub delete {
88     my ($self) = @_;
89
90     my $variable = $self->variable;
91     my $value    = $self->value;
92     my $deleted  = $self->SUPER::delete($self);
93
94     C4::Log::logaction( 'SYSTEMPREFERENCE', 'DELETE', undef, " $variable | $value" );
95
96     return $deleted;
97 }
98
99 =head3 type
100
101 =cut
102
103 sub _type {
104     return 'Systempreference';
105 }
106
107 =head1 AUTHOR
108
109 Kyle M Hall <kyle@bywatersolutions.com>
110
111 =cut
112
113 1;