SimpleSAML\XML\SchemaValidatableElementTrait

Complexity

Total Complexity

5

Size/Duplication

Total Lines	42
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	schemaValidate()	0	18	3
A	getSchemaFile()	0	8	2

<?php

declare(strict_types=1);

namespace SimpleSAML\XML;

use DOMDocument;
use SimpleSAML\Assert\Assert;
use SimpleSAML\Exception\IOException;

The type SimpleSAML\Exception\IOException was not found. Maybe you did not declare it correctly or list all dependencies?

use SimpleSAML\Exception\SchemaViolationException;

The type SimpleSAML\Exception\SchemaViolationException was not found. Maybe you did not declare it correctly or list all dependencies?

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;

The expression return $document returns the type DOMDocument which is incompatible with the documented return type void.

    }


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

The constant SimpleSAML\XML\SchemaValidatableElementTrait::SCHEMA was not found. Maybe you did not declare it correctly or list all dependencies?

        }

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

The variable $schemaFile does not seem to be defined for all execution paths leading up to this point.

        return $schemaFile;
    }
}