Class phpDocumentor_peardoc2_XML_Beautifier

Description
Description | Methods (details)

This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer

  • since: 1.3.0

Located in /phpDocumentor/Converters/XML/DocBook/peardoc2/Beautifier.php (line 49) 

XML_Beautifier
   |
   --phpDocumentor_peardoc2_XML_Beautifier
Method Summary
Description | Methods (details)
mixed formatFile (string $file, [mixed $newFile = null], [string $renderer = "Plain"])
string formatString (string $string, [ $renderer = "Plain"])
Methods
Description | Methods (details)
formatFile (line 63)

format a file or URL

  • return: XML string of no file should be written, true if file could be written
  • throws: PEAR_Error
  • access: public
  • uses: _loadRenderer() - to load the desired renderer
mixed formatFile (string $file, [mixed $newFile = null], [string $renderer = "Plain"])
  • string $file: filename
  • mixed $newFile: filename for beautified XML file (if none is given, the XML string will be returned.) if you want overwrite the original file, use XML_BEAUTIFIER_OVERWRITE
  • string $renderer: Renderer to use, default is the plain xml renderer
formatString (line 109)

format an XML string

  • return: formatted XML string
  • throws: PEAR_Error
  • access: public
string formatString (string $string, [ $renderer = "Plain"])
  • string $string: XML
  • $renderer

Documentation generated on Mon, 05 Dec 2011 20:56:07 -0600 by phpDocumentor 1.4.4