Class phpDocumentor_peardoc2_XML_Beautifier

(line 49)

Description

XML_Beautifier
   |
   --phpDocumentor_peardoc2_XML_Beautifier

Located in File: /phpDocumentor/Converters/XML/DocBook/peardoc2/Beautifier.php

This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer


Class Variables

Summary:

Class Constants

Summary:

Method Detail

Summary:
mixed formatFile (string $file, [mixed $newFile = null], [string $renderer = "Plain"])
string formatString (string $string, [ $renderer = "Plain"])

Method formatFile (line 63)

mixed formatFile( string $file, [mixed $newFile = null], [string $renderer = "Plain"])

format a file or URL

Parameters

  • 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

Info

  • 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

Method formatString (line 109)

string formatString( string $string, [ $renderer = "Plain"])

format an XML string

Parameters

  • string $string: XML
  • $renderer:

Info

  • return - formatted XML string
  • throws - PEAR_Error
  • access - public

Inherited Variables

Inherited Class Variable Summary

Inherited Methods

Inherited Method Summary


Documentation generated on Mon, 05 Dec 2011 21:24:27 -0600 by phpDocumentor 1.4.4