Class: parserTocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag

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

Author(s):

Gregory Beaver <[email protected]>

Version:

Release: @VER@

Copyright:

2002-2008 Gregory Beaver

Variables

$inlinetype

Methods

Inherited Variables

Class: parserInlineTag

parserInlineTag::$type

Class: parserBase

parserBase::$value

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

[line 923]
Represents {@toc} for table of contents generation in tutorials

Tags:

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

[ Top ]

Class Variables

$inlinetype = 'toc'

[line 929]

always 'toc'

Type:	string
Overrides:	Array

[ Top ]

Class Methods

constructor parserTocInlineTag [line 956]

parserTocInlineTag parserTocInlineTag(
)

constructor

[ Top ]

method Convert [line 1015]

mixed Convert(
Converter
&$c)

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

Tags:

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:

Parameters:

Converter

&$c

converter object

[ Top ]

method setPath [line 990]

void setPath(
string
$path)

set the path

Parameters:

string

$path

the path

[ Top ]

method setTOC [line 978]

void setTOC(
array
$toc)

set the TOC

Parameters:

array

$toc

format:

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

[ Top ]

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