HippoPHP/Hippo

<?php

/*
 * This file is part of Hippo.
 *
 * (c) James Brooks <james@alt-three.com>
 * (c) Marcin Kurczewski <rr-@sakuya.pl>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace HippoPHP\Hippo\Reporters;

use HippoPHP\Hippo\CheckResult;
use HippoPHP\Hippo\File;
use HippoPHP\Hippo\FileSystem;
use XMLWriter;

/**
 * Checkstyle Reporter.
 *
 * @author James Brooks <jbrooksuk@me.com>
 */
class CheckstyleReporter implements ReporterInterface
{
    /**
     * XML Writer.
     *
     * @var \XMLWriter
     */
    protected $writer;

    /**
     * @var string
     */
    protected $filename;

    /**
     * @var FileSystem
     */
    protected $fileSystem;

    /**
     * Creates a new writer object, ready to write XML.
     *
     * @param FileSystem $fileSystem
     */
    public function __construct(FileSystem $fileSystem)
    {
        $this->fileSystem = $fileSystem;
    }

    /**
     * @param string $filename
     */
    public function setFilename($fileName)
    {
        $this->filename = $fileName;
    }

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::start()
     */
    public function start()
    {
        $this->writer = new XMLWriter();
        $this->writer->openMemory();
        $this->writer->setIndent(true);
        $this->writer->setIndentString('    ');

        $this->writer->startDocument('1.0', 'UTF-8');
        $this->writer->startElement('checkstyle');
        $this->writer->writeAttribute('version', '5.5');
    }

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::addCheckResults()
     *
     * @param File          $file
     * @param CheckResult[] $checkResults
     */
    public function addCheckResults(File $file, array $checkResults)
    {
        $this->writer->startElement('file');
        $this->writer->writeAttribute('name', $file->getFilename());

        foreach ($checkResults as $checkResult) {
            foreach ($checkResult->getViolations() as $violation) {
                $this->writer->startElement('error');

                $this->writer->writeAttribute('line', $violation->getLine());

                if ($violation->getColumn() > 0) {
                    $this->writer->writeAttribute('column', $violation->getColumn());
                }

                $this->writer->writeAttribute('severity', $violation->getSeverity());
                $this->writer->writeAttribute('message', $violation->getMessage());

                $this->writer->endElement();
            }
        }

        $this->writer->endElement();
    }

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::finish()
     */
    public function finish()
    {
        $this->writer->endElement();
        $this->writer->endDocument();

        $this->fileSystem->putContent($this->filename, $this->writer->outputMemory());
    }
}