PhpdocToParamTypeFixer
extends AbstractPhpdocToTypeDeclarationFixer
in package
implements
ConfigurableFixerInterface, ExperimentalFixerInterface
Tags
Table of Contents
Interfaces
- ConfigurableFixerInterface
- ExperimentalFixerInterface
Constants
- EXCLUDE_FUNC_NAMES = [[T_STRING, '__clone'], [T_STRING, '__destruct']]
- SKIPPED_TYPES = ['resource' => true, 'static' => true, 'void' => true]
- TYPE_CHECK_TEMPLATE = '<?php function f(%s $x) {}'
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
- findCorrectVariable() : int|null
- hasParamTypeHint() : bool
- Determine whether the function already has a param type hint.
Constants
EXCLUDE_FUNC_NAMES
private
array<int, array{: int, : string}>
EXCLUDE_FUNC_NAMES
= [[T_STRING, '__clone'], [T_STRING, '__destruct']]
SKIPPED_TYPES
private
array<string, true>
SKIPPED_TYPES
= ['resource' => true, 'static' => true, 'void' => true]
TYPE_CHECK_TEMPLATE
private
mixed
TYPE_CHECK_TEMPLATE
= '<?php function f(%s $x) {}'
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 NoSuperfluousPhpdocTagsFixer, PhpdocAlignFixer. 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
boolfindCorrectVariable()
private
findCorrectVariable(Tokens $tokens, int $startIndex, Annotation $paramTypeAnnotation) : int|null
Parameters
- $tokens : Tokens
- $startIndex : int
- $paramTypeAnnotation : Annotation
Return values
int|nullhasParamTypeHint()
Determine whether the function already has a param type hint.
private
hasParamTypeHint(Tokens $tokens, int $index) : bool
Parameters
- $tokens : Tokens
- $index : int
-
The index of the end of the function definition line, EG at { or ;