PHP_Beautifier
[ class tree: PHP_Beautifier ] [ index: PHP_Beautifier ] [ all elements ]
Packages:
XML
PHP_Beautifier
XML_Parser


Classes:
Batch
   PHP_Beautifier_Batch
Exception_PHP_Beautifier_Filter
PHP_Beautifier
PHP_Beautifier_Common
PHP_Beautifier_Decorator
Filter
   PHP_Beautifier_Filter
Files:
Beautifier.php
Common.php
Decorator.php
Exception.php

subpackage Batch
Batch.php

subpackage Filter
Filter.php

subpackage StreamWrapper
StreamWrapper.php

Element index for package PHP_Beautifier

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ n ] [ o ] [ p ] [ r ] [ s ] [ u ] [ w ]

a

add
in file Beautifier.php, method PHP_Beautifier::add()
    Add a string to the output
addFilter
in file Beautifier.php, method PHP_Beautifier::addFilter()
    Add a Filter to the Beautifier The first argument is the name of the file of the Filter.
addFilterDirectory
in file Beautifier.php, method PHP_Beautifier::addFilterDirectory()
    Add a filter directory
addFilterFile
in file Beautifier.php, method PHP_Beautifier::addFilterFile()
    Add a new filter to the processor.
addFilterObject
in file Beautifier.php, method PHP_Beautifier::addFilterObject()
addIndent
in file Beautifier.php, method PHP_Beautifier::addIndent()
    Add Indent to the output
addNewLine
in file Beautifier.php, method PHP_Beautifier::addNewLine()
    Add a new line to the output
addNewLineIndent
in file Beautifier.php, method PHP_Beautifier::addNewLineIndent()
    Add a new line and a indent to output
addSettingDefinition
in file Filter.php, method PHP_Beautifier_Filter::addSettingDefinition() (subpackage: Filter)
    Add a setting definition
top

b

Beautifier.php
procedural page Beautifier.php
Batch.php
procedural page Batch.php (subpackage: Batch)
top

c

controlToken
in file Beautifier.php, method PHP_Beautifier::controlToken()
    Assign value for some variables with the information of the token
controlTokenPost
in file Beautifier.php, method PHP_Beautifier::controlTokenPost()
    Assign value for some variables with the information of the token, after processing
createDir
in file Common.php, method PHP_Beautifier_Common::createDir()
    Create a dir for a file path
Common.php
procedural page Common.php
callBeautifier
in file Batch.php, method PHP_Beautifier_Batch::callBeautifier() (subpackage: Batch)
    Allows subclass of PHP_Beautifier_Batch_Engine call methods of $oBeaut
top

d

decIndent
in file Beautifier.php, method PHP_Beautifier::decIndent()
    Decrements the indent.
Decorator.php
procedural page Decorator.php
top

e

Exception_PHP_Beautifier_Filter
in file Exception.php, class Exception_PHP_Beautifier_Filter
    Exception for Filters
Exception.php
procedural page Exception.php
top

f

Filter.php
procedural page Filter.php (subpackage: Filter)
top

g

get
in file Beautifier.php, method PHP_Beautifier::get()
    Returns the beutified code
getControlParenthesis
in file Beautifier.php, method PHP_Beautifier::getControlParenthesis()
    Get the token constant for the current Parenthesis
getControlSeq
in file Beautifier.php, method PHP_Beautifier::getControlSeq()
    Get the token constant for the current control construct
getFilesByGlob
in file Common.php, method PHP_Beautifier_Common::getFilesByGlob()
    Search, inside a dir, for a file pattern using glob(* and ?)
getFilesByPattern
in file Common.php, method PHP_Beautifier_Common::getFilesByPattern()
    Search, inside a dir, for a file pattern, using regular expresion Example:
getFilterDescription
in file Beautifier.php, method PHP_Beautifier::getFilterDescription()
    Return the Filter Description
getFilterDirectories
in file Beautifier.php, method PHP_Beautifier::getFilterDirectories()
    Return an array with all the Filter Dirs
getFilterList
in file Beautifier.php, method PHP_Beautifier::getFilterList()
    Get the names of the loaded filters
getFilterListTotal
in file Beautifier.php, method PHP_Beautifier::getFilterListTotal()
    Get the list of all available Filters in all the include Dirs
getFilterList_FilterName
in file Beautifier.php, method PHP_Beautifier::getFilterList_FilterName()
    Receive a path to a filter and replace it with the name of filter
getIndentChar
in file Beautifier.php, method PHP_Beautifier::getIndentChar()
getIndentNumber
in file Beautifier.php, method PHP_Beautifier::getIndentNumber()
getLog
in file Common.php, method PHP_Beautifier_Common::getLog()
    Get a Log_composite object for PHP_Beautifier
getMode
in file Beautifier.php, method PHP_Beautifier::getMode()
    Get the state of a mode
