Validator::isXMLStringValid() - Code Metrics - Inspection of "feat: added a way to get error messages" - hyperized/xml-validator - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#138)

unknown

created 2024-05-16 11:07 UTC

Validator::isXMLStringValid() A

↳ Parent: Validator

Complexity

Conditions	3
Paths	5

Size

Total Lines	10
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	3

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
eloc	7
c	3
b	0
f	0
dl	0
loc	10
ccs	3
cts	3
cp	1
rs	10
cc	3
nc	5
nop	2
crap	3

<?php

declare(strict_types=1);

namespace Hyperized\Xml;

use DOMDocument;
use Hyperized\Xml\Constants\ErrorMessages;
use Hyperized\Xml\Constants\Strings;
use Hyperized\Xml\Exceptions\FileCouldNotBeOpenedException;
use Hyperized\Xml\Exceptions\InvalidXml;
use Hyperized\Xml\Exceptions\EmptyFile;
use Hyperized\Xml\Exceptions\FileDoesNotExist;
use Hyperized\Xml\Types\Files\Xml;
use Hyperized\Xml\Types\Files\Xsd;
use function is_string;
use LibXMLError;

/**
 * Class Validator
 *
 * @package Hyperized\Xml
 * Based on: http://stackoverflow.com/a/30058598/1757763
 */
final class Validator implements ValidatorInterface
{
    /**
     * @var string
     */
    private $version = Strings::VERSION;
    /**
     * @var string
     */
    private $encoding = Strings::UTF_8;

    /**
     * @var null|\Exception
     */
    private $error = null;

    public function isXMLFileValid(string $xmlPath, string $xsdPath = null): bool
    {
        try {
            $string = (new Xml($xmlPath))
                ->getContents();
        } catch (EmptyFile | FileCouldNotBeOpenedException | FileDoesNotExist $e) {
            $this->error = $e;
            return false;
        }

        if ($xsdPath !== null) {
            try {
                $xsdPath = (new Xsd($xsdPath))
                    ->getPath();
            } catch (FileDoesNotExist $e) {
                $this->error = $e;
                return false;
            }
        }

        return $this->isXMLStringValid($string, $xsdPath);
    }

    /**
     * @param  string      $xml
     * @param  string|null $xsdPath
     * @param  bool $returnError
     * @return bool
     */
    public function isXMLStringValid(string $xml, string $xsdPath = null): bool
    {
        try {
            if (is_string($xsdPath)) {
                return $this->isXMLValid($xml, $xsdPath);
            }
            return $this->isXMLValid($xml);
        } catch (InvalidXml $e) {
            $this->error = $e;
            return false;
        }
    }

    /**
     * @param  string      $xmlContent
     * @param  string|null $xsdPath
     * @return bool
     * @throws InvalidXml
     */
    private function isXMLValid(string $xmlContent, string $xsdPath = null): bool
    {
        self::checkEmptyWhenTrimmed($xmlContent);

        libxml_use_internal_errors(true);

        $document = new DOMDocument($this->version, $this->encoding);
        $document->loadXML($xmlContent);
        if (isset($xsdPath)) {
            $document->schemaValidate($xsdPath);
        }
        $errors = libxml_get_errors();
        libxml_clear_errors();
        self::parseErrors($errors);
        return true;
    }

    /**
     * @param  string $xmlContent
     * @throws InvalidXml
     */
    private static function checkEmptyWhenTrimmed(string $xmlContent): void
    {
        if (trim($xmlContent) === '') {
            throw new InvalidXml(ErrorMessages::XML_EMPTY_TRIMMED);
        }
    }

    /**
     * @param  array<LibXMLError>|null $errors
     * @throws InvalidXml
     */
    private static function parseErrors(?array $errors): void
    {
        if (!empty($errors)) {
            $reduced = array_reduce(
                $errors,
                static function (
                    ?array $carry,
                    LibXMLError $item
                ): array {
                    $carry[] = trim($item->message);
                    return $carry;
                }
            );

            if (!empty($reduced)) {
                throw new InvalidXml(implode(Strings::NEW_LINE, $reduced));
            }
        }
    }

    /**
     * @return string
     */
    public function getVersion(): string
    {
        return $this->version;
    }

    /**
     * @param string $version
     */
    public function setVersion(string $version): void
    {
        $this->version = $version;
    }

    /**
     * @return string
     */
    public function getEncoding(): string
    {
        return $this->encoding;
    }

    /**
     * @param string $encoding
     */
    public function setEncoding(string $encoding): void
    {
        $this->encoding = $encoding;
    }

    /**
     * @return int Will return 0 when no error has occurred
     */
    public function getErrorCode(): int
    {
        if (null !== $this->error) {
            return $this->error->getCode();
        }

        return 0;
    }

    /**
     * @return string Will return empty string when no error has occurred
     */
    public function getErrorMessage(): string
    {
        if (null !== $this->error) {
            return $this->error->getMessage();
        }

        return '';
    }

