Class parserTocInlineTag

Description

Represents [email protected]} for table of contents generation in tutorials

Located in /phpDocumentor/InlineTags.inc (line 923)

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag
Variable Summary
 string $inlinetype
Method Summary
 parserTocInlineTag parserTocInlineTag ()
 mixed Convert (Converter &$c)
 void setPath (string $path)
 void setTOC (array $toc)
Variables
string $inlinetype = 'toc' (line 929)

always 'toc'


Redefinition of:
parserInlineTag::$inlinetype
the name of the inline tag (like link)

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$type

Inherited from parserBase

parserBase::$value
Methods
Constructor parserTocInlineTag (line 956)

constructor

parserTocInlineTag parserTocInlineTag ()
Convert (line 1015)

converter method

 array(
    'tagname' => string name of tag,
    'link'    => tutorialLink to the tutorial,
    'id'      => converter specific tutorial ID from
                     Converter::getTutorialId()
    'title'   => title of the tutorial)
and returns the results as the table of contents

mixed Convert (Converter &$c)
setPath (line 990)

set the path

void setPath (string $path)
  • string $path: the path
setTOC (line 978)

set the TOC

void setTOC (array $toc)

Inherited Methods

Inherited From parserInlineTag

 parserInlineTag::parserInlineTag()
 parserInlineTag::getString()
 parserInlineTag::Strlen()

Inherited From parserBase

 parserBase::getType()
 parserBase::getValue()
 parserBase::setValue()

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