Class: parserVar

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

Class Overview

parserBase
   |
   --parserElement
      |
      --parserVar

Author(s):

Greg Beaver <cellog at php.net>

Version:

$Id$

Copyright:

2002-2008 Gregory Beaver

Variables

$class
$type

Methods

Inherited Variables

Class: parserElement

parserElement::$conflicts
parserElement::$docblock
parserElement::$endlinenumber
parserElement::$file
parserElement::$linenumber
parserElement::$name
parserElement::$path

Class: parserBase

parserBase::$value

Inherited Methods

Class: parserElement

parserElement::getEndLineNumber()
parserElement::getFile()
parserElement::getLineNumber()
parserElement::getName()
parserElement::getPackage()
parserElement::getPath()
parserElement::setDocBlock()
parserElement::setEndLineNumber(): Sets the ending line number of elements
parserElement::setFile()
parserElement::setLineNumber(): Set starting line number
parserElement::setName()
parserElement::setPath()

Class: parserBase

parserBase::getType(): gets the type
parserBase::getValue(): gets the value
parserBase::setValue(): sets the given value

Class Details

[line 1422]

Author: Greg Beaver <cellog@php.net>
Version: $Id$
Copyright: 2002-2008 Gregory Beaver
Since: 1.0rc1

[ Top ]

Class Variables

$class = ''

[line 1430]

Var: class that contains this var

Type:

string

[ Top ]

$type = 'var'

[line 1428]

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

Var: always 'var'

Type:	string
Overrides:	Array

[ Top ]

Method Detail

parserVar (Constructor) [line 1437]

parserVar parserVar(
string
$class)

Parameters:

string $class —

[ Top ]

getClass [line 1446]

string getClass(
)

Retrieve the class name

Return: Class name that this var belongs to

[ Top ]

getLink [line 1475]

mixed getLink(
Converter
$c, [string
$text = false], [
$returnobj = false])

quick way to link to this element

Return: converter-specific link to this var

Parameters:

Converter	`$c`	—
string	`$text`	—	text to display for the link or false for default text
	`$returnobj`	—

[ Top ]

getModifiers [line 1455]

array getModifiers(
)

Return a list of access modifiers (static/private/etc.)

[ Top ]

getOverrides [line 1488]

mixed getOverrides(
Converter
&$c)

Return: parserVar representing var this var overrides from the parent class, or false if none

Parameters:

Converter &$c —

[ Top ]

getOverridingVars [line 1547]

array getOverridingVars(
Converter
&$c)

Return: an array of parserVars from ALL child classes that override this var
Usedby: Converter::getFormattedDescVars()

Parameters:

Converter &$c —

[ Top ]

getOverridingVarsForClass [line 1559]

array getOverridingVarsForClass(
Converter
&$c, parserClass
&$class)

Return: an array of parserVars from ALL child classes that override this var in the given class

Parameters:

Converter	`&$c`	—
parserClass	`&$class`	—

[ Top ]

setModifiers [line 1464]

string setModifiers(

$m)

Return name of the class that contains this method

Parameters:

$m —

[ Top ]