class FrxDrupal in Forena Reports 8

Class FrxDrupal

Plugin annotation


@FrxDriver(
  id="FrxDrupal",
  name="Drupal Database Driver"
)

Hierarchy

class \Drupal\forena\FrxPlugin\Driver\DriverBase implements DriverInterface uses FrxAPI
- class \Drupal\forena\FrxPlugin\Driver\FrxDrupal

Expanded class hierarchy of FrxDrupal

3 string references to 'FrxDrupal'

DataSourceDefinitionForm::buildForm in src/Form/DataSourceDefinitionForm.php: [@inheritdoc}
forena.forena.yml in ./forena.forena.yml: forena.forena.yml
forena_test.forena.yml in tests/modules/forena_test/forena_test.forena.yml: tests/modules/forena_test/forena_test.forena.yml

File

src/FrxPlugin/Driver/FrxDrupal.php, line 22: Provides data blocks for native drupal connections using the default drupal connections.

Namespace

Drupal\forena\FrxPlugin\Driver

View source

class FrxDrupal extends DriverBase {

  /**
   * Implements hooks into the drupal applications
   */
  private $database = 'default';

  /**
   * Object constructor
   *
   * @param string $uri
   *   Database connection string.
   * @param string $repos_path
   *   Path to location of data block definitions
   */
  public function __construct($name, $conf, DataFileSystem $fileSystem) {
    parent::__construct($name, $conf, $fileSystem);
    if (@$conf['database'] && @$conf['database'] != 'default') {
      $this->database = $conf['database'];
    }
    $target = $this->database ? $this->database : 'default';
    $this->db_type = Database::getConnection($target)
      ->databaseType();

    // Set up the stuff required to translate.
    $this->te = new SQLReplacer($this);
  }
  public function searchTables($str) {
    $str .= '%';
    $rs = db_query($this
      ->searchTablesSQL(), array(
      ':str' => $str,
    ));
    if ($rs) {
      return $rs
        ->fetchCol();
    }
    else {
      return NULL;
    }
  }

  /**
   * Generate a list of columns for a table.
   * @param string $table
   *   Name of table to search for.
   * @param string $str
   *   Search string for column name.
   * @return array
   *   Array of column names found.
   */
  public function searchTableColumns($table, $str) {
    $str .= '%';
    $table = trim($table, '{} ');
    $key = $this->database ? $this->database : 'default';
    $info = Database::getConnectionInfo($key);
    $database = $info[$key]['database'];
    $rs = db_query($this
      ->searchTableColumnsSQL(), array(
      ':str' => $str,
      ':database' => $database,
      ':table' => $table,
    ));
    if ($rs) {
      return $rs
        ->fetchCol();
    }
    else {
      return NULL;
    }
  }
  public function query($sql, $options = array()) {
    if ($this->database != 'default') {
      db_set_active($this->database);
    }

    // Load the types array based on data
    $this->types = isset($options['type']) ? $options['type'] : array();

    // Load the block from the file
    $xml = '';
    $sql = $this->te
      ->replace($sql);
    try {
      if (@(int) $options['limit']) {
        $rs = db_query_range($sql, 0, (int) $options['limit']);
      }
      else {
        $rs = db_query($sql);
      }
    } catch (DatabaseExceptionWrapper $e) {
      $line = $e
        ->getLine();
      $text = $e
        ->getMessage();

      //if (user_access('build forena sql blocks')) {
      if (!$this->block_name) {
        $short = t('%e', array(
          '%e' => $text,
          '%l' => $line,
        ));
      }
      else {
        $short = t('SQL Error in %b.sql', array(
          '%b' => $this->block_name,
        ));
      }
      $this
        ->app()
        ->error($short, $text);
      if ($this->database != 'default') {
        db_set_active();
      }
    }
    if ($this->database != 'default') {
      db_set_active();
    }
    return $rs;
  }

  /**
   * Get data based on file data block in the repository.
   *
   * @param string $sql
   *   Query to execute
   * @param array $options
   *   Options array containing type information for query.
   * @return array|\SimpleXMLElement
   *   Data returned from query execution.
   */
  public function sqlData($sql, $options = array()) {
    $rs = $this
      ->query($sql, $options);
    $entity_map = array();
    $select_fields = array();
    $rownum = 0;
    if (!$rs) {
      return NULL;
    }
    if (@$options['return_type'] == 'raw') {
      return $rs;
    }
    $xml = new \SimpleXMLElement('<table/>');
    if ($rs && $rs
      ->columnCount()) {
      foreach ($rs as $data) {
        $rownum++;
        $row_node = $xml
          ->addChild('row');
        $row_node['num'] = $rownum;
        foreach ($data as $key => $value) {
          $row_node
            ->addChild($key, htmlspecialchars($value));
        }

        /* If we are querying entities, we will store away IDs
         * for later querying and XML processing in the
         * loadEntitys method
         */
        if (@$options['entity_type'] && @$options['entity_id']) {
          $display = @$options['entity_display'];
          $id_key = $options['entity_id'];
          $type = $options['entity_type'];
          $id = $data->{$id_key};
          if ($id) {
            $entity_map[$id][] = $row_node;
            $select_fields[$id] = $data;
          }
        }
      }
    }
    if ($entity_map) {
      $this
        ->loadEntities($type, $entity_map, $select_fields, $display);
    }
    if ($this->debug) {
      $d = $xml ? htmlspecialchars($xml
        ->asXML()) : '';
      $this
        ->app()
        ->debug('SQL: ' . $sql, '<pre> SQL:' . $sql . "\n XML: " . $d . "\n</pre>");
    }
    return $xml;
  }

