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

Class: phpDocumentor_peardoc2_XML_Beautifier

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

Class phpDocumentor_peardoc2_XML_Beautifier

Class Overview

This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer

Located in /phpDocumentor/Converters/XML/DocBook/peardoc2/Beautifier.php [line 49]

XML_Beautifier
   |
   --phpDocumentor_peardoc2_XML_Beautifier
Author(s):
Information Tags:
Since:  1.3.0

Methods

[ Top ]
Method Summary
mixed   formatFile()   format a file or URL
string   formatString()   format an XML string

[ Top ]
Methods
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

API Tags:
Return:  XML string of no file should be written, true if file could be written
Access:  public
Uses:  _loadRenderer() - to load the desired renderer

Information Tags:
Throws:  PEAR_Error

[ Top ]
formatString  [line 109]

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

format an XML string

Parameters:
string   $string:  XML
   $renderer: 

API Tags:
Return:  formatted XML string
Access:  public

Information Tags:
Throws:  PEAR_Error

[ Top ]

Documentation generated on Tue, 06 Dec 2011 07:16:15 -0600 by phpDocumentor 1.4.4