Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7398742
RequireAnonClassParenthesesSniff.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
RequireAnonClassParenthesesSniff.php
View Options
<?php
/**
* PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
*
* @package PHPCSExtra
* @copyright 2020 PHPCSExtra Contributors
* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
* @link https://github.com/PHPCSStandards/PHPCSExtra
*/
namespace
PHPCSExtra\Universal\Sniffs\Classes
;
use
PHP_CodeSniffer\Files\File
;
use
PHP_CodeSniffer\Sniffs\Sniff
;
use
PHP_CodeSniffer\Util\Tokens
;
/**
* Require that an anonymous class declaration/instantiation has parentheses, i.e. `new class().
*
* @since 1.0.0
*/
final
class
RequireAnonClassParenthesesSniff
implements
Sniff
{
/**
* Name of the metric.
*
* @since 1.0.0
*
* @var string
*/
const
METRIC_NAME
=
'Anon class declaration with parenthesis'
;
/**
* Returns an array of tokens this test wants to listen for.
*
* @since 1.0.0
*
* @return array<int|string>
*/
public
function
register
()
{
return
[
\T_ANON_CLASS
];
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @since 1.0.0
*
* @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
();
$nextNonEmpty
=
$phpcsFile
->
findNext
(
Tokens
::
$emptyTokens
,
(
$stackPtr
+
1
),
null
,
true
);
// Note: no need to check for `false` as PHPCS won't retokenize `class` to `T_ANON_CLASS` in that case.
if
(
$tokens
[
$nextNonEmpty
][
'code'
]
===
\T_OPEN_PARENTHESIS
)
{
// Parentheses found.
$phpcsFile
->
recordMetric
(
$stackPtr
,
self
::
METRIC_NAME
,
'yes'
);
return
;
}
$phpcsFile
->
recordMetric
(
$stackPtr
,
self
::
METRIC_NAME
,
'no'
);
$fix
=
$phpcsFile
->
addFixableError
(
'Parenthesis required when creating a new anonymous class.'
,
$stackPtr
,
'Missing'
);
if
(
$fix
===
true
)
{
$phpcsFile
->
fixer
->
addContent
(
$stackPtr
,
'()'
);
}
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sat, Nov 21, 15:30 (3 h, 26 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
31/74/1fd913be5fca1c404813ba16cef0
Default Alt Text
RequireAnonClassParenthesesSniff.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment