Class parserLinkInlineTag

(line 142)

Description

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

Located in File: /phpDocumentor/InlineTags.inc

represents inline links


Classes extended from parserLinkInlineTag:
parserTutorialInlineTag
Represents inline links to external tutorial documentation

Class Variables

Summary:
string $linktext

$linktext = '' (line 149)

Data type : string

text to display in the link, can be different from the link for standard

links like websites

Class Constants

Summary:

Method Detail

Summary:
parserLinkInlineTag parserLinkInlineTag (string $link, string $text)
false|string Convert (Converter &$c)
string ConvertPart (Converter &$c, string $value)

Constructor parserLinkInlineTag (line 157)

parserLinkInlineTag parserLinkInlineTag( string $link, string $text)

sets up the tag

Parameters

Info

Method Convert (line 179)

false|string Convert( Converter &$c)

Overridden in child classes as:

parserTutorialInlineTag::Convert()
convert part of the tag

calls the output conversion

Parameters

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

Info

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

Method ConvertPart (line 204)

string ConvertPart( Converter &$c, string $value)

convert part of the tag

Parameters

  • Converter &$c: the output converter
  • string $value: the tag value

Info

  • todo - CS cleanup - rename to convertPart for camelCase rule

Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserInlineTag

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

parserInlineTag::$type - Element type

Inherited From Class parserBase

parserBase::$value - set to different things by its descendants

Inherited Methods

Inherited Method Summary

Inherited From Class parserInlineTag

parserInlineTag::parserInlineTag() - sets up the tag

parserInlineTag::getString() - always gets an empty string

parserInlineTag::Strlen() - get length of the tag


Inherited From Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value



Documentation generated on Mon, 05 Dec 2011 21:28:05 -0600 by phpDocumentor 1.4.4