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

Class: parserPage

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/ParserData.inc

Class Overview


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


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

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


[ Top ]


Class Variables

$category =  'default'

[line 97]


Type:   string


[ Top ]

$file =  ''

[line 76]

filename.ext (no path)

Type:   string


[ Top ]

$id =  ''

[line 71]

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

Type:   string


[ Top ]

$modDate =  ''

[line 115]

not implemented yet

file modification date, will be used for makefiles


Type:   string


[ Top ]

$name =  ''

[line 86]

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

Type:   string


[ Top ]

$origName =  ''

[line 93]

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

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


Type:   string


[ Top ]

$package =  'default'

[line 101]


Type:   string


[ Top ]

$packageOutput =  false

[line 132]

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

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


Type:   mixed


[ Top ]

$parserVersion =  PHPDOCUMENTOR_VER

[line 109]


Type:   string


[ Top ]

$path =  ''

[line 119]

  • Var: full path this page represents

Type:   string


[ Top ]

$source = array()

[line 124]

Tokenized source code of the file

Type:   array


[ Top ]

$sourceLocation =  ''

[line 81]

relative source location

Type:   string


[ Top ]

$subpackage =  ''

[line 105]


Type:   string


[ 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


[ Top ]



Method Detail

parserPage (Constructor)   [line 139]

parserPage parserPage( )

sets package to default package

[ Top ]

getFile   [line 188]

string|bool getFile( )

gets the file name
  • Return: filename.ext or @name alias, or FALSE if it's not set

[ Top ]

getName   [line 273]

string getName( )

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

[ Top ]

getPackageOutput   [line 247]

array getPackageOutput( )

gets the package output array

[ Top ]

getParseData   [line 333]

bool 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 219]

string getPath( )

gets the path
  • Return: fully delimited path (OS-dependent format), or FALSE if it's not set

[ Top ]

getSourceLocation   [line 307]

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

gets the source location
  • 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   [line 150]

string getType( )

gets the tag type
  • Return: always "page"

[ Top ]

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

[ Top ]

setName   [line 261]

void setName( string $name)

sets the name

Parameters:

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

[ Top ]

setPackageOutput   [line 236]

void setPackageOutput( array $packages)

loads the package output array

Parameters:

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

[ Top ]

setPath   [line 203]

void setPath( string $path)

sets the path to the file

Parameters:

string   $path     full path to file

[ Top ]

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

[ Top ]

setSourceLocation   [line 288]

void setSourceLocation( string $source)

sets the source location

Parameters:

string   $source     path of this file relative to program root

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:26 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.