Class parserConst

Description
Variable Summary
 string $class
 string $type
Method Summary
 parserConst parserConst (string $class)
 string getClass ()
 mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])
Variables
string $class = '' (line 1586)
  • var: class that contains this var
string $type = 'const' (line 1584)

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

  • var: always 'const'

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

Inherited Variables

Inherited from parserElement

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

Inherited from parserBase

parserBase::$value
Methods
Constructor parserConst (line 1591)
parserConst parserConst (string $class)
  • string $class
getClass (line 1600)

Retrieve the class name

  • return: Class name that this var belongs to
string getClass ()
getLink (line 1611)

quick way to link to this element

  • return: converter-specific link to this var
mixed getLink (Converter $c, [string $text = false], [ $returnobj = false])
  • Converter $c
  • string $text: text to display for the link or false for default text
  • $returnobj

Inherited Methods

Inherited From parserElement

 parserElement::getEndLineNumber()
 parserElement::getFile()
 parserElement::getLineNumber()
 parserElement::getName()
 parserElement::getPackage()
 parserElement::getPath()
 parserElement::setDocBlock()
 parserElement::setEndLineNumber()
 parserElement::setFile()
 parserElement::setLineNumber()
 parserElement::setName()
 parserElement::setPath()

Inherited From parserBase

 parserBase::getType()
 parserBase::getValue()
 parserBase::setValue()

Documentation generated on Mon, 05 Dec 2011 21:06:21 -0600 by phpDocumentor 1.4.4