Docs For Class Fixer

addContent [line 704]

bool addContent(
int
$stackPtr, string
$content)

Adds content to the end of a token's current content.

Return: If the change was accepted.
Access: public

Parameters:

int	`$stackPtr`	—	The position of the token in the token stack.
string	`$content`	—	The content to add.

[ Top ]

addContentBefore [line 720]

bool addContentBefore(
int
$stackPtr, string
$content)

Adds content to the start of a token's current content.

Return: If the change was accepted.
Access: public

Parameters:

int	`$stackPtr`	—	The position of the token in the token stack.
string	`$content`	—	The content to add.

[ Top ]

addNewline [line 673]

bool addNewline(
int
$stackPtr)

Adds a newline to end of a token's content.

Return: If the change was accepted.
Access: public

Parameters:

int $stackPtr — The position of the token in the token stack.

[ Top ]

addNewlineBefore [line 688]

bool addNewlineBefore(
int
$stackPtr)

Adds a newline to the start of a token's content.

Return: If the change was accepted.
Access: public

Parameters:

int $stackPtr — The position of the token in the token stack.

[ Top ]

beginChangeset [line 352]

void beginChangeset(
)

Start recording actions for a changeset.

Access: public

[ Top ]

endChangeset [line 379]

boolean endChangeset(
)

Stop recording actions for a changeset, and apply logged changes.

Access: public

[ Top ]

fixFile [line 140]

boolean fixFile(
)

Attempt to fix the file by processing it until no fixes are made.

Access: public

[ Top ]

generateDiff [line 232]

string generateDiff(
[string
$filePath = null], [boolean
$colors = true])

Generates a text diff of the original file and the new content.

Access: public

Parameters:

string	`$filePath`	—	Optional file path to diff the file against. If not specified, the original version of the file will be used.
boolean	`$colors`	—	Print colored output or not.

[ Top ]

getContents [line 316]

string getContents(
)

Get the current content of the file, as a string.

Access: public

[ Top ]

getFixCount [line 304]

int getFixCount(
)

Get a count of fixes that have been performed on the file.

This value is reset every time a new file is started, or an existing file is restarted.

Access: public

[ Top ]

getTokenContent [line 334]

string getTokenContent(
int
$stackPtr)

Get the current fixed content of a token.

This function takes changesets into account so should be used instead of directly accessing the token array.

Access: public

Parameters:

int $stackPtr — The position of the token in the token stack.

[ Top ]

replaceToken [line 464]

bool replaceToken(
int
$stackPtr, string
$content)

Replace the entire contents of a token.

Return: If the change was accepted.
Access: public

Parameters:

int	`$stackPtr`	—	The position of the token in the token stack.
string	`$content`	—	The new content of the token.

[ Top ]

revertToken [line 593]

bool revertToken(
int
$stackPtr)

Reverts the previous fix made to a token.

Return: If a change was reverted.
Access: public

Parameters:

int $stackPtr — The position of the token in the token stack.

[ Top ]

rollbackChangeset [line 426]

void rollbackChangeset(
)

Stop recording actions for a changeset, and discard logged changes.

Access: public

[ Top ]

startFile [line 116]

void startFile(
File
$phpcsFile)

Starts fixing a new file.

Access: public

Parameters:

\PHP_CodeSniffer\Files\File $phpcsFile — The file being fixed.

[ Top ]

substrToken [line 651]

bool substrToken(
int
$stackPtr, int
$start, [int
$length = null])

Replace the content of a token with a part of its current content.

Return: If the change was accepted.
Access: public

Parameters:

int	`$stackPtr`	—	The position of the token in the token stack.
int	`$start`	—	The first character to keep.
int	`$length`	—	The number of chacters to keep. If NULL, the content of the token from $start to the end of the content is kept.

[ Top ]

Class: Fixer

Class Overview

Author(s):

Copyright:

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$enabled = false

$loops = 0

Method Detail

addContent [line 704]

Parameters:

addContentBefore [line 720]

Parameters:

addNewline [line 673]

Parameters:

addNewlineBefore [line 688]

Parameters:

beginChangeset [line 352]

endChangeset [line 379]

fixFile [line 140]

generateDiff [line 232]

Parameters:

getContents [line 316]

getFixCount [line 304]

getTokenContent [line 334]

Parameters:

replaceToken [line 464]

Parameters:

revertToken [line 593]

Parameters:

rollbackChangeset [line 426]

startFile [line 116]

Parameters:

substrToken [line 651]

Parameters: