Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7414967
NestingLevelSniff.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
2 KB
Referenced Files
None
Subscribers
None
NestingLevelSniff.php
View Options
<?php
/**
* Checks the nesting level for methods.
*
* @author Johann-Peter Hartmann <hartmann@mayflower.de>
* @author Greg Sherwood <gsherwood@squiz.net>
* @copyright 2007-2014 Mayflower GmbH
* @license https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/licence.txt BSD Licence
*/
namespace
PHP_CodeSniffer\Standards\Generic\Sniffs\Metrics
;
use
PHP_CodeSniffer\Files\File
;
use
PHP_CodeSniffer\Sniffs\Sniff
;
class
NestingLevelSniff
implements
Sniff
{
/**
* A nesting level higher than this value will throw a warning.
*
* @var integer
*/
public
$nestingLevel
=
5
;
/**
* A nesting level higher than this value will throw an error.
*
* @var integer
*/
public
$absoluteNestingLevel
=
10
;
/**
* Returns an array of tokens this test wants to listen for.
*
* @return array<int|string>
*/
public
function
register
()
{
return
[
T_FUNCTION
];
}
//end register()
/**
* Processes this test, when one of its tokens is encountered.
*
* @param \PHP_CodeSniffer\Files\File $phpcsFile The file being scanned.
* @param int $stackPtr The position of the current token
* in the stack passed in $tokens.
*
* @return void
*/
public
function
process
(
File
$phpcsFile
,
$stackPtr
)
{
$tokens
=
$phpcsFile
->
getTokens
();
// Ignore abstract methods.
if
(
isset
(
$tokens
[
$stackPtr
][
'scope_opener'
])
===
false
)
{
return
;
}
// Detect start and end of this function definition.
$start
=
$tokens
[
$stackPtr
][
'scope_opener'
];
$end
=
$tokens
[
$stackPtr
][
'scope_closer'
];
$nestingLevel
=
0
;
// Find the maximum nesting level of any token in the function.
for
(
$i
=
(
$start
+
1
);
$i
<
$end
;
$i
++)
{
$level
=
$tokens
[
$i
][
'level'
];
if
(
$nestingLevel
<
$level
)
{
$nestingLevel
=
$level
;
}
}
// We subtract the nesting level of the function itself.
$nestingLevel
=
(
$nestingLevel
-
$tokens
[
$stackPtr
][
'level'
]
-
1
);
if
(
$nestingLevel
>
$this
->
absoluteNestingLevel
)
{
$error
=
'Function
\'
s nesting level (%s) exceeds allowed maximum of %s'
;
$data
=
[
$nestingLevel
,
$this
->
absoluteNestingLevel
,
];
$phpcsFile
->
addError
(
$error
,
$stackPtr
,
'MaxExceeded'
,
$data
);
}
else
if
(
$nestingLevel
>
$this
->
nestingLevel
)
{
$warning
=
'Function
\'
s nesting level (%s) exceeds %s; consider refactoring the function'
;
$data
=
[
$nestingLevel
,
$this
->
nestingLevel
,
];
$phpcsFile
->
addWarning
(
$warning
,
$stackPtr
,
'TooHigh'
,
$data
);
}
}
//end process()
}
//end class
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 01:55 (1 d, 13 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
ea/6a/2ecf71d3461b81db71ec60c9a438
Default Alt Text
NestingLevelSniff.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment