Passed
Push — develop ( c95d07...475f16 )
by nguereza
03:12
created

XmlErrorRenderer::getExceptionXml()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12
Code Lines 8

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 8
c 1
b 0
f 0
nc 1
nop 1
dl 0
loc 12
rs 10
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant PHP
7
 * Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file XmlErrorRenderer.php
34
 *
35
 *  The XML error renderer class used to render the errors
36
 * for xml content type
37
 *
38
 *  @package    Platine\Framework\Handler\Error\Renderer
39
 *  @author Platine Developers team
40
 *  @copyright  Copyright (c) 2020
41
 *  @license    http://opensource.org/licenses/MIT  MIT License
42
 *  @link   http://www.iacademy.cf
43
 *  @version 1.0.0
44
 *  @filesource
45
 */
46
47
declare(strict_types=1);
48
49
namespace Platine\Framework\Handler\Error\Renderer;
50
51
use Throwable;
52
53
/**
54
 * @class XmlErrorRenderer
55
 * @package Platine\Framework\Handler\Error\Renderer
56
 */
57
class XmlErrorRenderer extends AbstractErrorRenderer
58
{
59
60
    /**
61
     * {@inheritdoc}
62
     */
63
    public function render(Throwable $exception, bool $detail, bool $isLog = false): string
64
    {
65
        $xml = '<?xml version="1.0" encoding="UTF-8" standalone="yes"?>' . "\n";
66
        $xml .= '<error>';
67
        $xml .= '<message>' . $this->addCharacterData($exception->getMessage()) . '</message>';
68
69
        if ($detail) {
70
            $xml .= '<exceptions>';
71
            do {
72
                $xml .= $this->getExceptionXml($exception);
73
            } while ($exception = $exception->getPrevious());
74
            $xml .= '</exceptions>';
75
        }
76
        $xml .= '</error>';
77
78
        return $xml;
79
    }
80
81
    /**
82
     * Render exception data
83
     * @param Throwable $exception
84
     * @return string
85
     */
86
    protected function getExceptionXml(Throwable $exception): string
87
    {
88
89
        $xml = '<exception>';
90
        $xml .= '<type>' . get_class($exception) . '</type>';
91
        $xml .= '<code>' . $exception->getCode() . '</code>';
92
        $xml .= '<message>' . $this->addCharacterData($exception->getMessage()) . '</message>';
93
        $xml .= '<file>' . $exception->getFile() . '</file>';
94
        $xml .= '<line>' . $exception->getLine() . '</line>';
95
        $xml .= '</exception>';
96
97
        return $xml;
98
    }
99
100
    /**
101
     * Add CDATA to the given string
102
     * @param string $value
103
     * @return string
104
     */
105
    protected static function addCharacterData(string $value): string
106
    {
107
        return sprintf('<![CDATA[%s]]>', $value);
108
    }
109
}
110