Class: PHP_Beautifier_Filter_ListClassFunction

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

Class Overview

PHP_Beautifier_Filter
   |
   --PHP_Beautifier_Filter_ListClassFunction

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

Author(s):

Claudio Bustos <cdx at users.sourceforge.com>

Version:

Release: 0.1.14

Copyright:

2004-2006 Claudio Bustos

Inherited Variables

Class: PHP_Beautifier_Filter

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 45]
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

Author: Claudio Bustos <cdx@users.sourceforge.com>
Version: Release: 0.1.14
Copyright: 2004-2006 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

[ Top ]

Class Variables

$aFilterTokenFunctions = array(
        T_CLASS => 't_class',
        T_FUNCTION => 't_function',
        T_COMMENT => 't_comment',
        T_OPEN_TAG => 't_open_tag'
    )

[line 47]

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

$aSettings = array(
        'list_functions' => true,
        'list_classes' => true
    )

[line 57]

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

$sDescription = 'Create a list of functions and classes in the script'

[line 61]

Access: protected

Type:	mixed
Overrides:	Array

[ Top ]

Method Detail

__construct (Constructor) [line 66]

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

Access: public

Overrides 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.)

Parameters:

PHP_Beautifier	`$oBeaut`	—
	`$aSettings`	—

[ Top ]

includeInList [line 83]

void includeInList(

$sTag, 
$sValue)

Parameters:

	`$sTag`	—
	`$sValue`	—

[ Top ]

postProcess [line 112]

void postProcess(
)

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

[ Top ]

t_class [line 87]

void t_class(

$sTag)

Parameters:

$sTag —

[ Top ]

t_doc_comment [line 98]

void t_doc_comment(

$sTag)

Parameters:

$sTag —

[ Top ]

t_function [line 72]

void t_function(

$sTag)

Parameters:

$sTag —

[ Top ]

t_open_tag [line 105]

void t_open_tag(

$sTag)

Parameters:

$sTag —

[ Top ]

Class: PHP_Beautifier_Filter_ListClassFunction

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: PHP_Beautifier_Filter

Inherited Methods

Class: PHP_Beautifier_Filter

Class Details

Class Variables

$aFilterTokenFunctions = array( T_CLASS => 't_class', T_FUNCTION => 't_function', T_COMMENT => 't_comment', T_OPEN_TAG => 't_open_tag' )

$aSettings = array( 'list_functions' => true, 'list_classes' => true )

$sDescription = 'Create a list of functions and classes in the script'

Method Detail

__construct (Constructor) [line 66]

Parameters:

includeInList [line 83]

Parameters:

postProcess [line 112]

t_class [line 87]

Parameters:

t_doc_comment [line 98]

Parameters:

t_function [line 72]

Parameters:

t_open_tag [line 105]

Parameters:

$aFilterTokenFunctions = array(
T_CLASS => 't_class',
T_FUNCTION => 't_function',
T_COMMENT => 't_comment',
T_OPEN_TAG => 't_open_tag'
)

$aSettings = array(
'list_functions' => true,
'list_classes' => true
)