Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 40
0.00% covered (danger)
0.00%
0 / 2
 CRAP
0.00% covered (danger)
0.00%
0 / 1
common_log_XMLAppender
0.00% covered (danger)
0.00%
0 / 40
0.00% covered (danger)
0.00%
0 / 2
 20
0.00% covered (danger)
0.00%
0 / 1
 init
0.00% covered (danger)
0.00%
0 / 6
0.00% covered (danger)
0.00%
0 / 1
 6
 doLog
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
 6
1<?php
2
3/**
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU General Public License
6 * as published by the Free Software Foundation; under version 2
7 * of the License (non-upgradable).
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
17 *
18 * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg
19 *                         (under the project TAO & TAO2);
20 *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung
21 *                         (under the project TAO-TRANSFER);
22 *               2009-2012 (update and modification) Public Research Centre Henri Tudor
23 *                         (under the project TAO-SUSTAIN & TAO-DEV);
24 *               2013 (update and modification) Open Assessment Technologies SA (under the project TAO-PRODUCT);
25 *
26 */
27
28/**
29 * A xml appender that stores the log events in an XML format
30 *
31 * @access public
32 * @author Joel Bout, <joel.bout@tudor.lu>
33 * @package generis
34
35 */
36class common_log_XMLAppender extends common_log_BaseAppender
37{
38    // --- ASSOCIATIONS ---
39
40
41    // --- ATTRIBUTES ---
42
43    /**
44     * Short description of attribute filename
45     *
46     * @access public
47     * @var string
48     */
49    public $filename = '';
50
51    // --- OPERATIONS ---
52
53    /**
54     * Short description of method init
55     *
56     * @access public
57     * @author Joel Bout, <joel.bout@tudor.lu>
58     * @param  array configuration
59     * @return boolean
60     */
61    public function init($configuration)
62    {
63        $returnValue = (bool) false;
64
65
66        if (isset($configuration['file'])) {
67            $this->filename = $configuration['file'];
68            $returnValue = parent::init($configuration);
69        } else {
70            $returnValue = false;
71        }
72
73
74        return (bool) $returnValue;
75    }
76
77    /**
78     * Short description of method doLog
79     *
80     * @access public
81     * @author Joel Bout, <joel.bout@tudor.lu>
82     * @param  Item item
83     * @return mixed
84     */
85    public function doLog(common_log_Item $item)
86    {
87
88        $doc = new DOMDocument();
89        $doc->preserveWhiteSpace = false;
90        $doc->formatOutput = true;
91        $success = @$doc->load($this->filename);
92        if (!$success) {
93            $doc->loadXML('<events></events>');
94        }
95
96        $event_element = $doc->createElement("event");
97
98        $message = $doc->createElement("description");
99        $message->appendChild(
100            $doc->createCDATASection($item->getDescription())
101        );
102        $event_element->appendChild($message);
103
104        $file = $doc->createElement("file");
105        $file->appendChild(
106            $doc->createCDATASection($item->getCallerFile())
107        );
108        $event_element->appendChild($file);
109
110        $line = $doc->createElement("line");
111        $line->appendChild(
112            $doc->createCDATASection($item->getCallerLine())
113        );
114        $event_element->appendChild($line);
115
116        $datetime = $doc->createElement("datetime");
117        $datetime->appendChild(
118            $doc->createCDATASection($item->getDateTime())
119        );
120        $event_element->appendChild($datetime);
121
122        $severity = $doc->createElement("severity");
123        $severity->appendChild(
124            $doc->createCDATASection($item->getSeverity())
125        );
126        $event_element->appendChild($severity);
127
128
129        $doc->documentElement->appendChild($event_element);
130        @$doc->save($this->filename);
131    }
132}