Documentation

PhpdocIndentFixer extends AbstractFixer
in package

Tags
author

Ceeram ceeram@cakephp.org

author

Graham Campbell graham@alt-three.com

Table of Contents

getDefinition()  : mixed
{@inheritdoc}
getPriority()  : mixed
{@inheritdoc}
isCandidate()  : mixed
{@inheritdoc}
applyFix()  : mixed
{@inheritdoc}
fixDocBlock()  : string
Fix indentation of Docblock.
fixWhitespaceBeforeDocblock()  : string

Methods

getDefinition()

{@inheritdoc}

public getDefinition() : mixed
Return values
mixed

getPriority()

{@inheritdoc}

public getPriority() : mixed

Must run before GeneralPhpdocAnnotationRemoveFixer, GeneralPhpdocTagRenameFixer, NoBlankLinesAfterPhpdocFixer, NoEmptyPhpdocFixer, NoSuperfluousPhpdocTagsFixer, PhpdocAddMissingParamAnnotationFixer, PhpdocAlignFixer, PhpdocAlignFixer, PhpdocAnnotationWithoutDotFixer, PhpdocInlineTagFixer, PhpdocInlineTagNormalizerFixer, PhpdocLineSpanFixer, PhpdocNoAccessFixer, PhpdocNoAliasTagFixer, PhpdocNoEmptyReturnFixer, PhpdocNoPackageFixer, PhpdocNoUselessInheritdocFixer, PhpdocOrderByValueFixer, PhpdocOrderFixer, PhpdocReturnSelfReferenceFixer, PhpdocSeparationFixer, PhpdocSingleLineVarSpacingFixer, PhpdocSummaryFixer, PhpdocTagCasingFixer, PhpdocTagTypeFixer, PhpdocToParamTypeFixer, PhpdocToPropertyTypeFixer, PhpdocToReturnTypeFixer, PhpdocTrimConsecutiveBlankLineSeparationFixer, PhpdocTrimFixer, PhpdocTypesFixer, PhpdocTypesOrderFixer, PhpdocVarAnnotationCorrectOrderFixer, PhpdocVarWithoutNameFixer. Must run after IndentationTypeFixer, PhpdocToCommentFixer.

Return values
mixed

applyFix()

{@inheritdoc}

protected applyFix(SplFileInfo $file, Tokens $tokens) : mixed
Parameters
$file : SplFileInfo
$tokens : Tokens
Return values
mixed

fixDocBlock()

Fix indentation of Docblock.

private fixDocBlock(string $content, string $indent) : string
Parameters
$content : string

Docblock contents

$indent : string

Indentation to apply

Return values
string

Dockblock contents including correct indentation

fixWhitespaceBeforeDocblock()

private fixWhitespaceBeforeDocblock(string $content, string $indent) : string
Parameters
$content : string

Whitespace before Docblock

$indent : string

Indentation of the documented subject

Return values
string

Whitespace including correct indentation for Dockblock after this whitespace

Search results