Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7421107
RequireFinalClassSniff.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
RequireFinalClassSniff.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
;
use
PHPCSUtils\Utils\GetTokensAsString
;
use
PHPCSUtils\Utils\ObjectDeclarations
;
/**
* Require classes being declared as "final".
*
* @since 1.0.0
*/
final
class
RequireFinalClassSniff
implements
Sniff
{
/**
* Name of the metric.
*
* @since 1.0.0
*
* @var string
*/
const
METRIC_NAME
=
'Class is abstract or final ?'
;
/**
* Returns an array of tokens this test wants to listen for.
*
* @since 1.0.0
*
* @return array<int|string>
*/
public
function
register
()
{
return
[
\T_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
)
{
$classProp
=
ObjectDeclarations
::
getClassProperties
(
$phpcsFile
,
$stackPtr
);
if
(
$classProp
[
'is_final'
]
===
true
)
{
$phpcsFile
->
recordMetric
(
$stackPtr
,
self
::
METRIC_NAME
,
'final'
);
return
;
}
if
(
$classProp
[
'is_abstract'
]
===
true
)
{
// Abstract classes can't be final.
$phpcsFile
->
recordMetric
(
$stackPtr
,
self
::
METRIC_NAME
,
'abstract'
);
return
;
}
$phpcsFile
->
recordMetric
(
$stackPtr
,
self
::
METRIC_NAME
,
'not abstract, not final'
);
$nextNonEmpty
=
$phpcsFile
->
findNext
(
Tokens
::
$emptyTokens
,
(
$stackPtr
+
1
),
null
,
true
);
if
(
$nextNonEmpty
===
false
)
{
// Live coding or parse error.
return
;
}
$snippetEnd
=
$nextNonEmpty
;
$classCloser
=
''
;
$tokens
=
$phpcsFile
->
getTokens
();
if
(
isset
(
$tokens
[
$stackPtr
][
'scope_opener'
])
===
true
)
{
$snippetEnd
=
$tokens
[
$stackPtr
][
'scope_opener'
];
$classCloser
=
'}'
;
}
$snippet
=
GetTokensAsString
::
compact
(
$phpcsFile
,
$stackPtr
,
$snippetEnd
,
true
);
$fix
=
$phpcsFile
->
addFixableError
(
'A non-abstract class should be declared as final. Found: %s%s'
,
$stackPtr
,
'NonFinalClassFound'
,
[
$snippet
,
$classCloser
]
);
if
(
$fix
===
true
)
{
$phpcsFile
->
fixer
->
addContentBefore
(
$stackPtr
,
'final '
);
}
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 05:17 (1 d, 2 h)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e2/33/bddfc396e32f02be78dee2f3528b
Default Alt Text
RequireFinalClassSniff.php (2 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment