PhpdocToReturnTypeFixer
extends AbstractPhpdocToTypeDeclarationFixer
in package
implements
ConfigurableFixerInterface, ExperimentalFixerInterface
Tags
Table of Contents
Interfaces
- ConfigurableFixerInterface
- ExperimentalFixerInterface
Constants
- TYPE_CHECK_TEMPLATE = '<?php function f(): %s {}'
Properties
- $excludeFuncNames : array<int, array<int, int|string>>
- $skippedTypes : array<string, true>
Methods
- getDefinition() : FixerDefinitionInterface
- Returns the definition of the fixer.
- getPriority() : int
- Returns the priority of the fixer.
- isCandidate() : bool
- Check if the fixer is a candidate for given Tokens collection.
- applyFix() : void
- createTokensFromRawType() : Tokens
- isSkippedType() : bool
- hasReturnTypeHint() : bool
- Determine whether the function already has a return type hint.
Constants
TYPE_CHECK_TEMPLATE
private
mixed
TYPE_CHECK_TEMPLATE
= '<?php function f(): %s {}'
Properties
$excludeFuncNames
private
array<int, array<int, int|string>>
$excludeFuncNames
= [[T_STRING, '__construct'], [T_STRING, '__destruct'], [T_STRING, '__clone']]
$skippedTypes
private
array<string, true>
$skippedTypes
= ['resource' => true, 'null' => true]
Methods
getDefinition()
Returns the definition of the fixer.
public
getDefinition() : FixerDefinitionInterface
Return values
FixerDefinitionInterfacegetPriority()
Returns the priority of the fixer.
public
getPriority() : int
Must run before FullyQualifiedStrictTypesFixer, NoSuperfluousPhpdocTagsFixer, PhpdocAlignFixer, ReturnToYieldFromFixer, ReturnTypeDeclarationFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
Return values
intisCandidate()
Check if the fixer is a candidate for given Tokens collection.
public
isCandidate(Tokens $tokens) : bool
Fixer is a candidate when the collection contains tokens that may be fixed during fixer work. This could be considered as some kind of bloom filter. When this method returns true then to the Tokens collection may or may not need a fixing, but when this method returns false then the Tokens collection need no fixing for sure.
Parameters
- $tokens : Tokens
Return values
boolapplyFix()
protected
applyFix(SplFileInfo $file, Tokens $tokens) : void
Parameters
- $file : SplFileInfo
- $tokens : Tokens
createTokensFromRawType()
protected
createTokensFromRawType(string $type) : Tokens
Parameters
- $type : string
Return values
TokensisSkippedType()
protected
isSkippedType(string $type) : bool
Parameters
- $type : string
Return values
boolhasReturnTypeHint()
Determine whether the function already has a return type hint.
private
hasReturnTypeHint(Tokens $tokens, int $index) : bool
Parameters
- $tokens : Tokens
- $index : int
-
The index of the end of the function definition line, EG at { or ;