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

Class: parserUsesTag

Source Location: /phpDocumentor/DocBlockTags.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserTag
         |
         --parserLinkTag
            |
            --parserSeeTag
               |
               --parserUsesTag

represents the "@uses" tag


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Variables

Methods


Child classes:

parserUsedByTag
This is a virtual tag, it is created by @uses to cross-reference the used element

Inherited Variables

Inherited Methods

Class: parserSeeTag

parserSeeTag::parserSeeTag()
sets up the see tag
parserSeeTag::Convert()
process this tag through the given output converter

Class: parserLinkTag

parserLinkTag::parserLinkTag()
sets up the link tag

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.

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))

Class: parserBase

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

Class Details

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




Tags:

tutorial:  @uses
author:  Greg Beaver <cellog@php.net>
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.2
license:  LGPL


[ Top ]


Class Variables

$keyword =  'uses'

[line 844]

Always "uses"


Type:   string
Overrides:   Array


[ Top ]



Class Methods


constructor parserUsesTag [line 857]

parserUsesTag parserUsesTag( string $seeel, parserStringWithInlineTags $description)

set up the uses tag



Parameters:

string   $seeel   element to link to
parserStringWithInlineTags   $description   description of how the element is used

[ Top ]

method Convert [line 879]

string Convert( Converter &$c)

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.




Tags:

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


Overridden in child classes as:

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

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

Parameters:

Converter   &$c   the output converter

[ Top ]

method getDescription [line 908]

parserStringWithInlineTags getDescription( )

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



Tags:

usedby:  phpDocumentor_IntermediateParser::addUses() - used to initialize $uses


[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:12:05 -0600 by phpDocumentor 1.4.4