aboutsummaryrefslogtreecommitdiffstats
path: root/lib/ManaTools/SettingsReader.pm
blob: defc93da4b646a5897ea93a9c5e9d7d7f0973b2f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
# vim: set et ts=4 sw=4:
package ManaTools::SettingsReader;
#============================================================= -*-perl-*-

=head1 NAME

    ManaTools::SettingsReader - This module allows to load an XML configuration file

=head1 SYNOPSIS

    use ManaTools::SettingsReader;

    my $settings = new ManaTools::SettingsReader({filNema => $fileName});

=head1 DESCRIPTION

    This module allows to load a configuration file returning a Hash references with its content.

=head1 SUPPORT

    You can find documentation for this module with the perldoc command:

    perldoc ManaTools::SettingsReader

=head1 SEE ALSO

    XML::Simple

=head1 AUTHOR

    Angelo Naselli <anaselli@linux.it>

=head1 COPYRIGHT and LICENSE

    Copyright (C) 2012-2017, Angelo Naselli.

   This file is part of ManaTools

   ManaTools is free software: you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation, either version 2 of the License, or
   (at your option) any later version.

   ManaTools is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with ManaTools.  If not, see <http://www.gnu.org/licenses/>.

=head1 FUNCTIONS

=cut


use Moose;
use diagnostics;
use XML::Simple;
use Data::Dumper;

#=============================================================

=head2 new

=head3 INPUT

    hash ref containing
        fileName: settings configuration file name

=head3 OUTPUT attributes

    settings: Hash reference containing read settings

=head3 DESCRIPTION

    The constructor just loads the given file and return its representation
    into a hash reference.

=cut

#=============================================================

has 'fileName' => (
    is       => 'ro',
    isa      => 'Str',
    required => 1,
);

has 'settings' => (
    is       => 'ro',
    isa      => 'HashRef',
    init_arg => undef,
    lazy     => 1,
    builder  => '_settingsInitialize',
);

sub _settingsInitialize {
    my $self = shift;

    my $xml = new XML::Simple ();
    my $cont = $xml->XMLin(
        $self->fileName(),
        ContentKey => '-content',
        ForceArray => ['title', 'category_title'],
        KeyAttr    => {
            title => "xml:lang",
            category_title => "xml:lang",
        }
    );

    return $cont;
}

no Moose;
1;