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

Class: parserPage

Source Location: /PhpDocumentor-1.2.0beta2/phpDocumentor/ParserData.inc

Class Overview




Author(s):

Version:

  • $Id: ParserData.inc,v 1.72 2003/01/17 07:01:29 CelloG Exp $

Variables

Methods


Inherited Variables

Inherited Methods


Class Details

[line 17]


[ Top ]


Class Variables

$file =  ''

[line 33]

filename.ext (no path)

Type:   string


[ Top ]

$id =  ''

[line 28]

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

Type:   string


[ Top ]

$modDate =  ''

[line 61]

not implemented yet

file modification date, will be used for makefiles


Type:   string


[ Top ]

$name =  ''

[line 43]

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

Type:   string


[ Top ]

$package =  'default'

[line 47]


Type:   string


[ Top ]

$packageOutput =  false

[line 71]

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


Type:   string


[ Top ]

$path =  ''

[line 65]

  • Var: full path this page represents

Type:   string


[ Top ]

$sourceLocation =  ''

[line 38]

relative source location

Type:   string


[ Top ]

$subpackage =  ''

[line 51]


Type:   string


[ Top ]

$type =  'page'

[line 23]

Type is used by many functions to skip the hassle of if get_class($blah) == 'parserBlah'

Type:   string


[ Top ]



Method Detail

parserPage (Constructor)   [line 77]

parserPage parserPage( )

sets package to default package
  • Global: string $phpDocumentor_DefaultPackageName: default package name

[ Top ]

getFile   [line 103]

string getFile( )

  • Return: filename.ext or @name alias

[ Top ]

getName   [line 160]

string getName( )

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

[ Top ]

getPackageOutput   [line 143]

array getPackageOutput( )


[ Top ]

getParseData   [line 204]

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

string getPath( )

  • Return: fully delimited path (OS-dependent format)

[ Top ]

getSourceLocation   [line 180]

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

  • Return: path of this file relative to program root

Parameters:

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

[ Top ]

getType   [line 86]

string getType( )

  • Return: always "page"

[ Top ]

setFile   [line 95]

void setFile( string $file)

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

Parameters:

string   $file     

[ Top ]

setName   [line 152]

void setName( string $name)


Parameters:

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

[ Top ]

setPackageOutput   [line 134]

void setPackageOutput( array $packages)


Parameters:

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

[ Top ]

setPath   [line 112]

void setPath( string $path)


Parameters:

string   $path     full path to file

[ Top ]

setSourceLocation   [line 169]

void setSourceLocation( string $source)


Parameters:

string   $source     path of this file relative to program root

[ Top ]


Documentation generated on Fri, 30 Apr 2004 22:10:20 +0200 by phpDocumentor 1.2.3. PEAR Logo Copyright © PHP Group 2004.