getNewLine
in file Beautifier.php, method PHP_Beautifier::getNewLine()
getNextToken
in file Beautifier.php, method PHP_Beautifier::getNextToken()
    Get the 'x' significant (non whitespace) next token
getNextTokenConstant
in file Beautifier.php, method PHP_Beautifier::getNextTokenConstant()
    Get the 'x' significant (non whitespace) next token constant
getNextTokenContent
in file Beautifier.php, method PHP_Beautifier::getNextTokenContent()
    Get the 'x' significant (non whitespace) next token text
getPreviousToken
in file Beautifier.php, method PHP_Beautifier::getPreviousToken()
    Get the 'x' significant (non whitespace)previous token
getPreviousTokenConstant
in file Beautifier.php, method PHP_Beautifier::getPreviousTokenConstant()
    Get the 'x' significant (non whitespace) previous token constant
getPreviousTokenContent
in file Beautifier.php, method PHP_Beautifier::getPreviousTokenContent()
    Get the 'x' significant (non whitespace) previous token text
getPreviousWhitespace
in file Beautifier.php, method PHP_Beautifier::getPreviousWhitespace()
    Return the whitespace previous to current token
getSavePath
in file Common.php, method PHP_Beautifier_Common::getSavePath()
    Return an array with the paths to save for an array of files
getSetting
in file Beautifier.php, method PHP_Beautifier::getSetting()
    Returns the value of a settings
getToken
in file Beautifier.php, method PHP_Beautifier::getToken()
    Get a token by number
getTokenAssoc
in file Beautifier.php, method PHP_Beautifier::getTokenAssoc()
    Get the reference to $aOut, based on the number of the token
getTokenAssocText
in file Beautifier.php, method PHP_Beautifier::getTokenAssocText()
    Get the output for the specified token
getTokenFunction
in file Beautifier.php, method PHP_Beautifier::getTokenFunction()
    Return the function for a token constant or string.
get
in file Batch.php, method PHP_Beautifier_Batch::get() (subpackage: Batch)
    Return a string with the content of the file(s)
getBatchEngine
in file Batch.php, method PHP_Beautifier_Batch::getBatchEngine() (subpackage: Batch)
getInputFiles
in file Batch.php, method PHP_Beautifier_Batch::getInputFiles() (subpackage: Batch)
getOutputPath
in file Batch.php, method PHP_Beautifier_Batch::getOutputPath() (subpackage: Batch)
getDescription
in file Filter.php, method PHP_Beautifier_Filter::getDescription() (subpackage: Filter)
getName
in file Filter.php, method PHP_Beautifier_Filter::getName() (subpackage: Filter)
    return @string
getSetting
in file Filter.php, method PHP_Beautifier_Filter::getSetting() (subpackage: Filter)
    Get a setting of the Filter
top

h

handleToken
in file Filter.php, method PHP_Beautifier_Filter::handleToken() (subpackage: Filter)
    Function called from PHP_Beautifier::process() to process the tokens.
top

i

incIndent
in file Beautifier.php, method PHP_Beautifier::incIndent()
    Increments the indent in X chars.
isNextTokenConstant
in file Beautifier.php, method PHP_Beautifier::isNextTokenConstant()
    Return true if any of the constant defined in param 1 is the next 'x' content
isNextTokenContent
in file Beautifier.php, method PHP_Beautifier::isNextTokenContent()
    Return true if any of the content defined is param 1 is the next 'x' content
isPreviousTokenConstant
in file Beautifier.php, method PHP_Beautifier::isPreviousTokenConstant()
    Return true if any of the constant defined is param 1 is the previous 'x' constant
isPreviousTokenContent
in file Beautifier.php, method PHP_Beautifier::isPreviousTokenContent()
    Return true if any of the content defined is param 1 is the previous 'x' content
top

n

normalizeDir
in file Common.php, method PHP_Beautifier_Common::normalizeDir()
    Normalize reference to directories
top

o

off
in file Filter.php, method PHP_Beautifier_Filter::off() (subpackage: Filter)
    Turn off the Filter Use inside the code to beautify Ex.
on
in file Filter.php, method PHP_Beautifier_Filter::on() (subpackage: Filter)
    Turn on the Filter Use inside the code to beautify Ex.
top

p

PHP_Beautifier
in file Beautifier.php, class PHP_Beautifier
    PHP_Beautifier
PHP_Beautifier_Common
in file Common.php, class PHP_Beautifier_Common
    PHP_Beautifier_Common
PHP_Beautifier_Decorator
in file Decorator.php, class PHP_Beautifier_Decorator
    PHP_Beautifier_Decorator.
pop
in file Beautifier.php, method PHP_Beautifier::pop()
    Delete the last added output(s)
popControlParenthesis
in file Beautifier.php, method PHP_Beautifier::popControlParenthesis()
    Pop the last Control instruction for parenthesis from the stack
