Class: parserTutorialInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserTutorialInlineTag

Class Overview

Represents inline links to external tutorial documentation

Located in /phpDocumentor/InlineTags.inc [line 278]

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag
         |
         --parserTutorialInlineTag

Author(s):

Gregory Beaver <[email protected]>

API Tags:

See:

parserStringWithInlineTags

Information Tags:

Tutorial:	inline {@tutorial}
Version:	Release: @VER@
Copyright:	2002-2008 Gregory Beaver
Link:	http://www.phpdoc.org
Link:	http://pear.php.net/PhpDocumentor
Todo:	CS cleanup - change classname to PhpDocumentor_*
Todo:	CS cleanup - change package to PhpDocumentor
License:	LGPL

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserLinkInlineTag

parserLinkInlineTag::$linktext

Inherited From parserInlineTag

parserInlineTag::$inlinetype

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserLinkInlineTag

parserLinkInlineTag::parserLinkInlineTag()

sets up the tag

parserLinkInlineTag::Convert()

calls the output conversion

parserLinkInlineTag::ConvertPart()

convert part of the tag

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()

sets up the tag

parserInlineTag::getString()

always gets an empty string

parserInlineTag::Strlen()

get length of the tag

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Method Summary

parserTutorialInlineTag	parserTutorialInlineTag()	constructor
mixed	Convert()	convert part of the tag

[ Top ]

Properties

Methods

Constructor parserTutorialInlineTag [line 286]

parserTutorialInlineTag parserTutorialInlineTag(
string
$link, string
$text 
)

constructor

Parameters:

string	$link:	stored in $value, see parserBase::$value
string	$text:	see $linktext

[ Top ]

Convert [line 302]

mixed Convert(
Converter
&$c 
)

convert part of the tag

Parameters:

Converter

&$c:

converter used to change the abstract link into text for display

API Tags:

Return:

returns the converted link or false if not converted successfully

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

Redefinition of:

parserLinkInlineTag::Convert(): calls the output conversion

[ Top ]

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

	phpDocumentor InlineTags

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