[line 59]
Contains information about a PHP file, used to group procedural elements together.
Tags:
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
todo: CS cleanup - change package to PhpDocumentor
todo: CS cleanup - change classname to PhpDocumentor_*
since: 1.0rc1
$category = 'default'
[line 97]
$file = ''
[line 76]
filename.ext (no path)
$id = ''
[line 71]
not implemented in this version, will be used to link xml output pages
$modDate = ''
[line 115]
not implemented yet
file modification date, will be used for makefiles
$name = ''
[line 86]
phpdoc-safe name (only letters, numbers and _)
$origName = ''
[line 93]
original phpdoc-safe name (only letters, numbers and _)
This fixes [ 1391432 ] Too many underscores in include links.
$package = 'default'
[line 101]
$packageOutput = false
[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
$parserVersion = PHPDOCUMENTOR_VER
[line 109]
$path = ''
[line 119]
Tags:
var: full path this page represents
$source = array()
[line 124]
Tokenized source code of the file
$sourceLocation = ''
[line 81]
relative source location
$subpackage = ''
[line 105]
$type = 'page'
[line 66]
Type is used by many functions to skip the hassle of if
constructor parserPage [line 139]
sets package to default package
Tags:
method getFile [line 188]
gets the file name
Tags:
return: filename.ext or @name alias, or FALSE if it's not set
method getName [line 273]
gets the name
Tags:
return: phpdoc-safe name (only _, numbers and letters), or FALSE if it's not set
method getPackageOutput [line 247]
array getPackageOutput(
)
gets the package output array
Tags:
return: array of packages (package1,package2,...)
method 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
method getPath [line 219]
gets the path
Tags:
return: fully delimited path (OS-dependent format), or FALSE if it's not set
method getSourceLocation [line 307]
string getSourceLocation(
Converter
$c, [bool
$pearize = false])
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:
bool
$pearize
if this parameter is true, it will truncate the source location to the subdirectory of pear
method getType [line 150]
method setFile [line 177]
void setFile(
string
$file)
Sets the name to display in documentation (can be an alias set with @name)
Parameters:
string
$file
the file name
method setName [line 261]
void setName(
string
$name)
sets the name
Tags:
Parameters:
string
$name
phpdoc-safe name (only _, numbers and letters) set by Parser::parse()
method setPackageOutput [line 236]
void setPackageOutput(
array
$packages)
loads the package output array
Tags:
Parameters:
array
$packages
array of packages to display in documentation (package1,package2,...)
method setPath [line 203]
void setPath(
string
$path)
sets the path to the file
Parameters:
string
$path
full path to file
method setSource [line 165]
void setSource(
string|array
$source)
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
method setSourceLocation [line 288]
void setSourceLocation(
string
$source)
sets the source location
Parameters:
string
$source
path of this file relative to program root