PHP_Beautifier
[ class tree: PHP_Beautifier ] [ index: PHP_Beautifier ] [ all elements ]
Packages:
PHP_Beautifier
apidoc


Classes:
Filter
   PHP_Beautifier_Filter
   PHP_Beautifier_Filter_ArrayNested
   PHP_Beautifier_Filter_Default
   PHP_Beautifier_Filter_IndentStyles
   PHP_Beautifier_Filter_ListClassFunction
   PHP_Beautifier_Filter_Lowercase
   PHP_Beautifier_Filter_NewLines
   PHP_Beautifier_Filter_Pear
   PHP_Beautifier_Filter_phpBB
Batch
   PHP_Beautifier_Batch
   PHP_Beautifier_Batch_Output
   PHP_Beautifier_Batch_Output_Directory
   PHP_Beautifier_Batch_Output_DirectoryBz2
   PHP_Beautifier_Batch_Output_DirectoryGz
   PHP_Beautifier_Batch_Output_DirectoryTar
   PHP_Beautifier_Batch_Output_Files
   PHP_Beautifier_Batch_Output_FilesBz2
   PHP_Beautifier_Batch_Output_FilesGz
   PHP_Beautifier_Batch_Output_FilesTar
Exception_PHP_Beautifier_Filter
PHP_Beautifier
PHP_Beautifier_Common
PHP_Beautifier_Decorator
StreamWrapper
   PHP_Beautifier_StreamWrapper_Tarz
Files:
Beautifier.php
Common.php
Decorator.php
example_array.php
example_html.php
example_lowercase.php
example_main.php
example_pear.php
Exception.php
run_me.php

subpackage Batch
Batch.php
Directory.php
DirectoryBz2.php
DirectoryGz.php
DirectoryTar.php
Files.php
FilesBz2.php
FilesGz.php
FilesTar.php
Output.php

subpackage Filter
ArrayNested.filter.php
Default.filter.php
Filter.php
IndentStyles.filter.php
ListClassFunction.filter.php
Lowercase.filter.php
NewLines.filter.php
Pear.filter.php
phpBB.filter.php

subpackage StreamWrapper
StreamWrapper.php
Tarz.php

subpackage Tokenizer
Tokenizer.php

Class: PHP_Beautifier_Filter_Default

Source Location: /PHP_Beautifier-0.1.14/Beautifier/Filter/Default.filter.php

Class Overview

PHP_Beautifier_Filter
   |
   --PHP_Beautifier_Filter_Default

Default Filter: Handle all the tokens. Uses K & R style


Author(s):

Version:

  • Release: 0.1.14

Copyright:

  • 2004-2006 Claudio Bustos

Variables

Methods

Inherited Variables

Class: PHP_Beautifier_Filter

PHP_Beautifier_Filter::$aFilterTokenFunctions
PHP_Beautifier_Filter::$aSettings
PHP_Beautifier_Filter::$aSettingsDefinition
PHP_Beautifier_Filter::$aToken
PHP_Beautifier_Filter::$bOn
PHP_Beautifier_Filter::$oBeaut

Inherited Methods

Class: PHP_Beautifier_Filter

