Class: parserTutorialInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 278]

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

Variables

Constants

Methods


Inherited Methods

Class: parserInlineTag

parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag::getString()
always gets an empty string
parserInlineTag::Strlen()
get length of the tag

Class: parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value


Class Details

Represents inline links to external tutorial documentation

Tags:

[ Top ]


Class Variables


Class Methods

parserTutorialInlineTag

parserTutorialInlineTag parserTutorialInlineTag( string $link, string $text)

[line 286]

constructor

Parameters:

[ Top ]

Convert

mixed Convert( Converter &$c)

[line 302]

convert part of the tag

Tags:

  • return - returns the converted link or false if not converted successfully
  • todo - CS cleanup - rename to convert for camelCase rule

Overrides parserLinkInlineTag::Convert() (calls the output conversion)

Parameters:

  • Converter &$c - converter used to change the abstract link into text for display

[ Top ]


Class Constants


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