Class PHP_Beautifier_Filter_ListClassFunction

Description

Create a list of functions and classes in the script By default, this Filter puts the list at the beggining of the script.

If you want it in another position, put a comment like that

 // Class and Function List
The script lookup for the string 'Class and Function List' in a comment and replace the entire comment with the list The settings are
  • list_functions: List functions (0 or 1). Default:1
  • list_classes: List classes (0 or 1). Default:1

Located in /Beautifier/Filter/ListClassFunction.filter.php (line 45)

PHP_Beautifier_Filter
   |
   --PHP_Beautifier_Filter_ListClassFunction
Variable Summary
Method Summary
 PHP_Beautifier_Filter_ListClassFunction __construct (PHP_Beautifier $oBeaut, [ $aSettings = array()])
 void includeInList ( $sTag,  $sValue)
 void postProcess ()
 void t_class ( $sTag)
 void t_doc_comment ( $sTag)
 void t_function ( $sTag)
 void t_open_tag ( $sTag)
Variables
mixed $aFilterTokenFunctions = array(
T_CLASS => 't_class',
T_FUNCTION => 't_function',
T_COMMENT => 't_comment',
T_OPEN_TAG => 't_open_tag'
)
(line 47)
  • access: protected

Redefinition of:
PHP_Beautifier_Filter::$aFilterTokenFunctions
Associative array of functions to use when some token are found
mixed $aSettings = array(
'list_functions' => true,
'list_classes' => true
)
(line 57)
  • access: protected

Redefinition of:
PHP_Beautifier_Filter::$aSettings
Settings for the Filter
mixed $sDescription = 'Create a list of functions and classes in the script' (line 61)
  • access: protected

Redefinition of:
PHP_Beautifier_Filter::$sDescription
Description of the Filter

Inherited Variables

Inherited from PHP_Beautifier_Filter

PHP_Beautifier_Filter::$aSettingsDefinition
PHP_Beautifier_Filter::$aToken
PHP_Beautifier_Filter::$bOn
PHP_Beautifier_Filter::$oBeaut
Methods
Constructor __construct (line 66)
  • access: public
PHP_Beautifier_Filter_ListClassFunction __construct (PHP_Beautifier $oBeaut, [ $aSettings = array()])

Redefinition of:
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.
includeInList (line 83)
void includeInList ( $sTag,  $sValue)
  • $sTag
  • $sValue
postProcess (line 112)
void postProcess ()

Redefinition of:
PHP_Beautifier_Filter::postProcess()
Called from PHP_Beautifier::process() at the end of processing
t_class (line 87)
void t_class ( $sTag)
  • $sTag
t_doc_comment (line 98)
void t_doc_comment ( $sTag)
  • $sTag
t_function (line 72)
void t_function ( $sTag)
  • $sTag
t_open_tag (line 105)
void t_open_tag ( $sTag)
  • $sTag

Inherited Methods

Inherited From PHP_Beautifier_Filter

 PHP_Beautifier_Filter::__construct()
 PHP_Beautifier_Filter::addSettingDefinition()
 PHP_Beautifier_Filter::getDescription()
 PHP_Beautifier_Filter::getName()
 PHP_Beautifier_Filter::getSetting()
 PHP_Beautifier_Filter::handleToken()
 PHP_Beautifier_Filter::off()
 PHP_Beautifier_Filter::on()
 PHP_Beautifier_Filter::postProcess()
 PHP_Beautifier_Filter::preProcess()
 PHP_Beautifier_Filter::setSetting()
 PHP_Beautifier_Filter::__call()
 PHP_Beautifier_Filter::__sleep()
 PHP_Beautifier_Filter::__toString()
Class Constants

Inherited Constants

Inherited from PHP_Beautifier_Filter

PHP_Beautifier_Filter::BYPASS

Documentation generated on Mon, 31 May 2010 16:16:08 -0400 by phpDocumentor 1.4.3