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

Class: parserTutorialInlineTag

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

Class Overview

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

Represents inline links to external tutorial documentation


Author(s):

Version:

  • Release: 1.5.0a1

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


[ Top ]


Method Detail

parserTutorialInlineTag (Constructor)   [line 286]

parserTutorialInlineTag parserTutorialInlineTag( string $link, string $text)

constructor

Parameters:

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

[ Top ]

Convert   [line 302]

mixed Convert( Converter &$c)

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