Docs For Class parserBase

Description

Base class for all elements

author: Gregory Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
link: http://pear.php.net/PhpDocumentor
link: http://www.phpdoc.org
todo: CS cleanup - change package to PhpDocumentor
abstract:
since: 1.0rc1
license: LGPL

Located in /phpDocumentor/ParserData.inc (line 710)

Direct descendents

Class	Description
parserInlineTag	Use this element to represent an {@inline tag} like {@link}
parserStringWithInlineTags	Used to represent strings that contain inline tags, so that they can be properly parsed at link time
parserElement	all elements except parserPackagePage descend from this abstract class

Variable Summary

string $type

mixed $value

Method Summary

string getType ()

mixed getValue ()

void setValue (mixed $value)

Variables

string $type = 'base' (line 717)

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

phpDocumentor_get_class($blah) == 'parserBlah'... always base

Redefined in descendants as:

parserInlineTag::$type : Element type
parserStringWithInlineTags::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'...
parserTag::$type : Type is used by many functions to skip the hassle of
parserPackagePage::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserTutorial::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserDesc::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserInclude::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserGlobal::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserFunction::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserMethod::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserClass::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserVar::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserConst::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'
parserDefine::$type : Type is used by many functions to skip the hassle of if phpDocumentor_get_class($blah) == 'parserBlah'

mixed $value = false (line 723)

set to different things by its descendants

abstract:

Redefined in descendants as:

parserStringWithInlineTags::$value : array of strings and parserInlineTags

Methods

getType (line 730)

gets the type

return: returns value of $type

string getType ()

getValue (line 752)

gets the value

return: get the value of this element (element-dependent)

mixed getValue ()

setValue (line 742)

sets the given value

void setValue (mixed $value)

mixed $value: set the value of this element