PHP_Beautifier_Filter::__construct()
Constructor If you need to overload this (for example, to create a definition for setting with addSettingDefinition() remember call the parent constructor.
PHP_Beautifier_Filter::addSettingDefinition()
Add a setting definition
PHP_Beautifier_Filter::getDescription()
PHP_Beautifier_Filter::getName()
return @string
PHP_Beautifier_Filter::getSetting()
Get a setting of the Filter
PHP_Beautifier_Filter::handleToken()
Function called from PHP_Beautifier::process() to process the tokens.
PHP_Beautifier_Filter::off()
Turn off the Filter Use inside the code to beautify Ex.
PHP_Beautifier_Filter::on()
Turn on the Filter Use inside the code to beautify Ex.
PHP_Beautifier_Filter::postProcess()
Called from PHP_Beautifier::process() at the end of processing
PHP_Beautifier_Filter::preProcess()
Called from PHP_Beautifier::process() at the beginning
PHP_Beautifier_Filter::setSetting()
Set a value of a Setting
PHP_Beautifier_Filter::__call()
PHP_Beautifier_Filter::__sleep()
PHP_Beautifier_Filter::__toString()

Class Details

[line 47]
Default Filter: Handle all the tokens. Uses K & R style

This filters is loaded by default in PHP_Beautifier. Can handle all the tokens. If one of the tokens doesn't have a function, is added wihout modification (See __call()) The most important modifications are:

  • All the statements inside control structures, functions and class are indented with K&R style 
    1.  function myFunction() {
      2. 

    2.      echo 'hi';
      3. 

    3.  }
      4.
  • All the comments in new lines are indented. In multi-line comments, all the lines are indented, too.
This class is final, so don't try to extend it!



[ Top ]

Class Variables

$sDescription =  'Default Filter for PHP_Beautifier'

[line 49]

  • Access: protected

Type:   mixed
Overrides:   Array


[ Top ]


Method Detail

comment_large   [line 225]

void comment_large( $sTag)


Parameters:

   $sTag   —   

[ Top ]

comment_short   [line 220]

void comment_short( $sTag)


Parameters:

   $sTag   —   

[ Top ]

off   [line 59]

void off( )

  • Access: public

Overrides PHP_Beautifier_Filter::off() (Turn off the Filter Use inside the code to beautify Ex.)
[ Top ]

t_access   [line 62]

void t_access( $sTag)

  • Access: public

Parameters:

   $sTag   —   

[ Top ]

t_array   [line 400]

void t_array( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_as   [line 168]

void t_as( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_assigment   [line 387]

void t_assigment( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_assigment_pre   [line 392]

void t_assigment_pre( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_break   [line 341]

void t_break( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_case   [line 102]

void t_case( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_clone   [line 397]

void t_clone( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_close_brace   [line 144]

void t_close_brace( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_close_tag   [line 84]

void t_close_tag( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_colon   [line 326]

void t_colon( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_comma   [line 292]

void t_comma( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_comment   [line 205]

void t_comment( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_constant_encapsed_string   [line 310]

void t_constant_encapsed_string( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_control   [line 98]

void t_control( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_default   [line 356]

void t_default( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_doc_comment   [line 180]

void t_doc_comment( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_dot   [line 297]

void t_dot( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_double_colon   [line 337]

void t_double_colon( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_else   [line 241]

void t_else( $sTag)

  • Uses: detect_colon_after_parenthesis

Parameters:

   $sTag   —   

[ Top ]

t_end_heredoc   [line 66]

void t_end_heredoc( $sTag)

  • Access: public

Parameters:

   $sTag   —   

[ Top ]

t_end_suffix   [line 360]

void t_end_suffix( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_equal   [line 278]

void t_equal( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_equal_sign   [line 382]

void t_equal_sign( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_extends   [line 367]

void t_extends( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_for   [line 288]

void t_for( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_implements   [line 372]

void t_implements( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_include   [line 302]

void t_include( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_instanceof   [line 377]

void t_instanceof( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_language_construct   [line 306]

void t_language_construct( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_logical   [line 283]

void t_logical( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_new   [line 173]

void t_new( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_object_operator   [line 408]

void t_object_operator( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_open_brace   [line 126]

void t_open_brace( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_open_tag   [line 71]

void t_open_tag( $sTag)

  • Access: public

Parameters:

   $sTag   —   

[ Top ]

t_operator   [line 413]

void t_operator( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_parenthesis_close   [line 115]

void t_parenthesis_close( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_parenthesis_open   [line 111]

void t_parenthesis_open( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_question   [line 321]

void t_question( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_semi_colon   [line 160]

void t_semi_colon( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_switch   [line 94]

void t_switch( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_variable   [line 314]

void t_variable( $sTag)


Parameters:

   $sTag   —   

[ Top ]

t_whitespace   [line 177]

void t_whitespace( $sTag)


Parameters:

   $sTag   —   

[ Top ]

__call   [line 50]

void __call( $sMethod, $aArgs)


Overrides PHP_Beautifier_Filter::__call() (parent method not documented)

Parameters:

   $sMethod   —   
   $aArgs   —   

[ Top ]
Documentation generated on Sun, 22 Jun 2008 05:00:21 -0400 by phpDocumentor 1.4.0. PEAR Logo Copyright © PHP Group 2004.