# tasks/ext/pdo/XMLPDOResultFormatter.php

$Id: XMLPDOResultFormatter.php 552 2009-08-29 12:18:13Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

## \XMLPDOResultFormatter
jump to top

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

`\DOMDocument $doc= ''`

The XML document being created.

Details

Type
  \DOMDocument

`string $encoding= ''`

XML document encoding

Details

Type
  string

`boolean $formatOutput= 'true'`

Default value `true` Details

Type
  boolean

`\Writer $out= ''`
inherited

Output writer.

Inherited from: \PDOResultFormatter::$out
Details

Type
  \Writer
Inherited_from
  \PDOResultFormatter::$out

`\DOMElement $rootNode= ''`

Details

Type
  \DOMElement

### Methods

`close( ) : void`

Write XML to file and free the DOM objects.

`getOutput( ) : \Writer`
inherited

Gets the output writer.

Inherited from: \PDOResultFormatter::getOutput()
Returns

Type | Description
--- | ---
\Writer |

`getPreferredOutfile( ) : 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 |

`initialize( ) : void`

Perform any initialization.

`processRow( array $row ) : void`

Processes a specific row from PDO result set.

Parameters

Name | Type | Description
--- | --- | ---
$row | array | Row of PDO result set.

`setEncoding( string $v ) : void`

Set the DOM document encoding.

Parameters

Name | Type | Description
--- | --- | ---
$v | string |

`setFormatOutput( boolean $v ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$v | boolean |

`setOutput( \Writer $out ) : void`
inherited

Sets the output writer.

Inherited from: \PDOResultFormatter::setOutput()
Parameters

Name | Type | Description
--- | --- | ---
$out | \Writer |

Documentation was generated by DocBlox 0.15.1.