Docs For Class XML

void clearProfile(
)

Calls XML_Query2XML::stopProfiling() and then clears the profiling data by resetting a private property.

Access: public

[ Top ]

void disableDebugLog(
)

Disable the logging of debug messages

Access: public

[ Top ]

void enableDebugLog(
mixed
$log)

Enable the logging of debug messages.

This will include all queries sent to the database. Example:

 <?php

 require_once 'Log.php';
 require_once 'XML/Query2XML.php';
 $query2xml = XML_Query2XML::factory(MDB2::connect($dsn));
 $debugLogger = Log::factory('file', 'out.log', 'XML_Query2XML');
 $query2xml->enableDebugLog($debugLogger);
 ?>

Please see http://pear.php.net/package/Log for details on PEAR Log.

Access: public

Parameters:

mixed $log — Most likely an instance of PEAR Log but any object that provides a method named 'log' is accepted.

[ Top ]

XML_Query2XML factory(
mixed
$backend)

Factory method.

As first argument pass an instance of PDO, PEAR DB, PEAR MDB2, ADOdb, Net_LDAP or an instance of any class that extends XML_Query2XML_Driver:

 <?php

 require_once 'XML/Query2XML.php';
 $query2xml = XML_Query2XML::factory(
   new PDO('mysql://root@localhost/Query2XML_Tests')
 );
 ?>

 <?php

 require_once 'XML/Query2XML.php';
 require_once 'DB.php';
 $query2xml = XML_Query2XML::factory(
   DB::connect('mysql://root@localhost/Query2XML_Tests')
 );
 ?>

 <?php

 require_once 'XML/Query2XML.php';
 require_once 'MDB2.php';
 $query2xml = XML_Query2XML::factory(
   MDB2::factory('mysql://root@localhost/Query2XML_Tests')
 );
 ?>

 <?php

 require_once 'XML/Query2XML.php';
 require_once 'adodb/adodb.inc.php';
 $adodb = ADONewConnection('mysql');
 $adodb->Connect('localhost', 'root', '', 'Query2XML_Tests');
 $query2xml = XML_Query2XML::factory($adodb);
 ?>

Return: A new instance of XML_Query2XML
Throws: XML_Query2XML_DriverException If $backend already is a PEAR_Error.
Throws: XML_Query2XML_ConfigException If $backend is not an instance of a child class of DB_common, MDB2_Driver_Common, ADOConnection PDO, Net_LDAP or XML_Query2XML_Driver.
Access: public

Parameters:

mixed $backend — An instance of PEAR DB, PEAR MDB2, ADOdb, PDO, Net_LDAP or a subclass of XML_Query2XML_Driver.

[ Top ]

DOMDocument getFlatXML(
string
$sql, [string
$rootTagName = 'root'], [string
$rowTagName = 'row'])

Transforms the data retrieved by a single SQL query into flat XML data.

This method will return a new instance of DOMDocument. The column names will be used as element names.

Example:

 <?php

 require_once 'XML/Query2XML.php';
 $query2xml = XML_Query2XML::factory(MDB2::connect($dsn));
 $dom = $query2xml->getFlatXML(
   'SELECT * FROM artist',
   'music_library',
   'artist'
 );
 ?>

Return: A new instance of DOMDocument.
Throws: XML_Query2XML_Exception This is the base class for the exception types XML_Query2XML_DBException and XML_Query2XML_XMLException. By catching XML_Query2XML_Exception you can catch all exceptions this method will ever throw.
Throws: XML_Query2XML_DBException If a database error occurrs.
Throws: XML_Query2XML_XMLException If an XML error occurrs - most likely $rootTagName or $rowTagName is not a valid element name.
Access: public

Parameters:

string	`$sql`	—	The query string.
string	`$rootTagName`	—	The name of the root tag; this argument is optional (default: 'root').
string	`$rowTagName`	—	The name of the tag used for each row; this argument is optional (default: 'row').

[ Top ]

mixed getGlobalOption(
string
$option)

Returns the current value for a global option.

See XML_Query2XML::setGlobalOption() for a list of available options.

Return: The option's value
Throws: XML_Query2XML_ConfigException If the option does not exist
Access: public

Parameters:

string $option — The name of the option

[ Top ]

string getProfile(
)

Returns the profile as a single multi line string.

Return: The profiling data.
Access: public

[ Top ]

array getRawProfile(
)

Returns all raw profiling data.

In 99.9% of all cases you will want to use getProfile().

See: XML_Query2XML::getProfile()
Access: public

[ Top ]

DOMDocument getXML(
mixed
$sql, array
$options)

Transforms your SQL data retrieved by one or more queries into complex and highly configurable XML data.

This method will return a new instance of DOMDocument. Please see the tutorial for details.

Return: The XML data as a new instance of DOMDocument.
Throws: XML_Query2XML_Exception This is the base class for the exception types XML_Query2XML_DBException, XML_Query2XML_XMLException and XML_Query2XML_ConfigException. By catching XML_Query2XML_Exception you can catch all exceptions this method will ever throw.
Throws: XML_Query2XML_ConfigException If some configuration options passed as second argument are invalid or missing.
Throws: XML_Query2XML_DBException If a database error occurrs.
Throws: XML_Query2XML_XMLException If an XML error occurrs - most likely an invalid XML element name.
Access: public

Parameters:

mixed	`$sql`	—	A string an array or the boolean value false.
array	`$options`	—	Options for the creation of the XML data stored in an associative, potentially mutli-dimensional array (please see the tutorial).

[ Top ]

void registerPrefix(
string
$prefix, string
$className, [string
$filePath = ''])

Register a prefix that can be used in all value specifications.

Throws: XML_Query2XML_ConfigException Thrown if $prefix is not a string or has a length other than 1.
Access: public

Parameters:

string	`$prefix`	—	The prefix name. This must be a single chracter.
string	`$className`	—	The name of the Data Class. This class has to extend XML_Query2XML_Data.
string	`$filePath`	—	The path to the file that contains the Command class. This argument is optional.

[ Top ]

void setGlobalOption(
string
$option, mixed
$value)

Set a global option.

Currently the following global options are available:

hidden_container_prefix: The prefix to use for container elements that are to be removed before the DOMDocument before it is returned by XML_Query2XML::getXML(). This has to be a non-empty string. The default value is '__'.

Throws: XML_Query2XML_ConfigException If the configuration option does not exist or if the value is invalid for that option
Access: public

Parameters:

string	`$option`	—	The name of the option
mixed	`$value`	—	The option value

[ Top ]

void startProfiling(
)

Start profiling.

Access: public

[ Top ]

void stopProfiling(
)

Stop profiling.

Access: public

[ Top ]

void unregisterAllPrefixes(
)

Unregister all prefixes.

Access: public

[ Top ]

void unregisterPrefix(
string
$prefix)

Unregister a prefix.

Access: public

Parameters:

string $prefix — The prefix name.

[ Top ]

Class: XML_Query2XML

Class Overview

Author(s):

Version:

Copyright:

Methods

Inherited Variables

Inherited Methods

Class Details

Method Detail

clearProfile [line 476]

disableDebugLog [line 376]

enableDebugLog [line 364]

Parameters:

factory [line 225]

Parameters:

getFlatXML [line 519]

Parameters:

getGlobalOption [line 332]

Parameters:

getProfile [line 436]

getRawProfile [line 424]

getXML [line 565]

Parameters:

registerPrefix [line 243]

Parameters:

setGlobalOption [line 294]

Parameters:

startProfiling [line 387]

stopProfiling [line 406]

unregisterAllPrefixes [line 273]

unregisterPrefix [line 263]

Parameters: