NoBreakCommentFixer
extends AbstractFixer
in package
implements
ConfigurableFixerInterface, WhitespacesAwareFixerInterface
uses
ConfigurableFixerTrait
FinalYes
Fixer for rule defined in PSR2 ¶5.2.
Tags
Table of Contents
Interfaces
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
- createConfigurationDefinition() : FixerConfigurationResolverInterface
- ensureNewLineAt() : int
- fixCase() : void
- getParenthesisedStructureKinds() : array<int, int>
- getStructureEnd() : int
- insertCommentAt() : void
- isNoBreakComment() : bool
- removeComment() : void
Methods
getDefinition()
Returns the definition of the fixer.
public
getDefinition() : FixerDefinitionInterface
Return values
FixerDefinitionInterfacegetPriority()
Returns the priority of the fixer.
public
getPriority() : int
Must run after NoUselessElseFixer.
Return values
intisCandidate()
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
boolapplyFix()
protected
applyFix(SplFileInfo $file, Tokens $tokens) : void
Parameters
- $file : SplFileInfo
- $tokens : Tokens
createConfigurationDefinition()
protected
createConfigurationDefinition() : FixerConfigurationResolverInterface
Return values
FixerConfigurationResolverInterfaceensureNewLineAt()
private
ensureNewLineAt(Tokens $tokens, int $position) : int
Parameters
- $tokens : Tokens
- $position : int
Return values
int —The newline token position
fixCase()
private
fixCase(Tokens $tokens, int $casePosition) : void
Parameters
- $tokens : Tokens
- $casePosition : int
getParenthesisedStructureKinds()
private
static getParenthesisedStructureKinds() : array<int, int>
Return values
array<int, int>getStructureEnd()
private
getStructureEnd(Tokens $tokens, int $position) : int
Parameters
- $tokens : Tokens
- $position : int
Return values
intinsertCommentAt()
private
insertCommentAt(Tokens $tokens, int $casePosition) : void
Parameters
- $tokens : Tokens
- $casePosition : int
isNoBreakComment()
private
isNoBreakComment(Token $token) : bool
Parameters
- $token : Token
Return values
boolremoveComment()
private
removeComment(Tokens $tokens, int $commentPosition) : void
Parameters
- $tokens : Tokens
- $commentPosition : int