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

Class: parserTocInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserTocInlineTag

Class Overview

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

Located in /phpDocumentor/InlineTags.inc [line 923]

parserBase
   |
   --parserInlineTag
      |
      --parserTocInlineTag
Author(s): API Tags:
See:  parserStringWithInlineTags

Information Tags:
Tutorial:  inline [email protected]}
Version:  Release: @VER@
Copyright:  2002-2008 Gregory Beaver
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

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()
sets up the tag
parserInlineTag::getString()
always gets an empty string
parserInlineTag::Strlen()
get length of the tag

Inherited From parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ Top ]
Property Summary
string   $inlinetype   always 'toc'

[ Top ]
Method Summary
parserTocInlineTag   parserTocInlineTag()   constructor
mixed   Convert()   converter method
void   setPath()   set the path
void   setTOC()   set the TOC

[ Top ]
Properties
string   $inlinetype = 'toc' [line 929]

always 'toc'


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

[ Top ]
Methods
Constructor parserTocInlineTag  [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

API Tags:
Uses:  Converter::getTutorialId() - retrieve the tutorial ID for
Uses:  Converter::formatTutorialTOC() - passes an array of format:

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

[ 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 Tue, 06 Dec 2011 07:20:03 -0600 by phpDocumentor 1.4.4