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

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



		
				Author(s):
		
		
		
Information Tags:
Version:  Release: @[email protected]
Copyright:  2002-2008 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
Todo:  CS cleanup - change classname to PhpDocumentor_*
Since:  1.0rc1
License:  LGPL

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|bool   getFile()   gets the file name
string   getName()   gets the name
array   getPackageOutput()   gets the package output array
bool   getParseData()   Not implemented in this version
string   getPath()   gets the path
string   getSourceLocation()   gets the source location
string   getType()   gets the tag type
void   setFile()   Sets the name to display in documentation (can be an alias set with @name)
void   setName()   sets the name
void   setPackageOutput()   loads the package output array
void   setPath()   sets the path to the file
void   setSource()   Sets the source code of the file for highlighting.
void   setSourceLocation()   sets the source location

[ Top ]
Properties
string   $category = 'default' [line 97]

[ Top ]
string   $file = '' [line 76]

filename.ext (no path)


[ Top ]
string   $id = '' [line 71]

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


[ Top ]
string   $modDate = '' [line 115]

not implemented yet

file modification date, will be used for makefiles


[ Top ]
string   $name = '' [line 86]

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


[ Top ]
string   $origName = '' [line 93]

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

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


[ Top ]
string   $package = 'default' [line 101]

[ Top ]
mixed   $packageOutput = false [line 132]

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

[ Top ]
string   $path = '' [line 119]

[ Top ]
array   $source = array() [line 124]

Tokenized source code of the file


[ Top ]
string   $sourceLocation = '' [line 81]

relative source location


[ Top ]
string   $subpackage = '' [line 105]

[ Top ]
string   $type = 'page' [line 66]

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

  1. phpDocumentor_get_class($blah== 'parserBlah'


[ Top ]
Methods
Constructor parserPage  [line 139]

  parserPage parserPage( )

sets package to default package


API Tags:
Global:  string $phpDocumentor_DefaultPackageName: default package name


[ Top ]
getFile  [line 188]

  string|bool getFile( )

gets the file name


API Tags:
Return:  filename.ext or @name alias, or FALSE if it's not set


[ Top ]
getName  [line 273]

  string getName( )

gets the name


API Tags:
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


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


[ Top ]
getParseData  [line 333]

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

  string getPath( )

gets the path


API Tags:
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

Parameters:
Converter   $c:  the output converter
bool   $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

Information Tags:
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.

[ Top ]
getType  [line 150]

  string getType( )

gets the tag type


API Tags:
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()

API Tags:
See:  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,...)

API Tags:
See:  phpDocumentor_IntermediateParser::$packageoutput


[ 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 Tue, 06 Dec 2011 07:20:39 -0600 by phpDocumentor 1.4.4