Page Menu
Home
WickedGov Phorge
Search
Configure Global Search
Log In
Files
F7430395
NoUselessAliasesSniff.php
No One
Temporary
Actions
Download File
Edit File
Delete File
View Transforms
Subscribe
Flag For Later
Award Token
Size
5 KB
Referenced Files
None
Subscribers
None
NoUselessAliasesSniff.php
View Options
<?php
/**
* PHPCSExtra, a collection of sniffs and standards for use with PHP_CodeSniffer.
*
* @package PHPCSExtra
* @copyright 2023 PHPCSExtra Contributors
* @license https://opensource.org/licenses/LGPL-3.0 LGPL3
* @link https://github.com/PHPCSStandards/PHPCSExtra
*/
namespace
PHPCSExtra\Universal\Sniffs\UseStatements
;
use
PHP_CodeSniffer\Files\File
;
use
PHP_CodeSniffer\Sniffs\Sniff
;
use
PHP_CodeSniffer\Util\Tokens
;
use
PHPCSUtils\Utils\NamingConventions
;
use
PHPCSUtils\Utils\UseStatements
;
/**
* Detects useless aliases for import use statements.
*
* Aliasing something to the same name as the original construct is considered useless.
* Note: as OO and function names in PHP are case-insensitive, aliasing to the same name,
* using a different case is also considered useless.
*
* @since 1.1.0
*/
final
class
NoUselessAliasesSniff
implements
Sniff
{
/**
* Returns an array of tokens this test wants to listen for.
*
* @since 1.1.0
*
* @return array<int|string>
*/
public
function
register
()
{
return
[
\T_USE
];
}
/**
* Processes this test, when one of its tokens is encountered.
*
* @since 1.1.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
)
{
if
(
UseStatements
::
isImportUse
(
$phpcsFile
,
$stackPtr
)
===
false
)
{
// Closure or trait use statement. Bow out.
return
;
}
$endOfStatement
=
$phpcsFile
->
findNext
([
\T_SEMICOLON
,
\T_CLOSE_TAG
],
(
$stackPtr
+
1
));
if
(
$endOfStatement
===
false
)
{
// Parse error or live coding.
return
;
}
$hasAliases
=
$phpcsFile
->
findNext
(
\T_AS
,
(
$stackPtr
+
1
),
$endOfStatement
);
if
(
$hasAliases
===
false
)
{
// This use import statement does not alias anything, bow out.
return
;
}
$useStatements
=
UseStatements
::
splitImportUseStatement
(
$phpcsFile
,
$stackPtr
);
if
(
\count
(
$useStatements
,
\COUNT_RECURSIVE
)
<=
3
)
{
// No statements found. Shouldn't be possible, but still. Bow out.
return
;
}
$tokens
=
$phpcsFile
->
getTokens
();
// Collect all places where aliases are used in this use statement.
$aliasPtrs
=
[];
$currentAs
=
$hasAliases
;
do
{
$aliasPtr
=
$phpcsFile
->
findNext
(
Tokens
::
$emptyTokens
,
(
$currentAs
+
1
),
null
,
true
);
if
(
$aliasPtr
!==
false
&&
$tokens
[
$aliasPtr
][
'code'
]
===
\T_STRING
)
{
$aliasPtrs
[
$currentAs
]
=
$aliasPtr
;
}
$currentAs
=
$phpcsFile
->
findNext
(
\T_AS
,
(
$currentAs
+
1
),
$endOfStatement
);
}
while
(
$currentAs
!==
false
);
// Now check the names in each use statement for useless aliases.
foreach
(
$useStatements
as
$type
=>
$statements
)
{
foreach
(
$statements
as
$alias
=>
$fqName
)
{
$unqualifiedName
=
\ltrim
(
\substr
(
$fqName
,
\strrpos
(
$fqName
,
'
\\
'
)),
'
\\
'
);
$uselessAlias
=
false
;
if
(
$type
===
'const'
)
{
// Do a case-sensitive comparison for constants.
if
(
$unqualifiedName
===
$alias
)
{
$uselessAlias
=
true
;
}
}
elseif
(
NamingConventions
::
isEqual
(
$unqualifiedName
,
$alias
))
{
$uselessAlias
=
true
;
}
if
(
$uselessAlias
===
false
)
{
continue
;
}
// Now check if this is actually used as an alias or just the actual name.
foreach
(
$aliasPtrs
as
$asPtr
=>
$aliasPtr
)
{
if
(
$tokens
[
$aliasPtr
][
'content'
]
!==
$alias
)
{
continue
;
}
// Make sure this is really the right one.
$prev
=
$phpcsFile
->
findPrevious
(
Tokens
::
$emptyTokens
,
(
$asPtr
-
1
),
null
,
true
);
if
(
$tokens
[
$prev
][
'code'
]
!==
\T_STRING
||
$tokens
[
$prev
][
'content'
]
!==
$unqualifiedName
)
{
continue
;
}
$error
=
'Useless alias "%s" found for import of "%s"'
;
$code
=
'Found'
;
$data
=
[
$alias
,
$fqName
];
// Okay, so this is the one which should be flagged.
$hasComments
=
$phpcsFile
->
findNext
(
Tokens
::
$commentTokens
,
(
$prev
+
1
),
$aliasPtr
);
if
(
$hasComments
!==
false
)
{
// Don't auto-fix if there are comments.
$phpcsFile
->
addError
(
$error
,
$aliasPtr
,
$code
,
$data
);
break
;
}
$fix
=
$phpcsFile
->
addFixableError
(
$error
,
$aliasPtr
,
$code
,
$data
);
if
(
$fix
===
true
)
{
$phpcsFile
->
fixer
->
beginChangeset
();
for
(
$i
=
(
$prev
+
1
);
$i
<=
$aliasPtr
;
$i
++)
{
$phpcsFile
->
fixer
->
replaceToken
(
$i
,
''
);
}
$phpcsFile
->
fixer
->
endChangeset
();
}
break
;
}
}
}
}
}
File Metadata
Details
Attached
Mime Type
text/x-php
Expires
Sun, Nov 22, 10:27 (9 h, 56 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
e5/df/673a331fdde6a3125f022226130b
Default Alt Text
NoUselessAliasesSniff.php (5 KB)
Attached To
Mode
rMWPROD MediaWiki Production
Attached
Detach File
Event Timeline
Log In to Comment