Docs For Class PHP

add [line 1058]

void add(
string
$token)

Add a string to the output

Parameters:

string $token —

[ Top ]

addFilter [line 382]

bool addFilter(
string
$mFilter, [array
$aSettings = array()])

Add a Filter to the Beautifier The first argument is the name of the file of the Filter.

Return: true if Filter is loaded, false if the same filter was loaded previously
Throws: Exception
Tutorial: Filter.pkg

Parameters:

string	`$mFilter`	—	name of the Filter
array	`$aSettings`	—	settings for the Filter

[ Top ]

addFilterDirectory [line 351]

void addFilterDirectory(
string
$sDir)

Add a filter directory

Throws: Exception

Parameters:

string $sDir — path to directory

[ Top ]

addFilterFile [line 443]

bool addFilterFile(
string
$sFilter)

Add a new filter to the processor.

The system will process the filter in LIFO order

Throws: Exception
See: PHP_Beautifier::process()

Parameters:

string $sFilter — name of filter

[ Top ]

addFilterObject [line 368]

void addFilterObject(
mixed
PHP_Beautifier_Filter$oFilter)

[ Top ]

addIndent [line 1088]

void addIndent(
)

Add Indent to the output

See: $iIndent
See: $iIndentNumber
See: $sIndentChar

[ Top ]

addNewLine [line 1078]

void addNewLine(
)

Add a new line to the output

See: $sNewLine

[ Top ]

addNewLineIndent [line 1099]

void addNewLineIndent(
)

Add a new line and a indent to output

See: $sNewLine
See: $iIndent
See: $iIndentNumber
See: $sIndentChar

[ Top ]

controlToken [line 792]

void controlToken(
array
$aCurrentToken)

Assign value for some variables with the information of the token

Usedby: PHP_Beautifier::processCallback()

Parameters:

array $aCurrentToken — current token

[ Top ]

controlTokenPost [line 875]

void controlTokenPost(
array
$aCurrentToken)

Assign value for some variables with the information of the token, after processing

Parameters:

array $aCurrentToken — current token

[ Top ]

decIndent [line 1120]

void decIndent(
)

Decrements the indent.

[ Top ]

get [line 988]

string get(
)

Returns the beutified code

[ Top ]

getControlParenthesis [line 1016]

mixed getControlParenthesis(
[int
$iRet = 0])

Get the token constant for the current Parenthesis

Return: token constant or false

Parameters:

int $iRet — current token -'x'

[ Top ]

getControlSeq [line 1006]

void getControlSeq(
[int
$iRet = 0])

Get the token constant for the current control construct

Parameters:

int $iRet — current token -'x' @ return mixed token constant or false

[ Top ]

getFilterDescription [line 423]

mixed getFilterDescription(
string
$sFilter)

Return the Filter Description

Return: string or false
See: PHP_Beautifier_Filter::__toString();

Parameters:

string $sFilter — name of the filter

[ Top ]

getFilterDirectories [line 364]

array getFilterDirectories(
)

Return an array with all the Filter Dirs

Return: List of Filter Directories

[ Top ]

getFilterList [line 466]

array getFilterList(
)

Get the names of the loaded filters

Return: list of Filters

[ Top ]

getFilterListTotal [line 477]

array getFilterListTotal(
)

Get the list of all available Filters in all the include Dirs

Return: list of Filters

[ Top ]

getFilterList_FilterName [line 494]

void getFilterList_FilterName(
mixed
&$sFile)

Receive a path to a filter and replace it with the name of filter

[ Top ]

getIndentChar [line 499]

void getIndentChar(
)

[ Top ]

getIndentNumber [line 503]

void getIndentNumber(
)

[ Top ]

getMode [line 1046]

bool getMode(
string
$sKey)

Get the state of a mode

Parameters:

string $sKey — name of the mode

[ Top ]

getNewLine [line 507]

void getNewLine(
)

[ Top ]

getNextToken [line 1155]

array getNextToken(
[int
$iNext = 1])

Get the 'x' significant (non whitespace) next token

Parameters:

int $iNext — current+x token

[ Top ]

getNextTokenConstant [line 1252]

int getNextTokenConstant(
[int
$iPrev = 1])

Get the 'x' significant (non whitespace) next token constant

Parameters:

int $iPrev — current+x token

[ Top ]

getNextTokenContent [line 1262]

int getNextTokenContent(
[int
$iNext = 1])

Get the 'x' significant (non whitespace) next token text

Parameters:

int $iNext — current+x token

[ Top ]

getPreviousToken [line 1138]

mixed getPreviousToken(
[int
$iPrev = 1])

