Class: parserVar

Source Location: /phpDocumentor/ParserElements.inc

Class parserVar

Class Overview

Located in /phpDocumentor/ParserElements.inc [line 1415]

parserBase
   |
   --parserElement
      |
      --parserVar

Author(s):

Greg Beaver <[email protected]>

Information Tags:

Version:	$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
Copyright:	2002-2008 Gregory Beaver
Since:	1.0rc1

Properties

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserElement

parserElement::$conflicts

parserElement::$docblock

parserElement::$endlinenumber

parserElement::$file

parserElement::$linenumber

parserElement::$name

parserElement::$path

Inherited From parserBase

parserBase::$value

Inherited From 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()

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

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

[ Top ]

Method Summary

parserVar	parserVar()
string	getClass()	Retrieve the class name
mixed	getLink()	quick way to link to this element
array	getModifiers()	Return a list of access modifiers (static/private/etc.)
mixed	getOverrides()
array	getOverridingVars()
array	getOverridingVarsForClass()
string	setModifiers()	Return name of the class that contains this method

[ Top ]

Properties

string $class = '' [line 1423]

[ Top ]

string $type = 'var' [line 1421]

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

Redefinition of:

parserBase::$type: Type is used by many functions to skip the hassle of if

[ Top ]

array $_modifiers [line 1425]

[ Top ]

Methods

Constructor parserVar [line 1430]

parserVar parserVar(
string
$class 
)

Parameters:

string

$class:

[ Top ]

getClass [line 1439]

string getClass(
)

Retrieve the class name

API Tags:

Return:

Class name that this var belongs to

[ Top ]

getLink [line 1468]

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

quick way to link to this element

Parameters:

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

API Tags:

Return:

converter-specific link to this var

[ Top ]

getModifiers [line 1448]

array getModifiers(
)

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

[ Top ]

getOverrides [line 1481]

mixed getOverrides(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

Return:

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

[ Top ]

getOverridingVars [line 1540]

array getOverridingVars(
Converter
&$c 
)

Parameters:

Converter

&$c:

API Tags:

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

[ Top ]

getOverridingVarsForClass [line 1552]

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

Parameters:

Converter	&$c:
parserClass	&$class:

API Tags:

Return:

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

[ Top ]

setModifiers [line 1457]

string setModifiers(

$m 
)

Return name of the class that contains this method

Parameters:

$m:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:20:50 -0600 by phpDocumentor 1.4.4

	phpDocumentor ParserElements

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