popControlSeq
in file Beautifier.php, method PHP_Beautifier::popControlSeq()
    Pop a control construct from the stack
process
in file Common.php, function process()
    Process the file(s) or string
process
in file Beautifier.php, method PHP_Beautifier::process()
    Process the string or file to beautify
processCallback
in file Beautifier.php, method PHP_Beautifier::processCallback()
    Process a callback from the code to beautify
pushControlParenthesis
in file Beautifier.php, method PHP_Beautifier::pushControlParenthesis()
    Push a new Control Instruction on the stack
pushControlSeq
in file Beautifier.php, method PHP_Beautifier::pushControlSeq()
    Push a control construct to the stack
PHP_Beautifier_Batch
in file Batch.php, class PHP_Beautifier_Batch (subpackage: Batch)
    Adds functionality to handle multiple files.
process
in file Batch.php, method PHP_Beautifier_Batch::process() (subpackage: Batch)
    Create the real references to files
PHP_Beautifier_Filter
in file Filter.php, class PHP_Beautifier_Filter (subpackage: Filter)
    PHP_Beautifier_Filter
postProcess
in file Filter.php, method PHP_Beautifier_Filter::postProcess() (subpackage: Filter)
    Called from PHP_Beautifier::process() at the end of processing
top

r

removeFilter
in file Beautifier.php, method PHP_Beautifier::removeFilter()
    Removes a Filter
removeWhitespace
in file Beautifier.php, method PHP_Beautifier::removeWhitespace()
    Remove all whitespace from the previous tag
replaceTokenAssoc
in file Beautifier.php, method PHP_Beautifier::replaceTokenAssoc()
    Replace the output for specified token
resetProperties
in file Beautifier.php, method PHP_Beautifier::resetProperties()
    Reset all properties
top

s

save
in file Beautifier.php, method PHP_Beautifier::save()
    Save the beautified code to output file
setBeautify
in file Beautifier.php, method PHP_Beautifier::setBeautify()
    Set the Beautifier on or off
setFileType
in file Beautifier.php, method PHP_Beautifier::setFileType()
    Set the filetype
setIndentChar
in file Beautifier.php, method PHP_Beautifier::setIndentChar()
    Character used for indentation
setIndentNumber
in file Beautifier.php, method PHP_Beautifier::setIndentNumber()
    Number of characters for indentation
setInputFile
in file Beautifier.php, method PHP_Beautifier::setInputFile()
    Set the file for beautify
setInputString
in file Beautifier.php, method PHP_Beautifier::setInputString()
    Set a string for beautify
setMode
in file Beautifier.php, method PHP_Beautifier::setMode()
    Set a mode to true
setNewLine
in file Beautifier.php, method PHP_Beautifier::setNewLine()
    Character used as a new line
setOutputFile
in file Beautifier.php, method PHP_Beautifier::setOutputFile()
    Set the output file for beautify
show
in file Beautifier.php, method PHP_Beautifier::show()
    Show the beautified code
startLog
in file Beautifier.php, method PHP_Beautifier::startLog()
    Start the log for debug
save
in file Batch.php, method PHP_Beautifier_Batch::save() (subpackage: Batch)
    Save the beautified sources to file(s)
setCompress
in file Batch.php, method PHP_Beautifier_Batch::setCompress() (subpackage: Batch)
    Set compression on/off
setInputFile
in file Batch.php, method PHP_Beautifier_Batch::setInputFile() (subpackage: Batch)
    Set the input(s) files
setInputFilePost
in file Batch.php, method PHP_Beautifier_Batch::setInputFilePost() (subpackage: Batch)
setOutputFile
in file Batch.php, method PHP_Beautifier_Batch::setOutputFile() (subpackage: Batch)
    Set the output file
setOutputFilePost
in file Batch.php, method PHP_Beautifier_Batch::setOutputFilePost() (subpackage: Batch)
setRecursive
in file Batch.php, method PHP_Beautifier_Batch::setRecursive() (subpackage: Batch)
    Set recursive search for files in dirs on
show
in file Batch.php, method PHP_Beautifier_Batch::show() (subpackage: Batch)
setSetting
in file Filter.php, method PHP_Beautifier_Filter::setSetting() (subpackage: Filter)
    Set a value of a Setting
StreamWrapper.php
procedural page StreamWrapper.php (subpackage: StreamWrapper)
stream_open
in file StreamWrapper.php, function stream_open() (subpackage: StreamWrapper)
    Interface for StreamWrapper Read the documentation for streams wrappers on php manual.
top

u

unsetMode
in file Beautifier.php, method PHP_Beautifier::unsetMode()
    Set a mode to false
top

w

wsToString
in file Common.php, method PHP_Beautifier_Common::wsToString()
    Transform whitespaces into its representation
top
Documentation generated on Mon, 11 Apr 2005 15:11:08 -0400 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.