Get the 'x' significant (non whitespace)previous token

Return: array or false

Parameters:

int $iPrev — current-x token

[ Top ]

getPreviousTokenConstant [line 1232]

int getPreviousTokenConstant(
[int
$iPrev = 1])

Get the 'x' significant (non whitespace) previous token constant

Parameters:

int $iPrev — current-x token

[ Top ]

getPreviousTokenContent [line 1242]

string getPreviousTokenContent(
[int
$iPrev = 1])

Get the 'x' significant (non whitespace) previous token text

Parameters:

int $iPrev — current-x token

[ Top ]

getPreviousWhitespace [line 1275]

string getPreviousWhitespace(
)

Return the whitespace previous to current token

Ex.: You have ' if($a)' if you call this funcion on 'if', you get ' '

Return: previous whitespace
Todo: implements a more economic way to handle this.

[ Top ]

getSetting [line 997]

mixed getSetting(
string
$sKey)

Returns the value of a settings

Return: Value of the settings or false

Parameters:

string $sKey — Name of the setting

[ Top ]

getToken [line 1333]

array &getToken(
int
$iIndex)

Get a token by number

Parameters:

int $iIndex — number of the token

[ Top ]

getTokenAssoc [line 723]

mixed getTokenAssoc(
int
$iIndex)

Get the reference to $aOut, based on the number of the token

Return: false array or false if token doesn't exists

Parameters:

int $iIndex — token number

[ Top ]

getTokenAssocText [line 732]

mixed getTokenAssocText(
int
$iIndex)

Get the output for the specified token

Return: string or false if token doesn't exists

Parameters:

int $iIndex — token number

[ Top ]

getTokenFunction [line 761]

mixed getTokenFunction(
mixed
$sTokenType)

Return the function for a token constant or string.

Return: name of function or false

Parameters:

mixed $sTokenType — token constant or string

[ Top ]

incIndent [line 1109]

void incIndent(
[int
$iIncr = false])

Increments the indent in X chars.

If param omitted, used iIndentNumber

Parameters:

int $iIncr — increment indent in x chars

[ Top ]

isNextTokenConstant [line 1202]

bool isNextTokenConstant(
mixed
$mValue, [mixed
$iPrev = 1])

Return true if any of the constant defined in param 1 is the next 'x' content

Parameters:

mixed $mValue — int (constant) or array of constants

[ Top ]

isNextTokenContent [line 1217]

bool isNextTokenContent(
mixed
$mValue, [mixed
$iPrev = 1])

Return true if any of the content defined is param 1 is the next 'x' content

Parameters:

mixed $mValue — string (content) or array of contents

[ Top ]

isPreviousTokenConstant [line 1172]

bool isPreviousTokenConstant(
mixed
$mValue, [mixed
$iPrev = 1])

Return true if any of the constant defined is param 1 is the previous 'x' constant

Parameters:

mixed $mValue — int (constant) or array of constants

[ Top ]

isPreviousTokenContent [line 1187]

bool isPreviousTokenContent(
mixed
$mValue, [mixed
$iPrev = 1])

Return true if any of the content defined is param 1 is the previous 'x' content

Parameters:

mixed $mValue — string (content) or array of contents

[ Top ]

pop [line 1067]

void pop(
[int
$iReps = 1])

Delete the last added output(s)

Deprecated:

Parameters:

int $iReps — number of outputs to drop

[ Top ]

popControlParenthesis [line 953]

int popControlParenthesis(
)

Pop the last Control instruction for parenthesis from the stack

Return: constant

[ Top ]

popControlSeq [line 930]

int popControlSeq(
)

Pop a control construct from the stack

Return: token constant

[ Top ]

process [line 635]

bool process(
)

Process the string or file to beautify

Return: true on success
Throws: Exception

[ Top ]

processCallback [line 771]

bool processCallback(
array
$aMatch)

Process a callback from the code to beautify

Uses: PHP_Beautifier::controlToken()

Parameters:

array $aMatch — third parameter from preg_match

[ Top ]

pushControlParenthesis [line 941]

void pushControlParenthesis(
)

Push a new Control Instruction on the stack

[ Top ]

pushControlSeq [line 919]

void pushControlSeq(
array
$aToken)

Push a control construct to the stack

Parameters:

array $aToken — current token

[ Top ]

removeFilter [line 406]

bool removeFilter(
string
$sFilter)

Removes a Filter

Return: true if Filter is removed, false otherwise

Parameters:

string $sFilter — name of the filter

[ Top ]

removeWhitespace [line 1306]

bool removeWhitespace(
)

Remove all whitespace from the previous tag

