makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-07 20:08:53 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/17512] Add PHP Sniffer coding standard for union types

Browse source 
PHPBB-17512
This commit is contained in:
rxu 2025-05-15 11:47:47 +07:00
parent 61bede748a
commit b3ff1d7e34
No known key found for this signature in database
GPG key ID: 8117904FEDEFDD17
2 changed files with 100 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
build/code_sniffer/phpbb/Sniffs/CodeLayout/UnionTypesCheckSniff.php Normal file
View file

@ -0,0 +1,96 @@
<?php
/**
*
* This file is part of the phpBB Forum Software package.
*
* @copyright (c) phpBB Limited <https://www.phpbb.com>
* @license GNU General Public License, version 2 (GPL-2.0)
*
* For full copyright and license information, please see
* the docs/CREDITS.txt file.
*
*/
namespace phpbb\Sniffs\CodeLayout;
use PHP_CodeSniffer\Files\File;
use PHP_CodeSniffer\Sniffs\Sniff;
/**
* Checks that union type declarations follows the coding guidelines.
*/
class UnionTypesCheckSniff implements Sniff
{
/**
* {@inheritdoc}
*/
public function register()
{
return [
T_TYPE_UNION,
T_NULLABLE,
];
}
/**
* {@inheritdoc}
*/
public function process(File $phpcsFile, $stackPtr)
{
$tokens = $phpcsFile->getTokens();
// Check if nullable type shortcut syntax ('?typehint') is used
if ($tokens[$stackPtr]['type'] === 'T_NULLABLE')
{
$type = $tokens[$stackPtr + 1]['content'];
$error = 'Nullable shortcut syntax must not be used. Use union type instead: %2$s|null; found %1$s%2$s';
$data = [trim($tokens[$stackPtr]['content']), $type];
$phpcsFile->addError($error, $stackPtr, 'ShortNullableSyntax', $data);
}
// Get the entry before the 1st '|' and all entries after it untill the end of union type declaration
if ($tokens[$stackPtr]['type'] === 'T_TYPE_UNION' && $tokens[$stackPtr - 2]['type'] !== 'T_TYPE_UNION')
{
// Get all the types within the union type declaration
$types_array = [];
for ($i = $stackPtr - 2; $i++;)
{
if (in_array($tokens[$i]['type'], ['T_TYPE_UNION', 'T_STRING', 'T_NULL']))
{
if ($tokens[$i]['type'] != 'T_TYPE_UNION')
{
$types_array[] = $tokens[$i]['content'];
}
}
else
{
break;
}
}
$types_array_sorted = $types_array_null_less = $types_array;
// Check 'null' to be the last element
$null_position = array_search('null', $types_array);
if ($null_position !== false && $null_position != array_key_last($types_array))
{
$error = 'The "null" type hint must be the last of the union type elements; found %s';
$data = [implode('|', $types_array)];
$phpcsFile->addError($error, $stackPtr, 'NullAlwaysLast', $data);
}
// Check types excepting 'null' to follow alphabetical order
if ($null_position !== false)
{
array_splice($types_array_null_less, $null_position, 1);
}
sort($types_array_sorted);
if (!empty(array_diff_assoc($types_array_null_less, $types_array_sorted)))
{
$error = 'Union type elements must be sorted alphabetically excepting the "null" type hint must be the last if any; found %s';
$data = [implode('|', $types_array)];
$phpcsFile->addError($error, $stackPtr, 'AlphabeticalSort', $data);
}
}
}
}

4
build/code_sniffer/ruleset-php-strict.xml
View file

@ -45,4 +45,8 @@
<!-- There MUST NOT be unused use statements. --> <!-- There MUST NOT be unused use statements. -->
<rule ref="./phpbb/Sniffs/Namespaces/UnusedUseSniff.php" /> <rule ref="./phpbb/Sniffs/Namespaces/UnusedUseSniff.php" />
<!-- The null type SHALL be the last union type element, other types SHALL follow alphabetical order.
No nullable type shortcut syntax should be used. -->
<rule ref="./phpbb/Sniffs/CodeLayout/UnionTypesCheckSniff.php" />
</ruleset> </ruleset>