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

Class: parserSamp

Source Location: /phpDocumentor/DescHTML.inc

Class parserSamp

Class Overview

Used for <samp> in a description

Located in /phpDocumentor/DescHTML.inc [line 260]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserSamp
Author(s): Information Tags:
Version:  Release: @[email protected]
Copyright:  2002-2007 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
Todo:  CS cleanup - rename class to ParserSamp
Since:  1.2
License:  LGPL

Methods

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

Inherited From parserStringWithInlineTags

parserStringWithInlineTags::$type
parserStringWithInlineTags::$value

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 ]
Method Summary
string   Convert()   performs the conversion of sample tags

[ Top ]
Methods
Convert  [line 271]

  string Convert( Converter &$c  )

performs the conversion of sample tags

Parameters:
Converter   &$c:  the converter object

API Tags:
Return:  the converted pre block
Uses:  Converter::Sampize()

Information Tags:
Todo:  CS cleanup - rename method to convert()

Redefinition of:
parserStringWithInlineTags::Convert()
Use to convert the string to a real string with all inline tags parsed and linked

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:17:59 -0600 by phpDocumentor 1.4.4