Class: parserTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserTag

Class Overview

used to represent standard tags like @access, etc.

This class is aware of inline tags, and will automatically handle them using inherited functions

Located in /phpDocumentor/DocBlockTags.inc [line 62]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag

Author(s):

Greg Beaver <[email protected]>

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
Todo:	CS cleanup - change classname to PhpDocumentor_*
Since:	1.0rc1
License:	LGPL

Properties

Methods

[ Top ]

Descendants

Child Class	Description
parserNameTag	This class represents the @name tag
parserAccessTag	This class represents the @access tag
parserReturnTag	represents the "@return" tag
parserLinkTag	represents the "@link" tag
parserFileSourceTag	represents "@filesource"

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()

equivalent to the . operator ($a = $b . $c)

parserStringWithInlineTags::Convert()

Use to convert the string to a real string with all inline tags parsed and linked

parserStringWithInlineTags::getString()

return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)

parserStringWithInlineTags::hasInlineTag()

Determine whether the string contains any inline tags

parserStringWithInlineTags::setSource()

Pass source code to any {@source} tags contained within the string for later conversion.

parserStringWithInlineTags::trimmedStrlen()

equivalent to trim(strlen($string))

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string	$keyword	tag name (see, access, etc.)
string	$type	Type is used by many functions to skip the hassle of

[ Top ]

Method Summary

parserTag	parserTag()	Set up the tag
string	Convert()	Perform the output conversion on this parserTag using the output converter that is passed in
string	getString()	Returns the text minus any inline tags
void	HandleEvent()	Called by the parserDescParser when processing a description.

[ Top ]

Properties

string $keyword = '' [line 74]

tag name (see, access, etc.)

Redefined in descendants as:

parserNameTag::$keyword : tag name
parserAccessTag::$keyword : tag name
parserReturnTag::$keyword : always 'return'
parserPropertyTag::$keyword : always 'property'
parserPropertyReadTag::$keyword : always 'property-read'
parserPropertyWriteTag::$keyword : always 'property-write'
parserMethodTag::$keyword : always 'method'
parserVarTag::$keyword : always 'var'
parserParamTag::$keyword : always 'param'
parserStaticvarTag::$keyword : always 'staticvar'
parserLinkTag::$keyword : always 'link'
parserSeeTag::$keyword : always 'see'
parserUsesTag::$keyword : Always "uses"
parserUsedByTag::$keyword : Always "usedby"
parserTutorialTag::$keyword : Always "tutorial"
parserLicenseTag::$keyword : always 'license'
parserFileSourceTag::$keyword : Always "filesource"
parserExampleTag::$keyword : always "example"

[ Top ]

string $type = '_tag' [line 69]

Type is used by many functions to skip the hassle of

if phpDocumentor_get_class($blah) == 'parserBlah' always '_tag'

Redefinition of:

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

[ Top ]

Methods

Constructor parserTag [line 86]

parserTag parserTag(
string
$keyword, parserStringWithInlineTags
$value, [boolean
$noparse = false] 
)

Set up the tag

function parserTag($keyword, $value, $noparse = false)
{
$this->keyword = $keyword;
if (!$noparse) {
$parser = new parserDescParser;
$parser->subscribe('*', $this);
$parser->parse($value->value, true, 'parserstringwithinlinetags');
} else {
$this->value = $value;
}
}

Parameters:

string	$keyword:	tag name
parserStringWithInlineTags	$value:	tag value
boolean	$noparse:	whether to parse the $value for html tags

[ Top ]

Convert [line 108]

string Convert(
Converter
&$converter 
)

Perform the output conversion on this parserTag using the output converter that is passed in

Parameters:

Converter

&$converter:

the converter object

API Tags:

See:

Converter

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

Redefinition of:

parserStringWithInlineTags::Convert(): Use to convert the string to a real string with all inline tags parsed and linked

Redefined in descendants as:

parserNameTag::Convert() : process this tag through the given output converter
parserAccessTag::Convert() : process this tag through the given output converter
parserReturnTag::Convert() : process this tag through the given output converter (sets up the $converted_returnType)
parserSeeTag::Convert() : process this tag through the given output converter
parserUsesTag::Convert() : Return a link to documentation for other element, and description of how it is used
parserUsedByTag::Convert() : process this tag through the given output converter
parserTutorialTag::Convert() : process this tag through the given output converter
parserFileSourceTag::Convert() : Return a link to the highlighted source and generate the source

[ Top ]

getString [line 173]

string getString(
)

Returns the text minus any inline tags

API Tags:

Return:	the text minus any inline tags
See:	parserStringWithInlineTags::getString()

Redefinition of:

parserStringWithInlineTags::getString(): return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)

Redefined in descendants as:

parserAccessTag::getString() : No inline tags are possible, returns 'public', 'protected' or 'private'

[ Top ]

HandleEvent [line 162]

void HandleEvent(
integer
$a, array
$desc 
)

Called by the parserDescParser when processing a description.

Parameters:

integer	$a:	not used
array	$desc:	array of parserStringWithInlineTags representing paragraphs in the tag description

API Tags:

See:

parserTag::parserTag()

Information Tags:

Todo:

CS cleanup - rename to handleEvent for camelCase rule

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:18:15 -0600 by phpDocumentor 1.4.4

	phpDocumentor DocBlockTags

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