Skip to content

AddMissingMethodPhpDocRector

Felipe Sayão Lobato Abreu edited this page Mar 24, 2026 · 1 revision

  • Full name: \FastForward\DevTools\Rector\AddMissingMethodPhpDocRector
  • Parent class: AbstractRector
  • This class is marked as final and can't be subclassed
  • This class is a Final class

Methods

getRuleDefinition

public getRuleDefinition(): \Symplify\RuleDocGenerator\ValueObject\RuleDefinition

getNodeTypes

public getNodeTypes(): array

refactor

public refactor(\PhpParser\Node $node): \PhpParser\Node

Parameters:

Parameter Type Description
$node \PhpParser\Node

normalizeDocblockSpacing

private normalizeDocblockSpacing(string $docblock): string

Parameters:

Parameter Type Description
$docblock string

resolveTagGroup

private resolveTagGroup(string $line): string|null

Parameters:

Parameter Type Description
$line string

shouldInsertBlankLineBetweenTagGroups

private shouldInsertBlankLineBetweenTagGroups(string $previousTagGroup, string $currentTagGroup): bool

Parameters:

Parameter Type Description
$previousTagGroup string
$currentTagGroup string

getExistingParamVariables

private getExistingParamVariables(\phpowermove\docblock\Docblock $docblock): string[]

Parameters:

Parameter Type Description
$docblock \phpowermove\docblock\Docblock

shouldAddReturnTag

private shouldAddReturnTag(\PhpParser\Node\Stmt\ClassMethod $node, \phpowermove\docblock\Docblock $docblock): bool

Parameters:

Parameter Type Description
$node \PhpParser\Node\Stmt\ClassMethod
$docblock \phpowermove\docblock\Docblock

getExistingThrowsTypes

private getExistingThrowsTypes(\phpowermove\docblock\Docblock $docblock): string[]

Parameters:

Parameter Type Description
$docblock \phpowermove\docblock\Docblock

resolveThrows

private resolveThrows(\PhpParser\Node\Stmt\ClassMethod $node): string[]

Parameters:

Parameter Type Description
$node \PhpParser\Node\Stmt\ClassMethod

resolveNameToString

private resolveNameToString(\PhpParser\Node\Name $name): string

Parameters:

Parameter Type Description
$name \PhpParser\Node\Name

createDocblockFromReflection

private createDocblockFromReflection(\PhpParser\Node\Stmt\ClassMethod $node): \phpowermove\docblock\Docblock

Parameters:

Parameter Type Description
$node \PhpParser\Node\Stmt\ClassMethod

resolveTypeToString

private resolveTypeToString(string|\PhpParser\Node\Identifier|\PhpParser\Node\Name|\PhpParser\Node\ComplexType|null $type): string

Parameters:

Parameter Type Description
$type string|\PhpParser\Node\Identifier|\PhpParser\Node\Name|\PhpParser\Node\ComplexType|null

Clone this wiki locally