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

Class: phpDocumentor_peardoc2_XML_Beautifier

Source Location: /PhpDocumentor-1.5.0a1/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


Inherited Variables

Inherited Methods


Class Details

[line 51]
This is just like XML_Beautifier, but uses phpDocumentor_XML_Beautifier_Tokenizer
  • Since: 1.3.0


[ Top ]


Method Detail

formatFile   [line 65]

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

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

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 ]

formatString   [line 111]

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

format an XML string
  • Return: formatted XML string
  • Throws: PEAR_Error
  • Access: public

Parameters:

string   $string     XML
   $renderer     

[ Top ]


Documentation generated on Sun, 02 Sep 2012 00:00:44 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.