class FrxFiles in Forena Reports 6.2

@file File class for loading raw xml files as Sample data This class is used as a reference implementation of a data engine, but is also used to provide sample data files and reports. @author metzlerd

Hierarchy

• class \FrxDataProvider
  • class \FrxFiles

3 string references to 'FrxFiles'

forena_forena_plugins in ./forena.module

Self register plugins with forena.

FrxHostApplication::plugins in ./FrxHostApplication.inc

settings.php in repos/forena_help/settings.php

File

plugins/FrxFiles.inc, line 11

File class for loading raw xml files as Sample data This class is used as a reference implementation of a data engine, but is also used to provide sample data files and reports. @author metzlerd

class FrxFiles extends FrxDataProvider {
  private $path;
  public function __construct($conf, $repos_path) {
    parent::__construct($conf, $repos_path);
    $this->comment_prefix = '<!--';
    $this->comment_suffix = '-->';
    $this->block_ext = 'xml';
    list($protocol, $path) = explode('://', $conf['uri'], 2);
    if (!$path) {
      $path = $protocol;
    }
    $this->path = $path;
  }
  public function getName() {
    return 'XML File';
  }
  public function data($block_name, $parm_data = '', $subQuery = '') {
    $block = $this
      ->load_block($block_name);
    $xml = '';
    if (isset($block['source']) && $this
      ->access($block['access'])) {
      try {
        $xmlData = $block['source'];
        $xml = new SimpleXMLElement($xmlData);
      } catch (Exception $e) {
        FrxReportGenerator::instance()
          ->error("Error processing xml\n", $e
          ->getMessage() . "\n" . $xmlData);
      }
    }

    //@TODO: Implment xpath subquery parameter

    // Should filter returned nodes, but within the original root element?
    return $xml;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FrxDataProvider::$block_ext	public	property
FrxDataProvider::$block_path	public	property
FrxDataProvider::$comment_prefix	public	property
FrxDataProvider::$comment_suffix	public	property
FrxDataProvider::$conf	public	property
FrxDataProvider::$te	protected	property
FrxDataProvider::access	public	function	Implements the basic default security check of calling an access method.
FrxDataProvider::debug	public	function
FrxDataProvider::error	public	function
FrxDataProvider::list_blocks	public	function	Find all the blocks matching a provided search string
FrxDataProvider::load_block	public	function	Default block load Loads the data block based on the block name from the file system. The classes that are derived from this will set the block_ext property, which in most cases is .sql but might be something different. The load of the block file…
FrxDataProvider::parseSQLFile	public	function
FrxDataProvider::parseXMLFile	public	function
FrxFiles::$path	private	property
FrxFiles::data	public	function
FrxFiles::getName	public	function
FrxFiles::__construct	public	function	Overrides FrxDataProvider::__construct