Skip to content

OrderedDocblock

github-actions edited this page Mar 26, 2026 · 1 revision

Represents a Docblock that preserves and sorts tags in a defined order for PHPDoc normalization.


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

Methods

create

Creates an OrderedDocblock instance from a docblock string or reflection.

public static create(\ReflectionFunctionAbstract|\ReflectionClass|\ReflectionProperty|string $docblock = ''): self
  • This method is static. Parameters:
Parameter Type Description
$docblock \ReflectionFunctionAbstract|\ReflectionClass|\ReflectionProperty|string the docblock source

Return Value:

the created OrderedDocblock instance


getSortedTags

Returns the tags sorted by the defined priority order: param, return, throws, then others.

public getSortedTags(): \phootwork\collection\ArrayList<\phpowermove\docblock\tags\AbstractTag>

Return Value:

the sorted tags


Clone this wiki locally