SchemaValidatableElementTrait::getSchemaFile() - Code Metrics - Inspection of "Offload schema validation to a trait+interface com..." - simplesamlphp/xml-common - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#50)

by Tim

created 2024-12-16 19:57 UTC

SchemaValidatableElementTrait::getSchemaFile() A

↳ Parent: SchemaValidatableElementTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	8
rs	10
cc	2
nc	2
nop	0

<?php

declare(strict_types=1);

namespace SimpleSAML\XML;

use DOMDocument;
use SimpleSAML\Assert\Assert;
use SimpleSAML\Exception\IOException;
filter:
    dependency_paths: ["lib/*"]
use SimpleSAML\Exception\SchemaViolationException;
filter:
    dependency_paths: ["lib/*"]

use function array_unique;
use function defined;
use function file_exists;
use function implode;
use function sprintf;
use function trim;
use function libxml_get_errors;

/**
 * trait class to be used by all the classes that implement the SchemaValidatableElementInterface
 *
 * @package simplesamlphp/xml-common
 */
trait SchemaValidatableElementTrait
{
    /**
     * Validate the given DOMDocument against the schema set for this element
     *
     * @return void
     * @throws \SimpleSAML\XML\Exception\SchemaViolationException
     */
    public static function schemaValidate(DOMDocument $document): DOMDocument
    {
        $schemaFile = self::getSchemaFile();
        $result = $document->schemaValidate($schemaFile);

        if ($result === false) {
            $msgs = [];
            foreach (libxml_get_errors() as $err) {
                $msgs[] = trim($err->message) . ' on line ' . $err->line;
            }

            throw new SchemaViolationException(sprintf(
                "XML schema validation errors:\n - %s",
                implode("\n - ", array_unique($msgs)),
            ));
        }

        return $document;

    }


    /**
     * Get the schema file that can validate this element.
     *
     * @return string
     */
    public static function getSchemaFile(): string
    {
        if (defined('static::SCHEMA')) {
            $schemaFile = static::SCHEMA;

        }

        Assert::true(file_exists($schemaFile), IOException::class);

        return $schemaFile;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XML;
6
7			use DOMDocument;
8			use SimpleSAML\Assert\Assert;
9			use SimpleSAML\Exception\IOException;
			0 ignored issues – show Bug introduced 2024-12-16 19:59 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Exception\IOException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
10			use SimpleSAML\Exception\SchemaViolationException;
			0 ignored issues – show Bug introduced 2022-08-19 17:59 UTC by Report Bug Copy Issue Report The type `SimpleSAML\Exception\SchemaViolationException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
11
12			use function array_unique;
13			use function defined;
14			use function file_exists;
15			use function implode;
16			use function sprintf;
17			use function trim;
18			use function libxml_get_errors;
19
20			/**
21			* trait class to be used by all the classes that implement the SchemaValidatableElementInterface
22			*
23			* @package simplesamlphp/xml-common
24			*/
25			trait SchemaValidatableElementTrait
26			{
27			/**
28			* Validate the given DOMDocument against the schema set for this element
29			*
30			* @return void
31			* @throws \SimpleSAML\XML\Exception\SchemaViolationException
32			*/
33			public static function schemaValidate(DOMDocument $document): DOMDocument
34			{
35			$schemaFile = self::getSchemaFile();
36			$result = $document->schemaValidate($schemaFile);
37
38			if ($result === false) {
39			$msgs = [];
40			foreach (libxml_get_errors() as $err) {
41			$msgs[] = trim($err->message) . ' on line ' . $err->line;
42			}
43
44			throw new SchemaViolationException(sprintf(
45			"XML schema validation errors:\n - %s",
46			implode("\n - ", array_unique($msgs)),
47			));
48			}
49
50			return $document;
			0 ignored issues – show Bug Best Practice introduced 2024-12-16 19:59 UTC by Report Bug Copy Issue Report The expression `return $document` returns the type `DOMDocument` which is incompatible with the documented return type `void`. Loading history...
51			}
52
53
54			/**
55			* Get the schema file that can validate this element.
56			*
57			* @return string
58			*/
59			public static function getSchemaFile(): string
60			{
61			if (defined('static::SCHEMA')) {
62			$schemaFile = static::SCHEMA;
			1 ignored issue – show Bug introduced 2024-12-16 19:59 UTC by Report Bug Copy Issue Report The constant `SimpleSAML\XML\SchemaVal...bleElementTrait::SCHEMA` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
63			}
64
65			Assert::true(file_exists($schemaFile), IOException::class);
			0 ignored issues – show Comprehensibility Best Practice introduced 2024-12-16 19:59 UTC by Report Bug Copy Issue Report The variable `$schemaFile` does not seem to be defined for all execution paths leading up to this point. Loading history...
66			return $schemaFile;
67			}
68			}
69

simplesamlphp / xml-common

Pull Request — master (#50)

SchemaValidatableElementTrait::getSchemaFile() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like