class FrxFiles in Forena Reports 8

Class FrxFiles

Plugin annotation

@FrxDriver(
  id="FrxFiles",
  name="XML File Driver"
)

Hierarchy

• class \Drupal\forena\FrxPlugin\Driver\DriverBase implements DriverInterface uses FrxAPI
  • class \Drupal\forena\FrxPlugin\Driver\FrxFiles

3 string references to 'FrxFiles'

forena.forena.yml in ./forena.forena.yml

forena.forena.yml

settings.php in data/forena_help/settings.php

TestingDataManager::__construct in tests/src/Unit/Mock/TestingDataManager.php

Create object for testing

File

src/FrxPlugin/Driver/FrxFiles.php, line 23

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

Namespace

Drupal\forena\FrxPlugin\Driver

class FrxFiles extends DriverBase {
  private $path;
  public function __construct($name, $conf, DataFileSystem $fileSystem) {
    parent::__construct($name, $conf, $fileSystem);
    $this->comment_prefix = '<!--';
    $this->comment_suffix = '-->';
    $this->block_ext = 'xml';
    $path = '';
    if (isset($conf['uri'])) {
      list($protocol, $path) = explode('://', $conf['uri'], 2);
      if (!$path) {
        $path = $protocol;
      }
    }
    $this->path = $path;
  }
  public function getName() {
    return 'XML File';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DriverBase::$block_ext	public	property
DriverBase::$block_extensions	public	property
DriverBase::$block_name	public	property
DriverBase::$block_path	public	property
DriverBase::$comment_prefix	public	property
DriverBase::$comment_suffix	public	property
DriverBase::$conf	public	property
DriverBase::$debug	public	property		1
DriverBase::$fileSvc	public	property
DriverBase::$name	public	property
DriverBase::$te	protected	property
DriverBase::$types	public	property
DriverBase::access	public	function	Implements the basic default security check of calling an access method. Overrides DriverInterface::access
DriverBase::buildFilterSQL	public	function	Build the SQL clause based on builder data.
DriverBase::data	public	function	Return data based on block definition. Overrides DriverInterface::data
DriverBase::getSQLInclude	public	function
DriverBase::listDataBlocks	public	function	Find all the blocks matching a provided search string
DriverBase::listDBBlocks	public	function	@TODO: Determine whether we still need this.
DriverBase::loadBlock		function	Load blcok data from filesystem Overrides DriverInterface::loadBlock
DriverBase::loadBlockFromFile	protected	function
DriverBase::parmConvert	public	function	Perform generic type conversion based on attributes.
DriverBase::parseSQLFile	public	function	Break the contents of a sql file down to its source.
DriverBase::parseXMLFile	public	function	Parse XML File contents into contents.
DriverBase::phpData	public	function
DriverBase::searchTableColumns	public	function		5
DriverBase::searchTableColumnsSQL	public	function
DriverBase::searchTables	public	function	Method to return an array of tables that start with the string indicated in $str	5
DriverBase::searchTablesSQL	public	function
DriverBase::tokens	public	function	Load tokens from block source
DriverBase::xmlData	public	function	Implement static XML functioin
FrxAPI::app	public	function	Returns containing application service
FrxAPI::currentDataContext	public	function	Get the current data context.
FrxAPI::currentDataContextArray	public	function
FrxAPI::dataManager	public	function	Returns the data manager service
FrxAPI::dataService	public	function	Return Data Service
FrxAPI::documentManager	public	function	Returns the fornea document manager
FrxAPI::error	public	function	Report an error
FrxAPI::getDataContext	public	function	Get the context of a specific id.
FrxAPI::getDocument	public	function	Get the current document
FrxAPI::getReportFileContents	public	function	Load the contents of a file in the report file system.
FrxAPI::innerXML		function	Enter description here...	1
FrxAPI::popData	public	function	Pop data off of the stack.
FrxAPI::pushData	public	function	Push data onto the Stack
FrxAPI::report	public	function	Run a report with a particular format.	1
FrxAPI::reportFileSystem	public	function	Get the current report file system.
FrxAPI::setDataContext	public	function	Set Data context by id.
FrxAPI::setDocument	public	function	Change to a specific document type.
FrxAPI::skins	public	function	Get list of skins.
FrxFiles::$path	private	property
FrxFiles::getName	public	function
FrxFiles::__construct	public	function	Overrides DriverBase::__construct