tasks/ext/pdo/XMLPDOResultFormatter.php

Show: inherited
Table of Contents

\XMLPDOResultFormatter

Package: phing\tasks\ext\pdo

XML formatter for PDO results.

This class reprsents the output of a query using a simple XML schema.

value value2 value value2

The actual names of the colums will depend on the fetchmode that was used with PDO.

Parent(s)
\PDOResultFormatter
Author
Hans Lellelid  
Since
2.3.0  

Properties

Propertyprivate\DOMDocument  $doc= ''

The XML document being created.

Details
Type
\DOMDocument
Propertyprivatestring  $encoding= ''

XML document encoding

Details
Type
string
Propertyprivateboolean  $formatOutput= 'true'

Default valuetrueDetails
Type
boolean
Propertyprotected\Writer  $out= ''
inherited

Output writer.

Inherited from: \PDOResultFormatter::$$out
Details
Type
\Writer
Inherited_from
\PDOResultFormatter::$$out  
Propertyprivate\DOMElement  $rootNode= ''

Details
Type
\DOMElement

Methods

methodpublicclose( ) : void

Write XML to file and free the DOM objects.

methodpublicgetOutput( ) : \Writer
inherited

Gets the output writer.

Inherited from: \PDOResultFormatter::getOutput()
Returns
Type Description
\Writer
methodpublicgetPreferredOutfile( ) : string

Gets a preferred filename for an output file.

If no filename is specified, this is where the results will be placed (unless usefile=false).

Returns
Type Description
string
methodpublicinitialize( ) : void

Perform any initialization.

methodpublicprocessRow( array $row ) : void

Processes a specific row from PDO result set.

Parameters
Name Type Description
$row array

Row of PDO result set.

methodpublicsetEncoding( string $v ) : void

Set the DOM document encoding.

Parameters
Name Type Description
$v string
methodpublicsetFormatOutput( boolean $v ) : void

Parameters
Name Type Description
$v boolean
methodpublicsetOutput( \Writer $out ) : void
inherited

Sets the output writer.

Inherited from: \PDOResultFormatter::setOutput()
Parameters
Name Type Description
$out \Writer
Documentation was generated by DocBlox 0.18.1.