Current File : /home/vacivi36/code/vendor/friendsofphp/php-cs-fixer/src/Fixer/FunctionNotation/VoidReturnFixer.php
<?php
declare(strict_types=1);
/*
* This file is part of PHP CS Fixer.
*
* (c) Fabien Potencier <fabien@symfony.com>
* Dariusz Rumiński <dariusz.ruminski@gmail.com>
*
* This source file is subject to the MIT license that is bundled
* with this source code in the file LICENSE.
*/
namespace PhpCsFixer\Fixer\FunctionNotation;
use PhpCsFixer\AbstractFixer;
use PhpCsFixer\DocBlock\Annotation;
use PhpCsFixer\DocBlock\DocBlock;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Tokenizer\CT;
use PhpCsFixer\Tokenizer\Token;
use PhpCsFixer\Tokenizer\Tokens;
use PhpCsFixer\Tokenizer\TokensAnalyzer;
/**
* @author Mark Nielsen
*/
final class VoidReturnFixer extends AbstractFixer
{
/**
* {@inheritdoc}
*/
public function getDefinition(): FixerDefinitionInterface
{
return new FixerDefinition(
'Add `void` return type to functions with missing or empty return statements, but priority is given to `@return` annotations. Requires PHP >= 7.1.',
[
new CodeSample(
"<?php\nfunction foo(\$a) {};\n"
),
],
null,
'Modifies the signature of functions.'
);
}
/**
* {@inheritdoc}
*
* Must run before PhpdocNoEmptyReturnFixer, ReturnTypeDeclarationFixer.
* Must run after NoSuperfluousPhpdocTagsFixer, SimplifiedNullReturnFixer.
*/
public function getPriority(): int
{
return 5;
}
/**
* {@inheritdoc}
*/
public function isCandidate(Tokens $tokens): bool
{
return $tokens->isTokenKindFound(T_FUNCTION);
}
/**
* {@inheritdoc}
*/
public function isRisky(): bool
{
return true;
}
/**
* {@inheritdoc}
*/
protected function applyFix(\SplFileInfo $file, Tokens $tokens): void
{
// These cause syntax errors.
static $excludedFunctions = [
[T_STRING, '__clone'],
[T_STRING, '__construct'],
[T_STRING, '__debugInfo'],
[T_STRING, '__destruct'],
[T_STRING, '__isset'],
[T_STRING, '__serialize'],
[T_STRING, '__set_state'],
[T_STRING, '__sleep'],
[T_STRING, '__toString'],
];
for ($index = $tokens->count() - 1; 0 <= $index; --$index) {
if (!$tokens[$index]->isGivenKind(T_FUNCTION)) {
continue;
}
$functionName = $tokens->getNextMeaningfulToken($index);
if ($tokens[$functionName]->equalsAny($excludedFunctions, false)) {
continue;
}
$startIndex = $tokens->getNextTokenOfKind($index, ['{', ';']);
if ($this->hasReturnTypeHint($tokens, $startIndex)) {
continue;
}
if ($tokens[$startIndex]->equals(';')) {
// No function body defined, fallback to PHPDoc.
if ($this->hasVoidReturnAnnotation($tokens, $index)) {
$this->fixFunctionDefinition($tokens, $startIndex);
}
continue;
}
if ($this->hasReturnAnnotation($tokens, $index)) {
continue;
}
$endIndex = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $startIndex);
if ($this->hasVoidReturn($tokens, $startIndex, $endIndex)) {
$this->fixFunctionDefinition($tokens, $startIndex);
}
}
}
/**
* Determine whether there is a non-void return annotation in the function's PHPDoc comment.
*
* @param int $index The index of the function token
*/
private function hasReturnAnnotation(Tokens $tokens, int $index): bool
{
foreach ($this->findReturnAnnotations($tokens, $index) as $return) {
if (['void'] !== $return->getTypes()) {
return true;
}
}
return false;
}
/**
* Determine whether there is a void return annotation in the function's PHPDoc comment.
*
* @param int $index The index of the function token
*/
private function hasVoidReturnAnnotation(Tokens $tokens, int $index): bool
{
foreach ($this->findReturnAnnotations($tokens, $index) as $return) {
if (['void'] === $return->getTypes()) {
return true;
}
}
return false;
}
/**
* Determine whether the function already has a return type hint.
*
* @param int $index The index of the end of the function definition line, EG at { or ;
*/
private function hasReturnTypeHint(Tokens $tokens, int $index): bool
{
$endFuncIndex = $tokens->getPrevTokenOfKind($index, [')']);
$nextIndex = $tokens->getNextMeaningfulToken($endFuncIndex);
return $tokens[$nextIndex]->isGivenKind(CT::T_TYPE_COLON);
}
/**
* Determine whether the function has a void return.
*
* @param int $startIndex Start of function body
* @param int $endIndex End of function body
*/
private function hasVoidReturn(Tokens $tokens, int $startIndex, int $endIndex): bool
{
$tokensAnalyzer = new TokensAnalyzer($tokens);
for ($i = $startIndex; $i < $endIndex; ++$i) {
if (
// skip anonymous classes
($tokens[$i]->isGivenKind(T_CLASS) && $tokensAnalyzer->isAnonymousClass($i))
// skip lambda functions
|| ($tokens[$i]->isGivenKind(T_FUNCTION) && $tokensAnalyzer->isLambda($i))
) {
$i = $tokens->getNextTokenOfKind($i, ['{']);
$i = $tokens->findBlockEnd(Tokens::BLOCK_TYPE_CURLY_BRACE, $i);
continue;
}
if ($tokens[$i]->isGivenKind([T_YIELD, T_YIELD_FROM])) {
return false; // Generators cannot return void.
}
if (!$tokens[$i]->isGivenKind(T_RETURN)) {
continue;
}
$i = $tokens->getNextMeaningfulToken($i);
if (!$tokens[$i]->equals(';')) {
return false;
}
}
return true;
}
/**
* @param int $index The index of the end of the function definition line, EG at { or ;
*/
private function fixFunctionDefinition(Tokens $tokens, int $index): void
{
$endFuncIndex = $tokens->getPrevTokenOfKind($index, [')']);
$tokens->insertAt($endFuncIndex + 1, [
new Token([CT::T_TYPE_COLON, ':']),
new Token([T_WHITESPACE, ' ']),
new Token([T_STRING, 'void']),
]);
}
/**
* Find all the return annotations in the function's PHPDoc comment.
*
* @param int $index The index of the function token
*
* @return Annotation[]
*/
private function findReturnAnnotations(Tokens $tokens, int $index): array
{
do {
$index = $tokens->getPrevNonWhitespace($index);
} while ($tokens[$index]->isGivenKind([
T_ABSTRACT,
T_FINAL,
T_PRIVATE,
T_PROTECTED,
T_PUBLIC,
T_STATIC,
]));
if (!$tokens[$index]->isGivenKind(T_DOC_COMMENT)) {
return [];
}
$doc = new DocBlock($tokens[$index]->getContent());
return $doc->getAnnotationsOfType('return');
}
}
Mini Shell