    public function getErrorType(): null|string
    {
        if (null !== $this->error) {
            return get_class($this->error);
        }

        return null;
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Hyperized\Xml;
6
7		use DOMDocument;
8		use Hyperized\Xml\Constants\ErrorMessages;
9		use Hyperized\Xml\Constants\Strings;
10		use Hyperized\Xml\Exceptions\FileCouldNotBeOpenedException;
11		use Hyperized\Xml\Exceptions\InvalidXml;
12		use Hyperized\Xml\Exceptions\EmptyFile;
13		use Hyperized\Xml\Exceptions\FileDoesNotExist;
14		use Hyperized\Xml\Types\Files\Xml;
15		use Hyperized\Xml\Types\Files\Xsd;
16		use function is_string;
17		use LibXMLError;
18
19		/**
20		* Class Validator
21		*
22		* @package Hyperized\Xml
23		* Based on: http://stackoverflow.com/a/30058598/1757763
24		*/
25		final class Validator implements ValidatorInterface
26		{
27		/**
28		* @var string
29		*/
30		private $version = Strings::VERSION;
31		/**
32		* @var string
33		*/
34	16	private $encoding = Strings::UTF_8;
35
36		/**
37	16	* @var null\|\Exception
38	14	*/
39	6	private $error = null;
40	2
41	4	public function isXMLFileValid(string $xmlPath, string $xsdPath = null): bool
42	2	{
43	2	try {
44	2	$string = (new Xml($xmlPath))
45		->getContents();
46		} catch (EmptyFile \| FileCouldNotBeOpenedException \| FileDoesNotExist $e) {
47	10	$this->error = $e;
48		return false;
49	6	}
50	4
51	2	if ($xsdPath !== null) {
52	2	try {
53		$xsdPath = (new Xsd($xsdPath))
54		->getPath();
55		} catch (FileDoesNotExist $e) {
56	8	$this->error = $e;
57		return false;
58		}
59		}
60
61		return $this->isXMLStringValid($string, $xsdPath);
62		}
63
64	14	/**
65		* @param string $xml
66		* @param string\|null $xsdPath
67	14	* @param bool $returnError
68	4	* @return bool
69		*/
70	10	public function isXMLStringValid(string $xml, string $xsdPath = null): bool
71	8	{
72	8	try {
73		if (is_string($xsdPath)) {
74		return $this->isXMLValid($xml, $xsdPath);
75		}
76		return $this->isXMLValid($xml);
77		} catch (InvalidXml $e) {
78		$this->error = $e;
79		return false;
80		}
81		}
82	14
83		/**
84	14	* @param string $xmlContent
85		* @param string\|null $xsdPath
86	12	* @return bool
87		* @throws InvalidXml
88	12	*/
89	12	private function isXMLValid(string $xmlContent, string $xsdPath = null): bool
90	12	{
91	4	self::checkEmptyWhenTrimmed($xmlContent);
92
93	12	libxml_use_internal_errors(true);
94	12
95	12	$document = new DOMDocument($this->version, $this->encoding);
96	6	$document->loadXML($xmlContent);
97		if (isset($xsdPath)) {
98		$document->schemaValidate($xsdPath);
99		}
100		$errors = libxml_get_errors();
101		libxml_clear_errors();
102		self::parseErrors($errors);
103	14	return true;
104		}
105	14
106	2	/**
107		* @param string $xmlContent
108	12	* @throws InvalidXml
109		*/
110		private static function checkEmptyWhenTrimmed(string $xmlContent): void
111		{
112		if (trim($xmlContent) === '') {
113		throw new InvalidXml(ErrorMessages::XML_EMPTY_TRIMMED);
114	12	}
115		}
116	12
117	6	/**
118	6	* @param array<LibXMLError>\|null $errors
119		* @throws InvalidXml
120		*/
121		private static function parseErrors(?array $errors): void
122		{
123	6	if (!empty($errors)) {
124	6	$reduced = array_reduce(
125	6	$errors,
126		static function (
127		?array $carry,
128	6	LibXMLError $item
129	6	): array {
130		$carry[] = trim($item->message);
131		return $carry;
132	6	}
133		);
134
135		if (!empty($reduced)) {
136		throw new InvalidXml(implode(Strings::NEW_LINE, $reduced));
137	2	}
138		}
139	2	}
140
141		/**
142		* @return string
143		*/
144		public function getVersion(): string
145	2	{
146		return $this->version;
147	2	}
148	2
149		/**
150		* @param string $version
151		*/
152		public function setVersion(string $version): void
153	2	{
154		$this->version = $version;
155	2	}
156
157		/**
158		* @return string
159		*/
160		public function getEncoding(): string
161	2	{
162		return $this->encoding;
163	2	}
164	2
165		/**
166		* @param string $encoding
167		*/
168		public function setEncoding(string $encoding): void
169		{
170		$this->encoding = $encoding;
171		}
172
173		/**
174		* @return int Will return 0 when no error has occurred
175		*/
176		public function getErrorCode(): int
177		{
178		if (null !== $this->error) {
179		return $this->error->getCode();
180		}
181
182		return 0;
183		}
184
185		/**
186		* @return string Will return empty string when no error has occurred
187		*/
188		public function getErrorMessage(): string
189		{
190		if (null !== $this->error) {
191		return $this->error->getMessage();
192		}
193
194		return '';
195		}
196
197		public function getErrorType(): null\|string
198		{
199		if (null !== $this->error) {
200		return get_class($this->error);
201		}
202
203		return null;
204		}
205		}
206

hyperized / xml-validator

Pull Request — master (#138)

Validator::isXMLStringValid() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like