mirror of
https://github.com/danog/psalm.git
synced 2024-12-11 00:39:38 +01:00
88 lines
2.6 KiB
PHP
88 lines
2.6 KiB
PHP
<?php
|
|
namespace Psalm;
|
|
|
|
abstract class Report
|
|
{
|
|
const TYPE_COMPACT = 'compact';
|
|
const TYPE_CONSOLE = 'console';
|
|
const TYPE_PYLINT = 'pylint';
|
|
const TYPE_JSON = 'json';
|
|
const TYPE_JSON_SUMMARY = 'json-summary';
|
|
const TYPE_EMACS = 'emacs';
|
|
const TYPE_XML = 'xml';
|
|
const TYPE_CHECKSTYLE = 'checkstyle';
|
|
const TYPE_TEXT = 'text';
|
|
|
|
const SUPPORTED_OUTPUT_TYPES = [
|
|
self::TYPE_COMPACT,
|
|
self::TYPE_CONSOLE,
|
|
self::TYPE_PYLINT,
|
|
self::TYPE_JSON,
|
|
self::TYPE_JSON_SUMMARY,
|
|
self::TYPE_EMACS,
|
|
self::TYPE_XML,
|
|
self::TYPE_CHECKSTYLE,
|
|
self::TYPE_TEXT,
|
|
];
|
|
|
|
/**
|
|
* @var array<int, array{severity: string, line_from: int, line_to: int, type: string, message: string,
|
|
* file_name: string, file_path: string, snippet: string, from: int, to: int,
|
|
* snippet_from: int, snippet_to: int, column_from: int, column_to: int, selected_text: string}>
|
|
*/
|
|
protected $issues_data;
|
|
|
|
/** @var bool */
|
|
protected $use_color;
|
|
|
|
/** @var bool */
|
|
protected $show_snippet;
|
|
|
|
/** @var bool */
|
|
protected $show_info;
|
|
|
|
/** @var int */
|
|
protected $mixed_expression_count;
|
|
|
|
/** @var int */
|
|
protected $total_expression_count;
|
|
|
|
/**
|
|
* @param array<int, array{severity: string, line_from: int, line_to: int, type: string, message: string,
|
|
* file_name: string, file_path: string, snippet: string, from: int, to: int,
|
|
* snippet_from: int, snippet_to: int, column_from: int, column_to: int, selected_text: string}> $issues_data
|
|
* @param bool $use_color
|
|
* @param bool $show_snippet
|
|
* @param bool $show_info
|
|
*/
|
|
public function __construct(
|
|
array $issues_data,
|
|
Report\ReportOptions $report_options,
|
|
int $mixed_expression_count = 1,
|
|
int $total_expression_count = 1
|
|
) {
|
|
if (!$report_options->show_info) {
|
|
$this->issues_data = array_filter(
|
|
$issues_data,
|
|
function (array $issue_data) : bool {
|
|
return $issue_data['severity'] !== Config::REPORT_INFO;
|
|
}
|
|
);
|
|
} else {
|
|
$this->issues_data = $issues_data;
|
|
}
|
|
|
|
$this->use_color = $report_options->use_color;
|
|
$this->show_snippet = $report_options->show_snippet;
|
|
$this->show_info = $report_options->show_info;
|
|
|
|
$this->mixed_expression_count = $mixed_expression_count;
|
|
$this->total_expression_count = $total_expression_count;
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
abstract public function create(): string;
|
|
}
|