Class: parserPage

Source Location: /PhpDocumentor-1.4.0/phpDocumentor/ParserData.inc

Class Overview

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

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id: ParserData.inc,v 1.8 2007/04/24 21:27:43 ashnazg Exp $

Variables

Methods

Inherited Variables

Inherited Methods

Class Details

[line 47]
Contains information about a PHP file, used to group procedural elements together.

Author: Greg Beaver <cellog@php.net>
Version: $Id: ParserData.inc,v 1.8 2007/04/24 21:27:43 ashnazg Exp $
Since: 1.0rc1

[ Top ]

Class Variables

$category = 'default'

[line 85]

Type:

string

[ Top ]

$file = ''

[line 64]

filename.ext (no path)

Type:

string

[ Top ]

$id = ''

[line 59]

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

Type:

string

[ Top ]

$modDate = ''

[line 103]

not implemented yet

file modification date, will be used for makefiles

Type:

string

[ Top ]

$name = ''

[line 74]

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

Type:

string

[ Top ]

$origName = ''

[line 81]

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

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

Type:

string

[ Top ]

$package = 'default'

[line 89]

Type:

string

[ Top ]

$packageOutput = false

[line 119]

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

Type:

mixed

[ Top ]

$parserVersion = PHPDOCUMENTOR_VER

[line 97]

Type:

string

[ Top ]

$path = ''

[line 107]

Var: full path this page represents

Type:

string

[ Top ]

$source = array()

[line 112]

Tokenized source code of the file

Type:

array

[ Top ]

$sourceLocation = ''

[line 69]

relative source location

Type:

string

[ Top ]

$subpackage = ''

[line 93]

Type:

string

[ Top ]

$type = 'page'

[line 54]

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

phpDocumentor_get_class($blah) == 'parserBlah'

Type:

string

[ Top ]

Method Detail

parserPage (Constructor) [line 125]

parserPage parserPage(
)

sets package to default package

Global: string $phpDocumentor_DefaultPackageName: default package name

[ Top ]

getFile [line 163]

string getFile(
)

Return: filename.ext or @name alias

[ Top ]

getName [line 221]

string getName(
)

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

[ Top ]

getPackageOutput [line 203]

array getPackageOutput(
)

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

[ Top ]

getParseData [line 273]

boolean getParseData(
)

Not implemented in this version

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(
)

Return: fully delimited path (OS-dependent format)

[ Top ]

getSourceLocation [line 244]

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

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`	—
boolean	`$pearize`	—	if this parameter is true, it will truncate the source location to the subdirectory of pear

[ Top ]

getType [line 134]

string getType(
)

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)

See: Parser::parse()

Parameters:

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

[ Top ]

setPackageOutput [line 194]

void setPackageOutput(
array
$packages)

See: phpDocumentor_IntermediateParser::$packageoutput

Parameters:

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

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