Preview: RequireMultiLineCallSniff.php
Size: 7.53 KB
/opt/cpanel/ea-wappspector/vendor/slevomat/coding-standard/SlevomatCodingStandard/Sniffs/Functions/RequireMultiLineCallSniff.php
<?php declare(strict_types = 1);
namespace SlevomatCodingStandard\Sniffs\Functions;
use PHP_CodeSniffer\Files\File;
use SlevomatCodingStandard\Helpers\FixerHelper;
use SlevomatCodingStandard\Helpers\IndentationHelper;
use SlevomatCodingStandard\Helpers\SniffSettingsHelper;
use SlevomatCodingStandard\Helpers\TokenHelper;
use function array_unique;
use function count;
use function in_array;
use function ltrim;
use function sprintf;
use function strlen;
use function trim;
use const T_CLOSE_PARENTHESIS;
use const T_CLOSE_SHORT_ARRAY;
use const T_COMMA;
use const T_DOUBLE_COLON;
use const T_NEW;
use const T_OBJECT_OPERATOR;
use const T_OPEN_PARENTHESIS;
use const T_OPEN_SHORT_ARRAY;
class RequireMultiLineCallSniff extends AbstractLineCall
{
public const CODE_REQUIRED_MULTI_LINE_CALL = 'RequiredMultiLineCall';
public int $minLineLength = 121;
/**
* @phpcsSuppress SlevomatCodingStandard.TypeHints.ParameterTypeHint.MissingNativeTypeHint
* @param int $stringPointer
*/
public function process(File $phpcsFile, $stringPointer): void
{
$this->minLineLength = SniffSettingsHelper::normalizeInteger($this->minLineLength);
if (!$this->isCall($phpcsFile, $stringPointer)) {
return;
}
$tokens = $phpcsFile->getTokens();
$parenthesisOpenerPointer = TokenHelper::findNextEffective($phpcsFile, $stringPointer + 1);
$parenthesisCloserPointer = $tokens[$parenthesisOpenerPointer]['parenthesis_closer'];
// No parameters
$effectivePointerAfterParenthesisOpener = TokenHelper::findNextEffective($phpcsFile, $parenthesisOpenerPointer + 1);
if ($effectivePointerAfterParenthesisOpener === $parenthesisCloserPointer) {
return;
}
$parametersPointers = [TokenHelper::findNextEffective($phpcsFile, $parenthesisOpenerPointer + 1)];
$level = 0;
$pointers = TokenHelper::findNextAll(
$phpcsFile,
[T_COMMA, T_OPEN_PARENTHESIS, T_CLOSE_PARENTHESIS, T_OPEN_SHORT_ARRAY, T_CLOSE_SHORT_ARRAY],
$parenthesisOpenerPointer + 1,
$parenthesisCloserPointer,
);
foreach ($pointers as $pointer) {
if (in_array($tokens[$pointer]['code'], [T_OPEN_PARENTHESIS, T_OPEN_SHORT_ARRAY], true)) {
$level++;
continue;
}
if (in_array($tokens[$pointer]['code'], [T_CLOSE_PARENTHESIS, T_CLOSE_SHORT_ARRAY], true)) {
$level--;
continue;
}
if ($level !== 0) {
continue;
}
$parameterPointer = TokenHelper::findNextEffective($phpcsFile, $pointer + 1, $parenthesisCloserPointer);
if ($parameterPointer !== null) {
$parametersPointers[] = $parameterPointer;
}
}
$lines = [
$tokens[$parenthesisOpenerPointer]['line'],
$tokens[$parenthesisCloserPointer]['line'],
];
foreach ($parametersPointers as $parameterPointer) {
$lines[] = $tokens[$parameterPointer]['line'];
}
// Each parameter on its line
if (count(array_unique($lines)) - 2 >= count($parametersPointers)) {
return;
}
if ($this->shouldBeSkipped($phpcsFile, $stringPointer, $parenthesisCloserPointer)) {
return;
}
$lineStart = $this->getLineStart($phpcsFile, $parenthesisOpenerPointer);
if ($tokens[$parenthesisCloserPointer]['line'] === $tokens[$stringPointer]['line']) {
$call = $this->getCall($phpcsFile, $parenthesisOpenerPointer, $parenthesisCloserPointer);
$lineEnd = $this->getLineEnd($phpcsFile, $parenthesisCloserPointer);
$lineLength = strlen($lineStart . $call . $lineEnd);
} else {
$lineEnd = $this->getLineEnd($phpcsFile, $parenthesisOpenerPointer + 1);
$lineLength = strlen($lineStart . $lineEnd);
}
$firstNonWhitespaceOnLine = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $stringPointer);
$indentation = IndentationHelper::getIndentation($phpcsFile, $firstNonWhitespaceOnLine);
$oneIndentation = IndentationHelper::getOneIndentationLevel($phpcsFile);
if (!$this->shouldReportError(
$lineLength,
$lineStart,
$lineEnd,
count($parametersPointers),
strlen($oneIndentation),
)) {
return;
}
$previousPointer = TokenHelper::findPreviousEffective($phpcsFile, $stringPointer - 1);
$name = ltrim($tokens[$stringPointer]['content'], '\\');
if (in_array($tokens[$previousPointer]['code'], [T_OBJECT_OPERATOR, T_DOUBLE_COLON], true)) {
$error = sprintf('Call of method %s() should be split to more lines.', $name);
} elseif ($tokens[$previousPointer]['code'] === T_NEW) {
$error = 'Constructor call should be split to more lines.';
} else {
$error = sprintf('Call of function %s() should be split to more lines.', $name);
}
$fix = $phpcsFile->addFixableError($error, $stringPointer, self::CODE_REQUIRED_MULTI_LINE_CALL);
if (!$fix) {
return;
}
$parametersIndentation = IndentationHelper::addIndentation($phpcsFile, $indentation);
$phpcsFile->fixer->beginChangeset();
for ($i = $parenthesisOpenerPointer + 1; $i < $parenthesisCloserPointer; $i++) {
if (in_array($i, $parametersPointers, true)) {
FixerHelper::removeWhitespaceBefore($phpcsFile, $i);
FixerHelper::addBefore($phpcsFile, $i, $phpcsFile->eolChar . $parametersIndentation);
} elseif ($tokens[$i]['content'] === $phpcsFile->eolChar) {
FixerHelper::add($phpcsFile, $i, $oneIndentation);
} else {
// Create conflict so inner calls are fixed in next loop
FixerHelper::replace($phpcsFile, $i, $tokens[$i]['content']);
}
}
FixerHelper::addBefore($phpcsFile, $parenthesisCloserPointer, $phpcsFile->eolChar . $indentation);
$phpcsFile->fixer->endChangeset();
}
private function shouldBeSkipped(File $phpcsFile, int $stringPointer, int $parenthesisCloserPointer): bool
{
$tokens = $phpcsFile->getTokens();
$searchStartPointer = TokenHelper::findFirstNonWhitespaceOnLine($phpcsFile, $stringPointer);
while (true) {
$stringPointerBefore = TokenHelper::findNext(
$phpcsFile,
TokenHelper::ONLY_NAME_TOKEN_CODES,
$searchStartPointer,
$stringPointer,
);
if ($stringPointerBefore === null) {
break;
}
$pointerAfterStringPointerBefore = TokenHelper::findNextEffective($phpcsFile, $stringPointerBefore + 1);
if (
$tokens[$pointerAfterStringPointerBefore]['code'] === T_OPEN_PARENTHESIS
&& $tokens[$pointerAfterStringPointerBefore]['parenthesis_closer'] > $stringPointer
) {
return true;
}
$searchStartPointer = $stringPointerBefore + 1;
}
$lastPointerOnLine = TokenHelper::findLastTokenOnLine($phpcsFile, $parenthesisCloserPointer);
$searchStartPointer = $parenthesisCloserPointer + 1;
while (true) {
$stringPointerAfter = TokenHelper::findNext(
$phpcsFile,
TokenHelper::ONLY_NAME_TOKEN_CODES,
$searchStartPointer,
$lastPointerOnLine + 1,
);
if ($stringPointerAfter === null) {
break;
}
$pointerAfterStringPointerAfter = TokenHelper::findNextEffective($phpcsFile, $stringPointerAfter + 1);
if (
$pointerAfterStringPointerAfter !== null
&& $tokens[$pointerAfterStringPointerAfter]['code'] === T_OPEN_PARENTHESIS
&& $tokens[$tokens[$pointerAfterStringPointerAfter]['parenthesis_closer']]['line'] === $tokens[$stringPointer]['line']
&& $tokens[$pointerAfterStringPointerAfter]['parenthesis_closer'] !== TokenHelper::findNextEffective(
$phpcsFile,
$pointerAfterStringPointerAfter + 1,
)
) {
return true;
}
$searchStartPointer = $stringPointerAfter + 1;
}
return false;
}
private function shouldReportError(
int $lineLength,
string $lineStart,
string $lineEnd,
int $parametersCount,
int $indentationLength
): bool
{
if ($this->minLineLength === 0) {
return true;
}
if ($lineLength < $this->minLineLength) {
return false;
}
if ($parametersCount > 1) {
return true;
}
return strlen(trim($lineStart) . trim($lineEnd)) > $indentationLength;
}
}
Directory Contents
Dirs: 0 × Files: 21