Description
parserBase | --parserInlineTag | --parserLinkInlineTag
Located in File: /phpDocumentor/InlineTags.inc
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
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:
Constructor parserLinkInlineTag (line 157)
parserLinkInlineTag parserLinkInlineTag( string $link, string $text)
sets up the tag
Parameters
- string $link: stored in $value, see parserBase::$value
- string $text: see $linktext
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