class Xml
Same name in this branch
- 11.1.x vendor/phpunit/phpunit/src/TextUI/Configuration/Xml/CodeCoverage/Report/Xml.php \PHPUnit\TextUI\XmlConfiguration\CodeCoverage\Report\Xml
- 11.1.x vendor/phpunit/phpunit/src/Util/Xml/Xml.php \PHPUnit\Util\Xml
Hierarchy
- class \PHP_CodeSniffer\Reports\Xml implements \PHP_CodeSniffer\Reports\Report
Expanded class hierarchy of Xml
20 string references to 'Xml'
- AbstractObjectNormalizer::validateAndDenormalize in vendor/
symfony/ serializer/ Normalizer/ AbstractObjectNormalizer.php - Validates the submitted data and denormalizes it.
- AbstractObjectNormalizer::validateAndDenormalizeLegacy in vendor/
symfony/ serializer/ Normalizer/ AbstractObjectNormalizer.php - Validates the submitted data and denormalizes it.
- bootstrap.php in vendor/
symfony/ polyfill-iconv/ bootstrap.php - bootstrap80.php in vendor/
symfony/ polyfill-iconv/ bootstrap80.php - CodeBlock::defaultConfiguration in core/
modules/ ckeditor5/ src/ Plugin/ CKEditor5Plugin/ CodeBlock.php
File
-
vendor/
squizlabs/ php_codesniffer/ src/ Reports/ Xml.php, line 16
Namespace
PHP_CodeSniffer\ReportsView source
class Xml implements Report {
/**
* 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.
*
* @param array<string, string|int|array> $report Prepared report data.
* See the {@see Report} interface for a detailed specification.
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being reported on.
* @param bool $showSources Show sources?
* @param int $width Maximum allowed line width.
*
* @return bool
*/
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;
}
//end generateFileReport()
/**
* Prints all violations for processed files, in a proprietary XML format.
*
* @param string $cachedData Any partial report data that was returned from
* generateFileReport during the run.
* @param int $totalFiles Total number of files processed during the run.
* @param int $totalErrors Total number of errors found during the run.
* @param int $totalWarnings Total number of warnings found during the run.
* @param int $totalFixable Total number of problems that can be fixed.
* @param bool $showSources Show sources?
* @param int $width Maximum allowed line width.
* @param bool $interactive Are we running in interactive mode?
* @param bool $toScreen Is the report being printed to screen?
*
* @return void
*/
public function generate($cachedData, $totalFiles, $totalErrors, $totalWarnings, $totalFixable, $showSources = false, $width = 80, $interactive = false, $toScreen = true) {
echo '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL;
echo '<phpcs version="' . Config::VERSION . '">' . PHP_EOL;
echo $cachedData;
echo '</phpcs>' . PHP_EOL;
}
//end generate()
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
Xml::generate | public | function | Prints all violations for processed files, in a proprietary XML format. | Overrides Report::generate |
Xml::generateFileReport | public | function | Generate a partial report for a single processed file. | Overrides Report::generateFileReport |