CheckstyleReporter.php

<?php

declare(strict_types=1);

namespace DocbookCS\Report\Reporter;

use DocbookCS\RelativePath;
use DocbookCS\Report\Report;

final class CheckstyleReporter implements ReporterInterface
{
    public function generate(Report $report): string
    {
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->formatOutput = true;

        $root = $dom->createElement('checkstyle');
        $root->setAttribute('version', '3.0');
        $dom->appendChild($root);

        $comment = $dom->createComment(
            sprintf(' total runtime: %.3fs ', $report->getTotalTime())
        );
        $root->appendChild($comment);

        foreach ($report->getFileReports() as $fileReport) {
            if (!$fileReport->hasViolations()) {
                continue;
            }

            $fileNode = $dom->createElement('file');
            $fileNode->setAttribute('name', RelativePath::fromWorkingDirectory($fileReport->filePath));

            foreach ($fileReport->getViolations() as $violation) {
                $errorNode = $dom->createElement('error');
                $errorNode->setAttribute('line', (string) $violation->line);
                $errorNode->setAttribute('severity', $violation->severity->value);
                $errorNode->setAttribute('message', $violation->message);
                $errorNode->setAttribute('source', $violation->sniffCode);
                $fileNode->appendChild($errorNode);
            }

            $root->appendChild($fileNode);
        }

        return $dom->saveXML() ?: '';
    }
}