deblan/php-censor
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Merge pull request #159 from Dave13h/Plugin-DocBlockChecker-detailed-errors

Browse source 
PHPDocBlockChecker Plugin Detailed Error Logging
This commit is contained in:
Dmitry Khomutov 2018-02-27 08:08:12 +07:00 committed by GitHub
parent a32fe9c291 17d9917096
commit be68f11aed
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 37 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

43
src/PHPCensor/Plugin/PhpDocblockChecker.php
View file

@ -149,17 +149,48 @@ class PhpDocblockChecker extends Plugin implements ZeroConfigPluginInterface
/**
* Report all of the errors we've encountered line-by-line.
* @param $output
* @param array $output
*/
protected function reportErrors($output)
{
foreach ($output as $error) {
$message = 'Class ' . $error['class'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_LOW;
switch ($error['type']) {
case 'class':
$message = 'Class ' . $error['class'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
break;
if ($error['type'] == 'method') {
$message = $error['class'] . '::' . $error['method'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
case 'method':
$message = $error['class'] . '::' . $error['method'] . ' is missing a docblock.';
$severity = BuildError::SEVERITY_NORMAL;
break;
case 'param-missing':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] . ' missing.';
$severity = BuildError::SEVERITY_LOW;
break;
case 'param-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @param ' . $error['param'] .
'(' . $error['doc-type'] . ') does not match method signature (' . $error['param-type'] . ')';
$severity = BuildError::SEVERITY_LOW;
break;
case 'return-missing':
$message = $error['class'] . '::' . $error['method'] . ' @return missing.';
$severity = BuildError::SEVERITY_LOW;
break;
case 'return-mismatch':
$message = $error['class'] . '::' . $error['method'] . ' @return ' . $error['doc-type'] .
' does not match method signature (' . $error['return-type'] . ')';
$severity = BuildError::SEVERITY_LOW;
break;
default:
$message = 'Class ' . $error['class'] . ' invalid/missing a docblock.';
$severity = BuildError::SEVERITY_LOW;
break;
}
$this->build->reportError(