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

Class: parserTocInlineTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag

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


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Inherited Variables

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


[ Top ]


Class Variables

$inlinetype =  'toc'

[line 929]

always 'toc'

Type:   string
Overrides:   Array


[ Top ]



Method Detail

parserTocInlineTag (Constructor)   [line 956]

parserTocInlineTag parserTocInlineTag( )

constructor

[ Top ]

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


Parameters:

Converter   &$c     converter object

[ Top ]

setPath   [line 990]

void setPath( string $path)

set the path

Parameters:

string   $path     the path

[ Top ]

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 Sun, 02 Sep 2012 00:02:00 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.