Docs For Class parserTocInlineTag

Description

Represents {@toc} for table of contents generation in tutorials

tutorial: inline {@toc}
author: Gregory Beaver <[email protected]>
version: Release: @VER@
copyright: 2002-2008 Gregory Beaver
see: parserStringWithInlineTags
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

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

todo: CS cleanup - rename to convert for camelCase rule
uses: Converter::getTutorialId() - retrieve the tutorial ID for
uses: Converter::formatTutorialTOC() - passes an array of format:

mixed Convert (Converter &$c)

Converter &$c: converter object

setPath (line 990)

set the path

void setPath (string $path)

string $path: the path

setTOC (line 978)

set the TOC

void setTOC (array $toc)

array $toc: format:

 array(
     array(
         'tag'   => parserXMLDocBookTag,
         'id'    => parserIdInlineTag,
         'title' => title
     ),
     ...
 )

Inherited Methods

Inherited From parserInlineTag

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

Inherited From parserBase

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