Documentation

PhpdocToReturnTypeFixer extends AbstractPhpdocToTypeDeclarationFixer
in package
implements ConfigurableFixerInterface, ExperimentalFixerInterface

FinalYes
Tags
author

Filippo Tessarotto zoeslam@gmail.com

implements

ConfigurableFixerInterface<_AutogeneratedInputConfiguration, _AutogeneratedComputedConfiguration>

phpstan-type

_AutogeneratedInputConfiguration array{ scalar_types?: bool, union_types?: bool }

phpstan-type

_AutogeneratedComputedConfiguration array{ scalar_types: bool, union_types: bool }

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

Properties

$excludeFuncNames

private array<int, array<int, int|string>> $excludeFuncNames = [[T_STRING, '__construct'], [T_STRING, '__destruct'], [T_STRING, '__clone']]

Methods

getPriority()

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
int

isCandidate()

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
bool

isSkippedType()

protected isSkippedType(string $type) : bool
Parameters
$type : string
Return values
bool

hasReturnTypeHint()

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 ;

Return values
bool

        
On this page

Search results