function Xml::generateFileReport

Generate a partial report for a single processed file.

Function should return TRUE if it printed or stored data about the file and FALSE if it ignored the file. Returning TRUE indicates that the file and its data should be counted in the grand totals.

Parameters

array<string, string|int|array> $report Prepared report data.: See the {@see Report} interface for a detailed specification.

\PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.:

bool $showSources Show sources?:

int $width Maximum allowed line width.:

Return value

bool

Overrides Report::generateFileReport

File

vendor/squizlabs/php_codesniffer/src/Reports/Xml.php, line 35

Class

Xml

Namespace

PHP_CodeSniffer\Reports

Code

public function generateFileReport($report, File $phpcsFile, $showSources = false, $width = 80) {
    $out = new XMLWriter();
    $out->openMemory();
    $out->setIndent(true);
    $out->setIndentString('    ');
    $out->startDocument('1.0', 'UTF-8');
    if ($report['errors'] === 0 && $report['warnings'] === 0) {
        // Nothing to print.
        return false;
    }
    $out->startElement('file');
    $out->writeAttribute('name', $report['filename']);
    $out->writeAttribute('errors', $report['errors']);
    $out->writeAttribute('warnings', $report['warnings']);
    $out->writeAttribute('fixable', $report['fixable']);
    foreach ($report['messages'] as $line => $lineErrors) {
        foreach ($lineErrors as $column => $colErrors) {
            foreach ($colErrors as $error) {
                $error['type'] = strtolower($error['type']);
                if ($phpcsFile->config->encoding !== 'utf-8') {
                    $error['message'] = iconv($phpcsFile->config->encoding, 'utf-8', $error['message']);
                }
                $out->startElement($error['type']);
                $out->writeAttribute('line', $line);
                $out->writeAttribute('column', $column);
                $out->writeAttribute('source', $error['source']);
                $out->writeAttribute('severity', $error['severity']);
                $out->writeAttribute('fixable', (int) $error['fixable']);
                $out->text($error['message']);
                $out->endElement();
            }
        }
    }
    
    //end foreach
    $out->endElement();
    // Remove the start of the document because we will
    // add that manually later. We only have it in here to
    // properly set the encoding.
    $content = $out->flush();
    if (strpos($content, PHP_EOL) !== false) {
        $content = substr($content, strpos($content, PHP_EOL) + strlen(PHP_EOL));
    }
    else {
        if (strpos($content, "\n") !== false) {
            $content = substr($content, strpos($content, "\n") + 1);
        }
    }
    echo $content;
    return true;
}