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

Class: parserTutorialInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag
         |
         --parserTutorialInlineTag

Represents inline links to external tutorial documentation


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Methods


Inherited Variables

Inherited Methods

Class: parserLinkInlineTag

parserLinkInlineTag::parserLinkInlineTag()
sets up the tag
parserLinkInlineTag::Convert()
calls the output conversion
parserLinkInlineTag::ConvertPart()
convert part of the tag

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 278]
Represents inline links to external tutorial documentation



Tags:

tutorial:  inline {@tutorial}
author:  Gregory Beaver <cellog@php.net>
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 Methods


constructor parserTutorialInlineTag [line 286]

parserTutorialInlineTag parserTutorialInlineTag( string $link, string $text)

constructor



Parameters:

string   $link   stored in $value, see parserBase::$value
string   $text   see $linktext

[ Top ]

method Convert [line 302]

mixed Convert( Converter &$c)

convert part of the tag



Tags:

return:  returns the converted link or false if not converted successfully
todo:  CS cleanup - rename to convert for camelCase rule


Overrides parserLinkInlineTag::Convert() (calls the output conversion)

Parameters:

Converter   &$c   converter used to change the abstract link into text for display

[ Top ]


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