Docs For Class PHP

$aAssocs = array()

[line 156]

Association $aTokens=>$aOut

Access: public

Type:

string

[ Top ]

$aModes = array()

[line 91]

Contains the assigment of modes

Type:

array

[ Top ]

$aOut = array()

[line 83]

Stores the output

Access: public

Type:

array

[ Top ]

$aSettings = array()

[line 96]

Settings for the class

Access: public

Type:

array

[ Top ]

$aTokenFunctions = array()

[line 78]

Tokens codes assigned to method on Filter

Access: public

Type:

array

[ Top ]

$aTokens = array()

[line 73]

Tokens created by the tokenizer

Access: public

Type:

array

[ Top ]

$currentWhitespace = ''

[line 151]

Save the last whitespace used. Use only for Filter! (i miss friends of C++ :( )

Access: public

Type:

string

[ Top ]

$iArray = 0

[line 116]

Level of array nesting

Access: public

Type:

int

[ Top ]

$iCount = 0

[line 101]

Index of current token

Access: public

Type:

int

[ Top ]

$iIndent = 0

[line 106]

Level of indent

Access: public

Type:

int

[ Top ]

$iIndentNumber = 4

[line 111]

Chars for indentation

Access: public

Type:

int

[ Top ]

$iParenthesis = 0

[line 121]

Level of parenthesis nesting

Access: public

Type:

int

[ Top ]

$iVerbose = false

[line 126]

Level of verbosity (debug)

Access: public

Type:

int

[ Top ]

$sIndentChar = ' '

[line 146]

Type of whitespace to use for indent

Access: public

Type:

string

[ Top ]

$sInputFile = ''

[line 131]

Name of input file

Access: public

Type:

string

[ Top ]

$sNewLine = "\n"

[line 141]

Type of newline

Access: public

Type:

string

[ Top ]

$sOutputFile = ''

[line 136]

Name of output file

Access: public

Type:

string

[ Top ]

__construct (Constructor) [line 184]

PHP_Beautifier __construct(
)

Constructor.

Assing values to $aControlStructures,$aControlStructuresEnd, $aTokenFunctions

[ Top ]

add [line 972]

void add(
string
$token)

Add a string to the output

Access: public

Parameters:

string $token —

[ Top ]

addFilter [line 341]

bool addFilter(
string
$sFilter, [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
Tutorial: Filter.pkg
Throws: Exception
Access: public

Parameters:

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

[ Top ]

addFilterDirectory [line 302]

void addFilterDirectory(
string
$sDir)

Add a filter directory

Throws: Exception
Access: public

Parameters:

string $sDir — path to directory

[ Top ]

addIndent [line 1001]

void addIndent(
)

Add Indent to the output

[ Top ]

addNewLine [line 991]

void addNewLine(
)

Add a new line to the output

Access: public

[ Top ]

get [line 904]

string get(
)

Returns the beutified code

Access: public

[ Top ]

getControlParenthesis [line 932]

mixed getControlParenthesis(
[int
$iRet = 0])

Get the token constant for the current Parenthesis

Return: token constant or false
Access: public

Parameters:

int $iRet — current token -'x'

[ Top ]

getControlSeq [line 922]

void getControlSeq(
[int
$iRet = 0])

Get the token constant for the current control construct

Access: public

Parameters:

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

[ Top ]

getFilesByPattern [line 449]

array getFilesByPattern(
string
$sDir, string
$sFilePattern, [bool
$bRecursive = false])

Search, inside a dir, for a file pattern, using regular expresion Example:

PHP_Beautifier_Common::getFilesByPattern('.','*.php',true);

Search recursively for all the files with php extensions in the current dir

Return: path to files
Access: public

Parameters:

string	`$sDir`	—	path to a dir
string	`$sFilePattern`	—	file pattern
bool	`$bRecursive`	—	recursive?

[ Top ]

getFilterDescription [line 364]

mixed getFilterDescription(
string
$sFilter)

Return the Filter Description

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

Parameters:

string $sFilter — name of the filter

[ Top ]

getFilterDirectories [line 315]

array getFilterDirectories(
)

Return an array with all the Filter Dirs

Return: List of Filter Directories
Access: public

[ Top ]

getFilterList [line 404]

array getFilterList(
)

Get the names of the loaded filters

Return: list of Filters
Access: public

[ Top ]

getFilterListTotal [line 415]

array getFilterListTotal(
)

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

Return: list of Filters
Access: public

[ Top ]

getIndentChar [line 470]

void getIndentChar(
)

Access: public

[ Top ]

getIndentNumber [line 474]

void getIndentNumber(
)

Access: public

[ Top ]

getMode [line 961]

bool getMode(
string
$sKey)

Get the state of a mode

Access: public

Parameters:

string $sKey — name of the mode

[ Top ]

getNewLine [line 478]

void getNewLine(
)

Access: public

[ Top ]

getNextTokenConstant [line 1132]

int getNextTokenConstant(
[int
$iPrev = 1])

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

Access: public

Parameters:

int $iPrev — current+x token

[ Top ]

getNextTokenContent [line 1142]

int getNextTokenContent(
[int
$iNext = 1])

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

Access: public

Parameters:

int $iNext — current+x token

[ Top ]

getPreviousTokenConstant [line 1112]

int getPreviousTokenConstant(
[int
$iPrev = 1])

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

Access: public

Parameters:

int $iPrev — current-x token

[ Top ]

getPreviousTokenContent [line 1122]

string getPreviousTokenContent(
[int
$iPrev = 1])

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

Access: public

Parameters:

int $iPrev — current-x token

[ Top ]

getSetting [line 913]

mixed getSetting(
string
$sKey)

Returns the value of a settings

Return: Value of the settings or false
Access: public

Parameters:

string $sKey — Name of the setting

[ Top ]

getToken [line 1166]

array &getToken(
int
$iIndex)

Get a token by number

Access: public

Parameters:

int $iIndex — number of the token

[ Top ]

getTokenAssoc [line 659]

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
Access: public

Parameters:

int $iIndex — token number

[ Top ]

getTokenAssocText [line 668]

mixed getTokenAssocText(
int
$iIndex)

Get the output for specified token

Return: string or false if token doesn't exists
Access: public

Parameters:

int $iIndex — token number

[ Top ]

getTokenFunction [line 697]

mixed getTokenFunction(
mixed
$sTokenType)

Return the function for a token constant or string.

Return: name of function or false
Access: public

Parameters:

mixed $sTokenType — token constant or string

[ Top ]

isNextTokenConstant [line 1082]

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

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

Access: public

Parameters:

mixed	`$mValue`	—	int (constant) or array
	`$iPrev`	—

[ Top ]

isNextTokenContent [line 1097]

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

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

Access: public

Parameters:

mixed	`$mValue`	—	string (content) or array
	`$iPrev`	—

[ Top ]

isPreviousTokenConstant [line 1052]

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

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

Access: public

Parameters:

mixed	`$mValue`	—	int (constant) or array
	`$iPrev`	—

[ Top ]

isPreviousTokenContent [line 1067]

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

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

Access: public

Parameters:

mixed	`$mValue`	—	string (content) or array
	`$iPrev`	—

[ Top ]

normalizeDir [line 324]

string normalizeDir(
string
$sDir)

Normalize reference to directories

Return: normalized path to directory
Access: public

Parameters:

string $sDir — path to directory

[ Top ]

pop [line 981]

void pop(
[int
$iReps = 1])

Delete the last added outputs

Deprecated:
Access: public

Parameters:

int $iReps — number of outputs to drop

[ Top ]

process [line 598]

bool process(
)

Process the string or file to beautify

Return: true on success
Throws: Exception
Access: public

[ Top ]

removeWhitespace [line 1150]

void removeWhitespace(
)

Remove all whitespace from the previous tag

[ Top ]

replaceTokenAssoc [line 681]

bool replaceTokenAssoc(
int
$iIndex, string
$sText)

Replace the output for specified token

Access: public

Parameters:

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

[ Top ]

save [line 541]

void save(
[string
$sFile = null])

Save the beautified code to output file

See: setOutputFile();
Throws: Exception
Access: public

Parameters:

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

[ Top ]

setBeautify [line 889]

void setBeautify(
bool
$sFlag)

Set the Beautifier on or off

Access: public

Parameters:

bool $sFlag —

[ Top ]

setIndentChar [line 486]

void setIndentChar(
string
$sChar)

Character used for indentation

Access: public

Parameters:

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

[ Top ]

setIndentNumber [line 494]

void setIndentNumber(
int
$iIndentNumber)

Number of characters for indentation

Access: public

Parameters:

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

[ Top ]

setInputFile [line 511]

void setInputFile(
string
$sFile)

Set the file for beautify

Throws: Exception
Access: public

Parameters:

string $sFile — path to file

[ Top ]

setInputString [line 566]

void setInputString(
string
$sText)

Set a string for beautify

Access: public

Parameters:

string $sText — Must be preceded by open tag

[ Top ]

setMode [line 944]

void setMode(
string
$sKey)

Set a mode to true

Access: public

Parameters:

string $sKey — name of the mode

[ Top ]

setNewLine [line 502]

void setNewLine(
string
$sNewLine)

Character used as a new line

Access: public

Parameters:

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

[ Top ]

setOutputFile [line 531]

void setOutputFile(
string
$sFile)

Set the output file for beautify

Access: public

Parameters:

string $sFile — path to file

[ Top ]

show [line 896]

void show(
)

Show the beautified code

Access: public

[ Top ]

unsetMode [line 952]

void unsetMode(
string
$sKey)

Set a mode to false

Access: public

Parameters:

string $sKey — name of the mode

[ Top ]

Class: PHP_Beautifier

Class Overview

Author(s):

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

Class Variables

$aAssocs = array()

$aModes = array()

$aOut = array()

$aSettings = array()

$aTokenFunctions = array()

$aTokens = array()

$currentWhitespace = ''

$iArray = 0

$iCount = 0

$iIndent = 0

$iIndentNumber = 4

$iParenthesis = 0

$iVerbose = false

$sIndentChar = ' '

$sInputFile = ''

$sNewLine = "\n"

$sOutputFile = ''

Method Detail

__construct (Constructor) [line 184]

add [line 972]

Parameters:

addFilter [line 341]

Parameters:

addFilterDirectory [line 302]

Parameters:

addIndent [line 1001]

addNewLine [line 991]

get [line 904]

getControlParenthesis [line 932]

Parameters:

getControlSeq [line 922]

Parameters:

getFilesByPattern [line 449]

Parameters:

getFilterDescription [line 364]

Parameters:

getFilterDirectories [line 315]

getFilterList [line 404]

getFilterListTotal [line 415]

getIndentChar [line 470]

getIndentNumber [line 474]

getMode [line 961]

Parameters:

getNewLine [line 478]

getNextTokenConstant [line 1132]

Parameters:

getNextTokenContent [line 1142]

Parameters:

getPreviousTokenConstant [line 1112]

Parameters:

getPreviousTokenContent [line 1122]

Parameters:

getSetting [line 913]

Parameters:

getToken [line 1166]

Parameters:

getTokenAssoc [line 659]

Parameters:

getTokenAssocText [line 668]

Parameters:

getTokenFunction [line 697]

Parameters:

isNextTokenConstant [line 1082]

Parameters:

isNextTokenContent [line 1097]

Parameters:

isPreviousTokenConstant [line 1052]

Parameters:

isPreviousTokenContent [line 1067]

Parameters:

normalizeDir [line 324]