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

• list_functions: List functions (0 or 1). Default:1
• list_classes: List classes (0 or 1). Default:1

• author: Claudio Bustos <cdx@users.sourceforge.com>
• version: Release: @package_version@
• copyright: 2004-2010 Claudio Bustos
• link: http://beautifyphp.sourceforge.net
• link: http://pear.php.net/package/PHP_Beautifier
• todo: List functions inside classes as methods
• license: PHP License 3.0

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

PHP_Beautifier_Filter
   |
   --PHP_Beautifier_Filter_ListClassFunction

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

Constructor __construct (line 66)

• access: public

PHP_Beautifier_Filter_ListClassFunction __construct (PHP_Beautifier $oBeaut, [ $aSettings = array()])

• PHP_Beautifier $oBeaut
• $aSettings

---

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()

Inherited Constants

Inherited from PHP_Beautifier_Filter

PHP_Beautifier_Filter::BYPASS