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

Class: phpDocumentor_peardoc2_XML_Beautifier

Source Location: /phpDocumentor/Converters/XML/DocBook/peardoc2/Beautifier.php

Class Overview

XML_Beautifier
   |
   --phpDocumentor_peardoc2_XML_Beautifier

This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer


Author(s):

Methods



Class Details

[line 49]
This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer



Tags:

since:  1.3.0


[ Top ]


Class Methods


method formatFile [line 63]

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

format a file or URL



Tags:

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


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

[ Top ]

method formatString [line 109]

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

format an XML string



Tags:

return:  formatted XML string
throws:  PEAR_Error
access:  public


Parameters:

string   $string   XML
   $renderer  

[ Top ]


Documentation generated on Tue, 06 Dec 2011 07:10:05 -0600 by phpDocumentor 1.4.4