Class: parserPage

Source Location: /phpDocumentor/ParserData.inc

Class Overview [line 59]


Variables

Constants

Methods


Inherited Variables

Inherited Constants

Inherited Methods



Class Details

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

Tags:

[ Top ]


Class Variables

$category =  'default'

[line 97]

Type: string

Overrides:

[ Top ]

$file =  ''

[line 76]

filename.ext (no path)

Type: string

Overrides:

[ Top ]

$id =  ''

[line 71]

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

Type: string

Overrides:

[ Top ]

$modDate =  ''

[line 115]

not implemented yet

file modification date, will be used for makefiles

Type: string

Overrides:

[ Top ]

$name =  ''

[line 86]

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

Type: string

Overrides:

[ Top ]

$origName =  ''

[line 93]

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

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

Type: string

Overrides:

[ Top ]

$package =  'default'

[line 101]

Type: string

Overrides:

[ Top ]

$packageOutput =  false

[line 132]

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

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

Tags:

Type: mixed

Overrides:

[ Top ]

$parserVersion =  PHPDOCUMENTOR_VER

[line 109]

Type: string

Overrides:

[ Top ]

$path =  ''

[line 119]

Tags:

  • var - full path this page represents

Type: string

Overrides:

[ Top ]

$source = array()

[line 124]

Tokenized source code of the file

Type: array

Overrides:

[ Top ]

$sourceLocation =  ''

[line 81]

relative source location

Type: string

Overrides:

[ Top ]

$subpackage =  ''

[line 105]

Type: string

Overrides:

[ Top ]

$type =  'page'

[line 66]

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

  1. phpDocumentor_get_class($blah== 'parserBlah'

Type: string

Overrides:

[ Top ]


Class Methods

parserPage

parserPage parserPage( )

[line 139]

sets package to default package

Tags:

Parameters:

[ Top ]

getFile

string|bool getFile( )

[line 188]

gets the file name

Tags:

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

Parameters:

[ Top ]

getName

string getName( )

[line 273]

gets the name

Tags:

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

Parameters:

[ Top ]

getPackageOutput

array getPackageOutput( )

[line 247]

gets the package output array

Tags:

Parameters:

[ Top ]

getParseData

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:

[ Top ]

getPath

string getPath( )

[line 219]

gets the path

Tags:

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

Parameters:

[ Top ]

getSourceLocation

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

[ Top ]

getType

string getType( )

[line 150]

gets the tag type

Tags:

  • return - always "page"

Parameters:

[ Top ]

setFile

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

[ Top ]

setName

void setName( string $name)

[line 261]

sets the name

Tags:

Parameters:

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

[ Top ]

setPackageOutput

void setPackageOutput( array $packages)

[line 236]

loads the package output array

Tags:

Parameters:

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

[ Top ]

setPath

void setPath( string $path)

[line 203]

sets the path to the file

Parameters:

  • string $path - full path to file

[ Top ]

setSource

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

[ Top ]

setSourceLocation

void setSourceLocation( string $source)

[line 288]

sets the source location

Parameters:

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

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:08:14 -0600 by phpDocumentor 1.4.4