Class: parserBase

Source Location: /phpDocumentor/ParserData.inc

Class parserBase

Class Overview

Base class for all elements

Located in /phpDocumentor/ParserData.inc [line 710]

Author(s):

Gregory Beaver <[email protected]>

API Tags:

Abstract:

Information Tags:

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
Since:	1.0rc1
License:	LGPL

Properties

$type
$value

Methods

[ Top ]

Descendants

Child 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

[ Top ]

Property Summary

string	$type	Type is used by many functions to skip the hassle of if
mixed	$value	set to different things by its descendants

[ Top ]

Method Summary

string	getType()	gets the type
mixed	getValue()	gets the value
void	setValue()	sets the given value

[ Top ]

Properties

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'

[ Top ]

mixed $value = false [line 723]

set to different things by its descendants

API Tags:

Abstract:

Redefined in descendants as:

parserStringWithInlineTags::$value : array of strings and parserInlineTags

[ Top ]

Methods

getType [line 730]

string getType(
)

gets the type

API Tags:

Return:

returns value of $type

[ Top ]

getValue [line 752]

mixed getValue(
)

gets the value

API Tags:

Return:

get the value of this element (element-dependent)

[ Top ]

setValue [line 742]

void setValue(
mixed
$value 
)

sets the given value

Parameters:

mixed

$value:

set the value of this element

[ Top ]

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

	phpDocumentor ParserData

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