Docs For Class PHP_Beautifier

addSettingDefinition [line 97]

void addSettingDefinition(
string
$sSetting, mixed
$sType, mixed
$sDescription)

Add a setting definition

Parameters:

string $sSetting —

[ Top ]

getDescription [line 223]

void getDescription(
)

[ Top ]

getName [line 107]

void getName(
)

return @string

[ Top ]

getSetting [line 144]

mixed getSetting(
string
$sSetting)

Get a setting of the Filter

Return: value of setting or false

Parameters:

string $sSetting — name of setting

[ Top ]

handleToken [line 171]

bool handleToken(
array
$token)

Function called from PHP_Beautifier::process() to process the tokens.

If the received token is one of the keys of $aFilterTokenFunctions a function with the same name of the value of that key is called. If the method doesn't exists, __call() is called, and return PHP_Beautifier_Filter::BYPASS. PHP_Beautifier, now, call the next Filter is its list. If the method exists, it can return true or PHP_Beautifier_Filter::BYPASS.

Return: true if the token is processed, false bypass to the next Filter
See: PHP_Beautifier::process()

Parameters:

array $token — token

[ Top ]

off [line 135]

void off(
)

Turn off the Filter Use inside the code to beautify Ex.


1     ...some code...
2      // ArrayNested->off()
3      ...other code ...

[ Top ]

on [line 121]

void on(
)

Turn on the Filter Use inside the code to beautify Ex.


1     ...some code...
2      // ArrayNested->on()
3      ...other code ...

[ Top ]

postProcess [line 214]

void postProcess(
)

Called from PHP_Beautifier::process() at the end of processing

The post-process must be made in PHP_Beautifier::$aOut

[ Top ]

setSetting [line 153]

void setSetting(
string
$sSetting, mixed
$sValue)

Set a value of a Setting

Parameters:

string	`$sSetting`	—	name of setting
mixed	`$sValue`	—	value of setting

[ Top ]

Class: PHP_Beautifier_Filter

Class Overview

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

addSettingDefinition [line 97]

Parameters:

getDescription [line 223]

getName [line 107]

getSetting [line 144]

Parameters:

handleToken [line 171]

Parameters:

off [line 135]

on [line 121]

postProcess [line 214]

setSetting [line 153]

Parameters: