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\Violation;

/**
 * Array Reporter.
 *
 * @author James Brooks <jbrooksuk@me.com>
 */
class ArrayReporter implements ReporterInterface
{
    /**
     * Report array.
     *
     * @var array
     */
    protected $report = [];

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::start()
     */
    public function start()
    {
    }

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::addCheckResults()
     *
     * @param File        $file
     * @param CheckResult $checkResults
     */
    public function addCheckResults(File $file, array $checkResults)
    {
        foreach ($checkResults as $checkResult) {
            foreach ($checkResult->getViolations() as $violation) {
                $key = $this->getArrayKey($violation);
                if (!isset($this->report[$key])) {
                    $this->report[$key] = [];
                }

                $this->report[$key][] = [
                    'file'     => $file->getFilename(),
                    'line'     => $violation->getLine(),
                    'column'   => $violation->getColumn(),
                    'severity' => $violation->getSeverity(),
                    'message'  => $violation->getMessage(),
                ];
            }
        }
    }

    /**
     * Defined by ReportInterface.
     *
     * @see ReportInterface::finish()
     */
    public function finish()
    {
        return $this->report;
    }

    /**
     * Returns the reports array.
     *
     * @return array
     */
    public function getReport()
    {
        return $this->report;
    }

    /**
     * Generates a key for a violation.
     *
     * @param Violation $violation
     *
     * @return string
     */
    private function getArrayKey(Violation $violation)
    {
        return $violation->getFile()->getFilename().':'.$violation->getLine();
    }
}