phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Class: parserLinkInlineTag

Source Location: /PhpDocumentor-1.5.0a1/phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

represents inline links


Author(s):

Version:

  • Release: 1.5.0a1

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

parserTutorialInlineTag
Represents inline links to external tutorial documentation

Inherited Variables

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

[line 142]
represents inline links


[ 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


[ Top ]



Method Detail

parserLinkInlineTag (Constructor)   [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

[ Top ]

Convert   [line 179]

false|string Convert( Converter &$c)

calls the output conversion
  • 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   [line 204]

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

convert part of the tag
  • Todo: CS cleanup - rename to convertPart for camelCase rule

Parameters:

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

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:02:00 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.