Class parserLinkInlineTag

Description
Direct descendents
Class Description
 class parserTutorialInlineTag Represents inline links to external tutorial documentation
Variable Summary
 string $linktext
Method Summary
 parserLinkInlineTag parserLinkInlineTag (string $link, string $text)
 false|string Convert (Converter &$c)
 string ConvertPart (Converter &$c, string $value)
Variables
string $linktext = '' (line 149)

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

links like websites

Inherited Variables

Inherited from parserInlineTag

parserInlineTag::$inlinetype
parserInlineTag::$type

Inherited from parserBase

parserBase::$value
Methods
Constructor parserLinkInlineTag (line 157)

sets up the tag

parserLinkInlineTag parserLinkInlineTag (string $link, string $text)
Convert (line 179)

calls the output conversion

  • return: returns the converted link or false if not converted successfully
  • todo: CS cleanup - rename to convert for camelCase rule
false|string Convert (Converter &$c)
  • Converter &$c: converter used to change the abstract link into text for display

Redefined in descendants as:
ConvertPart (line 204)

convert part of the tag

  • todo: CS cleanup - rename to convertPart for camelCase rule
string ConvertPart (Converter &$c, string $value)
  • Converter &$c: the output converter
  • string $value: the tag value

Inherited Methods

Inherited From parserInlineTag

 parserInlineTag::parserInlineTag()
 parserInlineTag::getString()
 parserInlineTag::Strlen()

Inherited From parserBase

 parserBase::getType()
 parserBase::getValue()
 parserBase::setValue()

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