Class parserTutorialTag

(line 995)



Located in File: /phpDocumentor/

represents "@tutorial"

This is exactly like @see except that it only links to tutorials

Class Variables

string $keyword

$keyword = 'tutorial' (line 1001)

Data type : string

Overrides: Array

Always "tutorial"

Class Constants


Method Detail

string|bool Convert (Converter &$converter)

Method Convert (line 1012)

string|bool Convert( Converter &$converter)

Overrides : parserSeeTag::Convert() process this tag through the given output converter

process this tag through the given output converter


  • Converter &$converter: the output converter


Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserSeeTag

parserSeeTag::parserSeeTag() - sets up the see tag

parserSeeTag::Convert() - process this tag through the given output converter

Inherited From Class parserLinkTag

parserLinkTag::parserLinkTag() - sets up the link tag

Inherited From Class parserTag

parserTag::parserTag() - Set up the tag

parserTag::Convert() - Perform the output conversion on this parserTag using the output converter that is passed in

parserTag::getString() - Returns the text minus any inline tags

parserTag::HandleEvent() - Called by the parserDescParser when processing a description.

Inherited From Class 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 Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value

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