Description
Located in File: /phpDocumentor/ParserData.inc
Contains information about a PHP file, used to group procedural elements together.
- author: - Gregory Beaver <[email protected]>
- version: - Release: @VER@
- copyright: - 2002-2008 Gregory Beaver
- link: - http://pear.php.net/PhpDocumentor
- link: - http://www.phpdoc.org
- todo: - CS cleanup - change package to PhpDocumentor
- todo: - CS cleanup - change classname to PhpDocumentor_*
- since: - 1.0rc1
- license: - LGPL
Class Variables
Summary:
string
$category
string
$file
string
$id
string
$modDate
string
$name
string
$origName
string
$package
mixed
$packageOutput
string
$parserVersion
string
$path
array
$source
string
$sourceLocation
string
$subpackage
string
$type
$category = 'default' (line 97)
Data type : string
$file = '' (line 76)
Data type : string
filename.ext (no path)
$id = '' (line 71)
Data type : string
not implemented in this version, will be used to link xml output pages
$modDate = '' (line 115)
Data type : string
not implemented yet
file modification date, will be used for makefiles
$name = '' (line 86)
Data type : string
phpdoc-safe name (only letters, numbers and _)
$origName = '' (line 93)
Data type : string
original phpdoc-safe name (only letters, numbers and _)
This fixes [ 1391432 ] Too many underscores in include links.
$package = 'default' (line 101)
Data type : string
$packageOutput = false (line 132)
Data type : mixed
Used to limit output, contains contents of --packageoutput commandline.
Does not increase parsing time. Use --ignore for that
- var: - either false or an array of packages
- see: - phpDocumentor_IntermediateParser::$packageoutput, Converter::$package_output
$parserVersion = PHPDOCUMENTOR_VER (line 109)
Data type : string
$path = '' (line 119)
Data type : string
- var: - full path this page represents
$source = array() (line 124)
Data type : array
Tokenized source code of the file
$sourceLocation = '' (line 81)
Data type : string
relative source location
$subpackage = '' (line 105)
Data type : string
$type = 'page' (line 66)
Data type : string
Type is used by many functions to skip the hassle of if
Class Constants
Summary:Method Detail
Summary:
parserPage
parserPage
()
string|bool
getFile
()
string
getName
()
array
getPackageOutput
()
bool
getParseData
()
string
getPath
()
string
getType
()
Constructor parserPage (line 139)
parserPage parserPage( )
sets package to default package
Info
- global - string $phpDocumentor_DefaultPackageName: default package name
Method getFile (line 188)
string|bool getFile( )
gets the file name
Info
- return - filename.ext or @name alias, or FALSE if it's not set
Method getName (line 273)
string getName( )
gets the name
Info
- 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
Info
- return - array of packages (package1,package2,...)
- see - phpDocumentor_IntermediateParser::$packageoutput
Method getParseData (line 333)
bool getParseData( )
Not implemented in this version
Info
- return - tell the parser whether to parse the file, otherwise this function will retrieve the parsed data from external file
Method getPath (line 219)
string getPath( )
gets the path
Info
- 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
Parameters
- Converter $c: the output converter
- bool $pearize: if this parameter is true, it will truncate the source location to the subdirectory of pear
Info
- 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.
Method getType (line 150)
string getType( )
gets the tag type
Info
- return - always "page"
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
Info
Method setName (line 261)
void setName( string $name)
sets the name
Parameters
- string $name: phpdoc-safe name (only _, numbers and letters) set by Parser::parse()
Info
- see - Parser::parse()
Method setPackageOutput (line 236)
void setPackageOutput( array $packages)
loads the package output array
Parameters
- array $packages: array of packages to display in documentation (package1,package2,...)
Info
Method setPath (line 203)
void setPath( string $path)
sets the path to the file
Parameters
- string $path: full path to file
Info
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
Info
Method setSourceLocation (line 288)
void setSourceLocation( string $source)
sets the source location
Parameters
- string $source: path of this file relative to program root