PHP Class PhpCsFixer\Fixer\Phpdoc\PhpdocToCommentFixer

Author: Ceeram ([email protected])
Author: Dariusz Rumiński ([email protected])
Inheritance: extends PhpCsFixer\AbstractFixer
Exibir arquivo Open project: friendsofphp/php-cs-fixer

Public Methods

Method Description
fix ( SplFileInfo $file, Tokens $tokens )
getPriority ( )
isCandidate ( Tokens $tokens )

Protected Methods

Method Description
getDescription ( )

Private Methods

Method Description
isStructuralElement ( PhpCsFixer\Tokenizer\Token $token ) : boolean Check if token is a structural element.
isValidControl ( Tokens $tokens, PhpCsFixer\Tokenizer\Token $docsToken, integer $controlIndex ) : boolean Checks control structures (while, if, foreach, switch) for correct docblock usage.
isValidList ( Tokens $tokens, PhpCsFixer\Tokenizer\Token $docsToken, integer $listIndex ) : boolean Checks variable assignments through list() calls for correct docblock usage.
isValidVariable ( Tokens $tokens, PhpCsFixer\Tokenizer\Token $docsToken, integer $variableIndex ) : boolean Checks variable assignments for correct docblock usage.

Method Details

fix() public method

public fix ( SplFileInfo $file, Tokens $tokens )
$file SplFileInfo
$tokens PhpCsFixer\Tokenizer\Tokens

getDescription() protected method

protected getDescription ( )

getPriority() public method

public getPriority ( )

isCandidate() public method

public isCandidate ( Tokens $tokens )
$tokens PhpCsFixer\Tokenizer\Tokens