Class parserUsesTag

(line 838)



Located in File: /phpDocumentor/

represents the "@uses" tag

This is exactly like @see except that the element used has a @useby link to this element added to its docblock

Classes extended from parserUsesTag:
This is a virtual tag, it is created by @uses to cross-reference the used element

Class Variables

string $keyword

$keyword = 'uses' (line 844)

Data type : string

Overrides: Array

Always "uses"

Class Constants


Method Detail

parserUsesTag parserUsesTag (string $seeel, parserStringWithInlineTags $description)
string Convert (Converter &$c)

Constructor parserUsesTag (line 857)

parserUsesTag parserUsesTag( string $seeel, parserStringWithInlineTags $description)

set up the uses tag



Method Convert (line 879)

string Convert( Converter &$c)

Overridden in child classes as:

process this tag through the given output converter

Overrides : parserSeeTag::Convert() process this tag through the given output converter

Return a link to documentation for other element, and description of how it is used

Works exactly like parent::Convert() except that it also includes a description of how the element used is used.



  • return - link to the uses target
  • todo - CS cleanup - rename to convert for camelCase rule

Method getDescription (line 908)

parserStringWithInlineTags getDescription( )

Get the description of how the element used is being used.


Inherited Variables

Inherited Class Variable Summary

Inherited From Class parserTag

parserTag::$type - Type is used by many functions to skip the hassle of

Inherited From Class parserStringWithInlineTags

parserStringWithInlineTags::$value - array of strings and parserInlineTags

Inherited Methods

Inherited Method Summary

Inherited From Class parserSeeTag

parserSeeTag::parserSeeTag() - sets up the see tag

parserSeeTag::Convert() - process this tag through the given output converter

Inherited From Class parserLinkTag

parserLinkTag::parserLinkTag() - sets up the link tag

Inherited From Class 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 Class 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 Class parserBase

parserBase::getType() - gets the type

parserBase::getValue() - gets the value

parserBase::setValue() - sets the given value

Documentation generated on Mon, 05 Dec 2011 21:26:23 -0600 by phpDocumentor 1.4.4