-
Notifications
You must be signed in to change notification settings - Fork 159
/
Copy pathDirectThrowSniff.php
56 lines (51 loc) · 1.34 KB
/
DirectThrowSniff.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento2\Sniffs\Exceptions;
use PHP_CodeSniffer\Sniffs\Sniff;
use PHP_CodeSniffer\Files\File;
/**
* Detects possible direct throws of Exceptions.
*/
class DirectThrowSniff implements Sniff
{
/**
* String representation of warning.
* phpcs:disable Generic.Files.LineLength.TooLong
* @var string
*/
protected $warningMessage = 'Direct throw of generic Exception is discouraged. Use context specific instead.';
//phpcs:enable
/**
* Warning violation code.
*
* @var string
*/
protected $warningCode = 'FoundDirectThrow';
/**
* @inheritdoc
*/
public function register()
{
return [T_THROW];
}
/**
* @inheritdoc
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
$endOfStatement = $phpcsFile->findEndOfStatement($stackPtr);
$posOfException = $phpcsFile->findNext(T_STRING, $stackPtr, $endOfStatement);
if ($tokens[$posOfException]['content'] === 'Exception') {
$phpcsFile->addWarning(
$this->warningMessage,
$stackPtr,
$this->warningCode,
[$posOfException]
);
}
}
}