1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Issue/CodeIssue.php
2020-03-20 14:41:25 -04:00

129 lines
2.9 KiB
PHP

<?php
namespace Psalm\Issue;
use Psalm\CodeLocation;
use Psalm\Config;
use function explode;
use function get_called_class;
use function array_pop;
abstract class CodeIssue
{
const ERROR_LEVEL = -1;
const SHORTCODE = 0;
/**
* @var CodeLocation
*/
protected $code_location;
/**
* @var string
*/
protected $message;
/**
* @param string $message
* @param CodeLocation $code_location
*/
public function __construct(
$message,
CodeLocation $code_location
) {
$this->code_location = $code_location;
$this->message = $message;
}
/**
* @return CodeLocation
*/
public function getLocation()
{
return $this->code_location;
}
/**
* @return string
*/
public function getShortLocationWithPrevious()
{
$previous_text = '';
if ($this->code_location->previous_location) {
$previous_location = $this->code_location->previous_location;
$previous_text = ' from ' . $previous_location->file_name . ':' . $previous_location->getLineNumber();
}
return $this->code_location->file_name . ':' . $this->code_location->getLineNumber() . $previous_text;
}
/**
* @return string
*/
public function getShortLocation()
{
return $this->code_location->file_name . ':' . $this->code_location->getLineNumber();
}
/**
* @return string
*/
public function getFilePath()
{
return $this->code_location->file_path;
}
/**
* @return string
*
* @psalm-suppress PossiblyUnusedMethod for convenience
*/
public function getFileName()
{
return $this->code_location->file_name;
}
/**
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* @param string $severity
*
* @return \Psalm\Internal\Analyzer\IssueData
*/
public function toIssueData($severity = Config::REPORT_ERROR)
{
$location = $this->getLocation();
$selection_bounds = $location->getSelectionBounds();
$snippet_bounds = $location->getSnippetBounds();
$fqcn_parts = explode('\\', get_called_class());
$issue_type = array_pop($fqcn_parts);
return new \Psalm\Internal\Analyzer\IssueData(
$severity,
$location->getLineNumber(),
$location->getEndLineNumber(),
$issue_type,
$this->getMessage(),
$location->file_name,
$location->file_path,
$location->getSnippet(),
$location->getSelectedText(),
$selection_bounds[0],
$selection_bounds[1],
$snippet_bounds[0],
$snippet_bounds[1],
$location->getColumn(),
$location->getEndColumn(),
(int) static::SHORTCODE,
(int) static::ERROR_LEVEL
);
}
}