Return: false if previous token was short comment or heredoc (don't remove ws) true anything else.

[ Top ]

replaceTokenAssoc [line 745]

bool replaceTokenAssoc(
int
$iIndex, string
$sText)

Replace the output for specified token

Parameters:

int	`$iIndex`	—	token number
string	`$sText`	—	replace text

[ Top ]

resetProperties [line 607]

void resetProperties(
)

Reset all properties

[ Top ]

save [line 575]

void save(
[string
$sFile = null])

Save the beautified code to output file

Throws: Exception
See: setOutputFile();

Parameters:

string $sFile — path to file. If null, $sOutputFile if exists, throw exception otherwise

[ Top ]

setBeautify [line 973]

void setBeautify(
bool
$sFlag)

Set the Beautifier on or off

Parameters:

bool $sFlag —

[ Top ]

setFileType [line 965]

void setFileType(
string
$sType)

Set the filetype

Parameters:

string $sType —

[ Top ]

setIndentChar [line 515]

void setIndentChar(
string
$sChar)

Character used for indentation

Parameters:

string $sChar — usually ' ' or "\t"

[ Top ]

setIndentNumber [line 523]

void setIndentNumber(
int
$iIndentNumber)

Number of characters for indentation

Parameters:

int $iIndentNumber — ussualy 4 for space or 1 for tabs

[ Top ]

setInputFile [line 540]

void setInputFile(
string
$sFile)

Set the file for beautify

Throws: Exception

Parameters:

string $sFile — path to file

[ Top ]

setInputString [line 600]

void setInputString(
string
$sText)

Set a string for beautify

Parameters:

string $sText — Must be preceded by open tag

[ Top ]

setMode [line 1029]

void setMode(
string
$sKey)

Set a mode to true

Parameters:

string $sKey — name of the mode

[ Top ]

setNewLine [line 531]

void setNewLine(
string
$sNewLine)

Character used as a new line

Parameters:

string $sNewLine — ussualy "\n", "\r\n" or "\r"

[ Top ]

setOutputFile [line 565]

void setOutputFile(
string
$sFile)

Set the output file for beautify

Parameters:

string $sFile — path to file

[ Top ]

show [line 980]

void show(
)

Show the beautified code

[ Top ]

startLog [line 341]

void startLog(
[string
$sFile = 'php_beautifier.log'], [int
$iLevel = PEAR_LOG_DEBUG])

Start the log for debug

Parameters:

string	`$sFile`	—	filename
int	`$iLevel`	—	debug level. See Log

[ Top ]

unsetMode [line 1037]

void unsetMode(
string
$sKey)

Set a mode to false

Parameters:

string $sKey — name of the mode

[ Top ]

Class: PHP_Beautifier

Class Overview

Author(s):

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

add [line 1058]

Parameters:

addFilter [line 382]

Parameters:

addFilterDirectory [line 351]

Parameters:

addFilterFile [line 443]

Parameters:

addFilterObject [line 368]

addIndent [line 1088]

addNewLine [line 1078]

addNewLineIndent [line 1099]

controlToken [line 792]

Parameters:

controlTokenPost [line 875]

Parameters:

decIndent [line 1120]

get [line 988]

getControlParenthesis [line 1016]

Parameters:

getControlSeq [line 1006]

Parameters:

getFilterDescription [line 423]

Parameters:

getFilterDirectories [line 364]

getFilterList [line 466]

getFilterListTotal [line 477]

getFilterList_FilterName [line 494]

getIndentChar [line 499]

getIndentNumber [line 503]

getMode [line 1046]

Parameters:

getNewLine [line 507]

getNextToken [line 1155]

Parameters:

getNextTokenConstant [line 1252]

Parameters:

getNextTokenContent [line 1262]

Parameters:

getPreviousToken [line 1138]

Parameters:

getPreviousTokenConstant [line 1232]

Parameters:

getPreviousTokenContent [line 1242]

Parameters:

getPreviousWhitespace [line 1275]

getSetting [line 997]

Parameters:

getToken [line 1333]

Parameters:

getTokenAssoc [line 723]

Parameters:

getTokenAssocText [line 732]

Parameters:

getTokenFunction [line 761]

Parameters:

incIndent [line 1109]

Parameters:

isNextTokenConstant [line 1202]

Parameters:

isNextTokenContent [line 1217]

Parameters:

isPreviousTokenConstant [line 1172]

Parameters:

isPreviousTokenContent [line 1187]

Parameters:

pop [line 1067]

Parameters:

popControlParenthesis [line 953]

popControlSeq [line 930]

process [line 635]

processCallback [line 771]