  /**
   * Perform a bulk load of entities.
   *
   * Enttities are loaded 100 at a time and then join data back onto the
   * simplexml already created.
   *
   * @param string $type
   *   Type of entity being loaded.
   * @param array $entity_map
   *   Map of entity ids to nodes.
   */
  private function loadEntities($type, $entity_map, $select_fields, $display = array()) {

    // Do these 100 at a time for performance reasons
    $chunks = array_chunk($entity_map, 100, TRUE);
    foreach ($chunks as $chunk) {
      $ids = array_keys($chunk);
      $data = entity_load($type, $ids);
      if ($data) {
        foreach ($data as $id => $e) {

          // Get node permissions
          $access = $type == 'node' ? node_access('view', $e) : TRUE;
          if (isset($entity_map[$id])) {
            foreach ($entity_map[$id] as $entry) {
              $row_node = $entry;
              $lang = isset($e->language) ? $e->language : 'und';

              // remove elements we don't have access to
              if (!$access) {
                unset($row_node[0]);
              }
              else {
                foreach ($e as $key => $val) {
                  if ($val && !isset($row_node->{$key})) {
                    if (strpos($key, 'field_') === 0) {

                      //$fields = field_get_items('node', $node, $key);
                      if (!$display) {
                        $display = 'default';
                      }
                      $field = field_view_field($type, $e, $key, $display);
                      $field['#theme'] = array(
                        'forena_inline_field',
                      );
                      $value = drupal_render($field);
                      $f = $row_node
                        ->addChild($key, htmlspecialchars($value));
                      if (isset($field['#field_type'])) {
                        $f['type'] = $field['#field_type'];
                      }
                      if (isset($field['#field_name'])) {
                        $f['name'] = $field['#field_name'];
                      }
                    }
                    else {
                      if (is_array($val) && isset($val[$lang])) {
                        $tmp = $val[$lang][0];
                        if (isset($tmp['safe_value'])) {
                          $row_node
                            ->addChild($key, htmlspecialchars($tmp['safe_value']));
                        }
                        else {
                          if (isset($tmp['value'])) {
                            $row_node
                              ->addChild($key, htmlspecialchars($tmp['value']));
                          }
                        }
                      }
                      else {
                        if (is_array($val) && isset($val['und'])) {
                          $tmp = $val['und'][0];
                          if (isset($tmp['safe_value'])) {
                            $row_node
                              ->addChild($key, htmlspecialchars($tmp['safe_value']));
                          }
                          else {
                            if (isset($tmp['value'])) {
                              $row_node
                                ->addChild($key, htmlspecialchars($tmp['value']));
                            }
                          }
                        }
                        else {
                          if (is_scalar($val)) {
                            $row_node
                              ->addChild($key, htmlspecialchars($val));
                          }
                        }
                      }
                    }
                  }
                }

                // Now add on select fields
                if ($select_fields[$id]) {
                  foreach ($select_fields[$id] as $key => $val) {
                    if (!isset($row_node->{$key})) {
                      $row_node
                        ->addChild($key, htmlspecialchars($val));
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }

  /**
   * Implement custom SQL formatter to make sure that strings are properly escaped.
   * Ideally we'd replace this with something that handles prepared statements, but it
   * wouldn't work for
   *
   * @param string $value
   *   Data value to foramt
   * @param string $key
   *   Name of token being formatted.
   * @param bool $raw
   *   True implies data should not be formatted for human consumption.
   * @return string
   *   Formatted replaced value.
   */
  public function format($value, $key, $raw = FALSE) {
    if ($raw) {
      return $value;
    }
    $db = Database::getConnection('default');
    $value = $this
      ->parmConvert($key, $value);
    if ($db) {
      if ($value === '' || $value === NULL) {
        $value = 'NULL';
      }
      else {
        if (is_array($value)) {
          if ($value == array()) {
            $value = 'NULL';
          }
          else {

            // Build a array of values string
            $i = 0;
            $val = '';
            foreach ($value as $v) {
              $i++;
              if ($i > 1) {
                $val .= ',';
              }
              $val .= $db
                ->quote($v);
            }
            $value = $val;
          }
        }
        elseif (is_int($value)) {
          $value = (int) $value;
          $value = (string) $value;
        }
        elseif (is_float($value)) {
          $value = (double) $value;
          $value = (string) $value;
        }
        else {
          $value = trim($value);
          $value = $db
            ->quote($value);
        }
      }
    }
    return $value;
  }

}

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::searchTableColumnsSQL	public	function
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.
FrxDrupal::$database	private	property	Implements hooks into the drupal applications
FrxDrupal::format	public	function	Implement custom SQL formatter to make sure that strings are properly escaped. Ideally we'd replace this with something that handles prepared statements, but it wouldn't work for
FrxDrupal::loadEntities	private	function	Perform a bulk load of entities.
FrxDrupal::query	public	function
FrxDrupal::searchTableColumns	public	function	Generate a list of columns for a table. Overrides DriverBase::searchTableColumns
FrxDrupal::searchTables	public	function	Method to return an array of tables that start with the string indicated in $str Overrides DriverBase::searchTables
FrxDrupal::sqlData	public	function	Get data based on file data block in the repository.
FrxDrupal::__construct	public	function	Object constructor Overrides DriverBase::__construct

You are here

class FrxDrupal in Forena Reports 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation