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

Class: parserTocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag

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


Author(s):

Version:

  • Release: @VER@

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 [email protected]} for table of contents generation in tutorials



Tags:



[ 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