Class: parserVar

Source Location: /phpDocumentor/ParserElements.inc

Class Overview

parserBase
   |
   --parserElement
      |
      --parserVar

Author(s):

Greg Beaver <[email protected]>

Version:

$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $

Copyright:

2002-2008 Gregory Beaver

Variables

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

Tags:

author:	Greg Beaver <[email protected]>
version:	$Id: ParserElements.inc 289555 2009-10-12 03:52:03Z ashnazg $
copyright:	2002-2008 Gregory Beaver
since:	1.0rc1

[ Top ]

Class Variables

$class = ''

[line 1423]

Tags:

var:

class that contains this var

Type:

string

[ Top ]

$type = 'var'

[line 1421]

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

Tags:

var:

always 'var'

Type:	string
Overrides:	Array

[ Top ]

$_modifiers =

[line 1425]

Type:

array

[ Top ]

Class Methods

constructor parserVar [line 1430]

parserVar parserVar(
string
$class)

Parameters:

string

$class

[ Top ]

method getClass [line 1439]

string getClass(
)

Retrieve the class name

Tags:

return:

Class name that this var belongs to

[ Top ]

method getLink [line 1468]

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

quick way to link to this element

Tags:

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 ]

method getModifiers [line 1448]

array getModifiers(
)

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

[ Top ]

method getOverrides [line 1481]

mixed getOverrides(
Converter
&$c)

Tags:

return:

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

Parameters:

Converter

&$c

[ Top ]

method getOverridingVars [line 1540]

array getOverridingVars(
Converter
&$c)

Tags:

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

Parameters:

Converter

&$c

[ Top ]

method getOverridingVarsForClass [line 1552]

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

Tags:

return:

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

Parameters:

Converter	&$c
parserClass	&$class

[ Top ]

method setModifiers [line 1457]

string setModifiers(

$m)

Return name of the class that contains this method

Parameters:

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:14:36 -0600 by phpDocumentor 1.4.4