PhpdocToParamTypeFixer
extends AbstractPhpdocToTypeDeclarationFixer
in package
implements
ExperimentalFixerInterface
FinalYes
Tags
Table of Contents
Interfaces
- 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
- getPriority() : int
- {@inheritdoc}
- isCandidate() : bool
- 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()
public
getDefinition() : FixerDefinitionInterface
Return values
FixerDefinitionInterfacegetPriority()
{@inheritdoc}
public
getPriority() : int
Must run before NoSuperfluousPhpdocTagsFixer, PhpdocAlignFixer. Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
Return values
intisCandidate()
public
isCandidate(Tokens $tokens) : bool
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 ;