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

Class: parserCData

Source Location: /phpDocumentor/PackagePageElements.inc

Class parserCData

Class Overview

Represents <![CDATA[ ]]> sections.

These sections are interpreted as plain text

Located in /phpDocumentor/PackagePageElements.inc [line 72]

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserCData
Author(s): Information Tags:
Tutorial:  phpDocumentor Tutorials
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_*
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()   calls the output conversion

[ Top ]
Methods
Convert  [line 84]

  string Convert( Converter &$c, [bool $postprocess = true]  )

calls the output conversion

Parameters:
Converter   &$c:  the output converter
bool   $postprocess:  if postprocessing is needed

API Tags:
Uses:  Converter::getCData() - convert contents to text

Information Tags:
Todo:  CS cleanup - rename to convert for camelCase rule

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:20:35 -0600 by phpDocumentor 1.4.4