Class: parserPage

[line 97]

Type: string

Overrides:

[line 76]

filename.ext (no path)

Type: string

Overrides:

[line 71]

not implemented in this version, will be used to link xml output pages

Type: string

Overrides:

[line 115]

not implemented yet

file modification date, will be used for makefiles

Type: string

Overrides:

[line 86]

phpdoc-safe name (only letters, numbers and _)

Type: string

Overrides:

[line 93]

original phpdoc-safe name (only letters, numbers and _)

This fixes [ 1391432 ] Too many underscores in include links.

Type: string

Overrides:

[line 101]

Type: string

Overrides:

[line 132]

Used to limit output, contains contents of --packageoutput commandline.

Does not increase parsing time. Use --ignore for that

Tags:

• var - either false or an array of packages
• see - phpDocumentor_IntermediateParser::$packageoutput, Converter::$package_output

Type: mixed

Overrides:

[line 109]

Type: string

Overrides:

[line 119]

Tags:

• var - full path this page represents

Type: string

Overrides:

[line 124]

Tokenized source code of the file

Type: array

Overrides:

[line 81]

relative source location

Type: string

Overrides:

[line 105]

Type: string

Overrides:

[line 66]

Type is used by many functions to skip the hassle of if

1. phpDocumentor_get_class($blah) == 'parserBlah'

Type: string

Overrides:

parserPage parserPage( )

[line 139]

sets package to default package

Tags:

• global - string $phpDocumentor_DefaultPackageName: default package name

Parameters:

string|bool getFile( )

[line 188]

gets the file name

Tags:

• return - filename.ext or @name alias, or FALSE if it's not set

Parameters:

string getName( )

[line 273]

gets the name

Tags:

• return - phpdoc-safe name (only _, numbers and letters), or FALSE if it's not set

Parameters:

array getPackageOutput( )

[line 247]

gets the package output array

Tags:

• return - array of packages (package1,package2,...)
• see - phpDocumentor_IntermediateParser::$packageoutput

Parameters:

bool getParseData( )

[line 333]

Not implemented in this version

Tags:

• return - tell the parser whether to parse the file, otherwise this function will retrieve the parsed data from external file

Parameters:

string getPath( )

[line 219]

gets the path

Tags:

• return - fully delimited path (OS-dependent format), or FALSE if it's not set

Parameters:

string getSourceLocation( Converter $c, [bool $pearize = false])

[line 307]

gets the source location

Tags:

• return - path of this file relative to program root
• todo - determine if the str_replace in the 'pear/' ELSE branch should be removed (see Documentation/tests/bug1574043.php). It does NOT exist in the similar function parserClass->getSourceLocation() in ParserElements.inc.

Parameters:

• Converter $c - the output converter
• bool $pearize - if this parameter is true, it will truncate the source location to the subdirectory of pear

string getType( )

[line 150]

gets the tag type

Tags:

• return - always "page"

Parameters:

void setFile( string $file)

[line 177]

Sets the name to display in documentation (can be an alias set with @name)

Parameters:

• string $file - the file name

void setName( string $name)

[line 261]

sets the name

Tags:

• see - Parser::parse()

Parameters:

• string $name - phpdoc-safe name (only _, numbers and letters) set by Parser::parse()

void setPackageOutput( array $packages)

[line 236]

loads the package output array

Tags:

• see - phpDocumentor_IntermediateParser::$packageoutput

Parameters:

• array $packages - array of packages to display in documentation (package1,package2,...)

void setPath( string $path)

[line 203]

sets the path to the file

Parameters:

• string $path - full path to file

void setSource( string|array $source)

[line 165]

Sets the source code of the file for highlighting.

PHP 4.3.0+ passes an array of tokenizer tokens by line number. PHP 4.2.3- passes a string to be passed to http://www.php.net/highlight_string

Parameters:

• string|array $source - the token array/string

void setSourceLocation( string $source)

[line 288]

sets the source location

Parameters:

• string $source - path of this file relative to program root