Class XML_Query2XML_Driver_Array

Description

Array-based driver.

usage:

  1.  $arrayDriver XML_Query2XML_Driver_Array::factory();
  2.  $arrayDriver->addResultSet(
  3.   'RESULT_SET_NAME'// to be used for $sql or $options['sql']
  4.   array(
  5.     array('column' => 'value'...)// record #1
  6.     array('column' => 'value'...)  // record #2
  7.   )
  8.  );
Usage scenario:
  • Transform an array of associative arrays to XML: $query2xml->getFlatXML('RESULT_SET_ARTISTS_FLAT');
  • Transform an array of index arrays to XML: $dom = $query2xml->getXML( 'RESULT_SET_ARTISTS_FLAT', array( 'rootTag' => 'data', 'rowTag' => 'row', 'idColumn' => false, 'elements' => array( 'name' => '0', 'ID' => '1', 'info' => '2' ) ) );
  • Easy integration of other data sources without having to write a separate driver.
  • Easy lookup table for static data. $options['sql']['data'] can be used to specify the matching record.

Located in /Query2XML/Driver/Array.php (line 66)

XML_Query2XML_Driver
   |
   --XML_Query2XML_Driver_Array
Method Summary
static XML_Query2XML_Driver_Array factory ([ $resultSet = null], [string $resultSetName = ''])
void addResultSet (string $name,  $resultSet)
array getAllRecords (array $query, string $configPath)
void removeResultSet (string $name)
Methods
static factory (line 109)

Factory method

  • access: public
static XML_Query2XML_Driver_Array factory ([ $resultSet = null], [string $resultSetName = ''])
  • array $resultSet: An index array of associative arrays. This argument is optional.
  • string $resultSetName: The name of the result set. This argument is optional. The default is an empty string.

Redefinition of:
XML_Query2XML_Driver::factory()
Factory method.
addResultSet (line 82)

Add a named result set.

  • access: public
void addResultSet (string $name,  $resultSet)
  • string $name: The name of the result set.
  • array $resultSet: An indexed array of associative arrays.
getAllRecords (line 126)

Returns all records from a named result set.

  • return: An index array of associative arrays.
  • access: public
array getAllRecords (array $query, string $configPath)
  • array $query: An array with at least one element: 'query'.
  • string $configPath: The configuration path.

Redefinition of:
XML_Query2XML_Driver::getAllRecords()
This method, when implemented executes the query passed as the first argument and returns all records from the result set.
removeResultSet (line 94)

Remove a named result set.

  • access: public
void removeResultSet (string $name)
  • string $name: The name of the result set to remove

Inherited Methods

Inherited From XML_Query2XML_Driver

XML_Query2XML_Driver::factory()
XML_Query2XML_Driver::getAllRecords()
XML_Query2XML_Driver::preprocessQuery()

Documentation generated on Sun, 03 Apr 2011 13:13:07 +0200 by phpDocumentor 1.4.1