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

Class: parserLinkTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class parserLinkTag

Class Overview

represents the "@link" tag

Located in /phpDocumentor/DocBlockTags.inc [line 657]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
Author(s): Information Tags:
Tutorial:  @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

Methods

[ Top ]
Descendants
Child Class Description
parserSeeTag represents the "@see" tag
parserLicenseTag represents the "@see" tag

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From parserTag

parserTag::$type

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$value

Inherited From parserTag

parserTag::parserTag()
Set up the tag
parserTag::Convert()
Perform the output conversion on this parserTag using the output converter that is passed in
parserTag::getString()
Returns the text minus any inline tags
parserTag::HandleEvent()
Called by the parserDescParser when processing a description.

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::add()
equivalent to the . operator ($a = $b . $c)
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked
parserStringWithInlineTags::getString()
return the string unconverted (all inline tags are taken out - this should only be used in pre-parsing to see if any other text is in the string)
parserStringWithInlineTags::hasInlineTag()
Determine whether the string contains any inline tags
parserStringWithInlineTags::setSource()
Pass source code to any {@source} tags contained within the string for later conversion.
parserStringWithInlineTags::trimmedStrlen()
equivalent to trim(strlen($string))

Inherited From parserBase

parserBase::getType()
gets the type
parserBase::getValue()
gets the value
parserBase::setValue()
sets the given value

[ Top ]
Property Summary
string   $keyword   always 'link'

[ Top ]
Method Summary
parserLinkTag   parserLinkTag()   sets up the link tag

[ Top ]
Properties
string   $keyword = 'link' [line 663]

always 'link'


Redefinition of:
parserTag::$keyword
tag name (see, access, etc.)

Redefined in descendants as:

[ Top ]
Methods
Constructor parserLinkTag  [line 672]

  parserLinkTag parserLinkTag( string $link  )

sets up the link tag

Parameters:
string   $link:  URL to link to (might also contain the URL's description text)


[ Top ]

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