represents inline links

• tutorial: inline {@link}
• author: Gregory Beaver <[email protected]>
• version: Release: @VER@
• copyright: 2002-2008 Gregory Beaver
• see: parserStringWithInlineTags
• link: http://pear.php.net/PhpDocumentor
• link: http://www.phpdoc.org
• todo: CS cleanup - change package to PhpDocumentor
• todo: CS cleanup - change classname to PhpDocumentor_*
• since: 1.0rc1
• license: LGPL

Located in /phpDocumentor/InlineTags.inc (line 142)

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

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

Constructor parserLinkInlineTag (line 157)

sets up the tag

parserLinkInlineTag parserLinkInlineTag (string $link, string $text)

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

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:

• parserTutorialInlineTag::Convert() : convert part of the tag

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()