Class: parserLinkInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview [line 142]

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

Variables

Constants

Methods


Child classes:

parserTutorialInlineTag
Represents inline links to external tutorial documentation

Inherited Methods

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

represents inline links

Tags:

[ Top ]


Class Variables

$linktext =  ''

[line 149]

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

links like websites

Type: string

Overrides:

[ Top ]


Class Methods

parserLinkInlineTag

parserLinkInlineTag parserLinkInlineTag( string $link, string $text)

[line 157]

sets up the tag

Parameters:

[ Top ]

Convert

false|string Convert( Converter &$c)

[line 179]

calls the output conversion

Tags:

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

Overridden in child classes as:

parserTutorialInlineTag::Convert()
convert part of the tag

Parameters:

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

[ Top ]

ConvertPart

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

[line 204]

convert part of the tag

Tags:

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

Parameters:

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

[ Top ]


Class Constants


Documentation generated on Tue, 06 Dec 2011 07:07:37 -0600 by phpDocumentor 1.4.4