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

Class: parserLinkInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class Overview

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

represents inline links


Author(s):

Version:

  • Release: @VER@

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



Tags:

tutorial:  inline {@link}
author:  Gregory Beaver <cellog@php.net>
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


[ 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 ]



Class Methods


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

[ Top ]

method Convert [line 179]

false|string Convert( Converter &$c)

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 ]

method ConvertPart [line 204]

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

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 ]


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