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

Class: parserCData

Source Location: /phpDocumentor/PackagePageElements.inc

Class Overview

parserBase
   |
   --parserStringWithInlineTags
      |
      --parserCData

Represents <![CDATA[ ]]> sections.


Author(s):

Version:

  • Release: @VER@

Copyright:

  • 2002-2008 Gregory Beaver

Methods


Inherited Variables

Inherited Methods

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 72]
Represents <![CDATA[ ]]> sections.

These sections are interpreted as plain text




Tags:

tutorial:  phpDocumentor Tutorials
author:  Gregory 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_*
license:  LGPL


[ Top ]


Class Methods


method Convert [line 84]

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

calls the output conversion



Tags:

todo:  CS cleanup - rename to convert for camelCase rule
uses:  Converter::getCData() - convert contents to text


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

Parameters:

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

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:14:22 -0600 by phpDocumentor 1.4.4