Class: parserPage

Source Location: /phpDocumentor/ParserData.inc

Class parserPage

Class Overview

Contains information about a PHP file, used to group procedural elements together.

Located in /phpDocumentor/ParserData.inc [line 47]

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserData.inc,v 1.6 2006/10/23 04:02:46 cellog Exp $
Since:	1.0rc1

Properties

Methods

[ Top ]

Property Summary

string	$category
string	$file	filename.ext (no path)
string	$id	not implemented in this version, will be used to link xml output pages
string	$modDate	not implemented yet
string	$name	phpdoc-safe name (only letters, numbers and _)
string	$origName	original phpdoc-safe name (only letters, numbers and _)
string	$package
mixed	$packageOutput	Used to limit output, contains contents of --packageoutput commandline.
string	$parserVersion
string	$path
array	$source	Tokenized source code of the file
string	$sourceLocation	relative source location
string	$subpackage
string	$type	Type is used by many functions to skip the hassle of if

[ Top ]

Method Summary

parserPage	parserPage()	sets package to default package
string	getFile()
string	getName()
array	getPackageOutput()
boolean	getParseData()	Not implemented in this version
string	getPath()
string	getSourceLocation()
string	getType()
void	setFile()	Sets the name to display in documentation (can be an alias set with @name)
void	setName()
void	setPackageOutput()
void	setPath()
void	setSource()	Sets the source code of the file for highlighting.
void	setSourceLocation()

[ Top ]

Properties

string $category = 'default' [line 85]

[ Top ]

string $file = '' [line 64]

filename.ext (no path)

[ Top ]

string $id = '' [line 59]

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

[ Top ]

string $modDate = '' [line 103]

not implemented yet

file modification date, will be used for makefiles

[ Top ]

string $name = '' [line 74]

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

[ Top ]

string $origName = '' [line 81]

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

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

[ Top ]

string $package = 'default' [line 89]

[ Top ]

mixed $packageOutput = false [line 119]

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

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

API Tags:

See:

phpDocumentor_IntermediateParser::$packageoutput, Converter::$package_output

[ Top ]

string $parserVersion = PHPDOCUMENTOR_VER [line 97]

[ Top ]

string $path = '' [line 107]

[ Top ]

array $source = array() [line 112]

Tokenized source code of the file

[ Top ]

string $sourceLocation = '' [line 69]

relative source location

[ Top ]

string $subpackage = '' [line 93]

[ Top ]

string $type = 'page' [line 54]

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

phpDocumentor_get_class($blah) == 'parserBlah'

[ Top ]

Methods

Constructor parserPage [line 125]

parserPage parserPage(
)

sets package to default package

API Tags:

Global:

string $phpDocumentor_DefaultPackageName: default package name

[ Top ]

getFile [line 163]

string getFile(
)

API Tags:

Return:

filename.ext or @name alias

[ Top ]

getName [line 221]

string getName(
)

API Tags:

Return:

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

[ Top ]

getPackageOutput [line 203]

array getPackageOutput(
)

API Tags:

Return:	array of packages (package1,package2,...)
See:	phpDocumentor_IntermediateParser::$packageoutput

[ Top ]

getParseData [line 265]

boolean getParseData(
)

Not implemented in this version

API Tags:

Return:

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

[ Top ]

getPath [line 184]

string getPath(
)

API Tags:

Return:

fully delimited path (OS-dependent format)

[ Top ]

getSourceLocation [line 241]

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

Parameters:

Converter	$c:
boolean	$pearize:	if this parameter is true, it will truncate the source location to the subdirectory of pear

API Tags:

Return:

path of this file relative to program root

[ Top ]

getType [line 134]

string getType(
)

API Tags:

Return:

always "page"

[ Top ]

setFile [line 155]

void setFile(
string
$file 
)

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

Parameters:

string

$file:

[ Top ]

setName [line 212]

void setName(
string
$name 
)

Parameters:

string

$name:

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

API Tags:

See:

Parser::parse()

[ Top ]

setPackageOutput [line 194]

void setPackageOutput(
array
$packages 
)

Parameters:

array

$packages:

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

API Tags:

See:

phpDocumentor_IntermediateParser::$packageoutput

[ Top ]

setPath [line 172]

void setPath(
string
$path 
)

Parameters:

string

$path:

full path to file

[ Top ]

setSource [line 146]

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:

[ Top ]

setSourceLocation [line 230]

void setSourceLocation(
string
$source 
)

Parameters:

string

$source:

path of this file relative to program root

[ Top ]

Documentation generated on Tue, 24 Oct 2006 09:24:45 -0500 by phpDocumentor 1.3.1

	phpDocumentor ParserData

[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]