previousXML_Beautifier::apiVersion (Previous) (Next) XML_Beautifier::formatStringnext

View this page in Last updated: Tue, 02 Jun 2009
English | Brazilian Portuguese | Chinese | Dutch | French | German | Hungarian | Japanese | Polish | Russian | Spanish | Turkish

XML_Beautifier::formatFile

XML_Beautifier::formatFile() – beautify a file

Synopsis

require_once 'XML/Beautifier.php';

object XML_Beautifier::formatFile ( string $file , string $newFile = null , string $renderer = "Plain" )

Description

Beautifies a file.

Parameter

  • string $file - filename of the original file

  • string $newFile - filename for the beautified file. If no file is given, the method will return the resulting XML document. To overwrite the original file, pass XML_BEAUTIFIER_OVERWRITE.

  • string $renderer - renderer to use, currently only a "Plain" XML renderer can be used.

Return value

mixed Either true, if file has been written or the XML document string.

Note

This function can not be called statically.

previousXML_Beautifier::apiVersion (Previous) (Next) XML_Beautifier::formatStringnext

Download Documentation Last updated: Tue, 02 Jun 2009
Do you think that something on this page is wrong? Please file a bug report or add a note.
User Notes:
There are no user contributed notes for this page.