Class: parserLinkInlineTag

Source Location: /phpDocumentor/InlineTags.inc

Class parserLinkInlineTag

Class Overview

represents inline links

Located in /phpDocumentor/InlineTags.inc [line 142]

parserBase
   |
   --parserInlineTag
      |
      --parserLinkInlineTag

Author(s):

Gregory Beaver <[email protected]>

API Tags:

See:

parserStringWithInlineTags

Information Tags:

Tutorial:	inline {@link}
Version:	Release: @VER@
Copyright:	2002-2008 Gregory Beaver
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

Properties

$linktext

Methods

[ Top ]

Descendants

Child Class	Description
parserTutorialInlineTag	Represents inline links to external tutorial documentation

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From parserInlineTag

parserInlineTag::$inlinetype

parserInlineTag::$type

Inherited From parserBase

parserBase::$value

Inherited From parserInlineTag

parserInlineTag::parserInlineTag()

sets up the tag

parserInlineTag::getString()

always gets an empty string

parserInlineTag::Strlen()

get length of the tag

Inherited From parserBase

parserBase::getType()

gets the type

parserBase::getValue()

gets the value

parserBase::setValue()

sets the given value

[ Top ]

Property Summary

string

$linktext

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

[ Top ]

Method Summary

parserLinkInlineTag	parserLinkInlineTag()	sets up the tag
false\|string	Convert()	calls the output conversion
string	ConvertPart()	convert part of the tag

[ Top ]

Properties

string $linktext = '' [line 149]

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

links like websites

[ Top ]

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 ]

Convert [line 179]

false|string Convert(
Converter
&$c 
)

calls the output conversion

Parameters:

Converter

&$c:

converter used to change the abstract link into text for display

API Tags:

Return:

returns the converted link or false if not converted successfully

Information Tags:

Todo:

CS cleanup - rename to convert for camelCase rule

Redefined in descendants as:

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

[ Top ]

ConvertPart [line 204]

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

convert part of the tag

Parameters:

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

Information Tags:

Todo:

CS cleanup - rename to convertPart for camelCase rule

[ Top ]

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

	phpDocumentor InlineTags

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