class BlockEditor in Forena Reports 8

Same name and namespace in other branches

7.5 src/Editor/BlockEditor.php \Drupal\forena\Editor\BlockEditor

Hierarchy

class \Drupal\forena\Editor\BlockEditor uses FrxAPI

Expanded class hierarchy of BlockEditor

File

src/Editor/BlockEditor.php, line 6

Namespace

Drupal\forena\Editor

View source

class BlockEditor {
  use FrxAPI;
  private static $instance;
  public $block = array();
  public $block_name;
  public $modified;
  public $provider;
  public $cache = FALSE;

  // Turn on caching of parameter to facilitate block caching.
  private $teng;
  public $edit;
  private $builders;
  private $new_block = array(
    'type' => 'sql',
    'file' => '',
    'access' => '',
    'source' => '',
    'info' => array(),
  );
  public function __construct($block_name = '', $edit = TRUE) {
    $this->edit = $edit;
    if ($block_name) {
      $this
        ->load($block_name, $edit);
    }
    $this->teng = FrxAPI::SyntaxEngine(FRX_SQL_TOKEN, ':');
  }

  /**
   * Block loader method.
   * @param string $block_name
   *   Name of block to load.
   * @return array
   *   block definition
   */
  public function load($block_name, $edit = TRUE) {
    $block_name = str_replace('.', '/', $block_name);
    @(list($provider, $path) = explode('/', $block_name, 2));
    $this->provider = $provider;
    $this->block_name = $block_name;
    if (isset($_SESSION['forena_query_editor'][$block_name]) && $edit) {
      $block = $_SESSION['forena_query_editor'][$block_name];
      drupal_set_message(t('All changes are stored temporarily.  Click Save to make your changes permanent.  Click Cancel to discard your changes.'), 'warning', FALSE);
      $this->modified = TRUE;
    }
    else {
      $block = $this
        ->dataManager()
        ->loadBlock($block_name);
      $this->modified = FALSE;
      if (!$block) {
        $block = $this->block = $this->new_block;
        $this
          ->update($this->block);
      }
    }
    $this->block = $block;
    return $block;
  }

  /**
   * Update the block data.
   * @param array $block
   *   Data block definition.
   * @return BlockEditor
   */
  public function update($block = array()) {
    if ($block) {

      // Make sure we don't put any invalid values
      $block = array_intersect_key($block, $this->block);
      $block = array_merge($this->block, $block);
      $same = $block['file'] == $this->block['file'] && @$block['access'] == @$this->block['access'];

      // UPdate the block;
      if (!$same) {
        $this->block = $block;
        $_SESSION['forena_query_editor'][$this->block_name] = $this->block;
        $this->modified = TRUE;
      }
    }
    return $this;
  }

  /**
   * Saves the data block
   */
  public function save() {
    $this
      ->dataManager()
      ->saveBlock($this->block_name, $this->block);
    unset($_SESSION['forena_query_editor'][$this->block_name]);
    drupal_get_messages('warning');
    drupal_set_message(t('Saved Changes'));
    return $this;
  }

  /**
   * Cancel the editing event.
   */
  public function cancel() {
    unset($_SESSION['forena_query_editor'][$this->block_name]);
    drupal_get_messages('warning');
    $this->modified = FALSE;
  }

  /**
   * Return repository.
   * @return DriverInterface
   */
  public function repos() {
    return $this
      ->dataManager()
      ->repository($this->provider);
  }

  /**
   * Rename the exisiting block.
   * @param string $name
   */
  public function rename($name) {
    $old_name = $this->{$block_name};
    unset($_SESSION['forea_query_editor'][$old_name]);
    $this->{$block_name} = $this->provider . '/' . $name;
    $this
      ->update($this->block);
  }

  /**
   * Get data and working cache.
   * @param array $parms
   * @return \SimpleXMLElement | string
   */
  public function data($parms = array(), $raw_mode = FALSE) {

    // Merge in current_context
    $parms = array_merge($this
      ->currentDataContextArray(), $parms);
    $report_parms = $this
      ->getDataContext('parm');
    if ($report_parms) {
      $parms = array_merge($report_parms, $parms);
    }
    $id = str_replace('/', '-', $this->block_name) . '-parm';
    $this
      ->pushData($parms, $id);
    if ($this->edit && $this->provider) {
      $xml = $this
        ->dataManager()
        ->sqlData($this->provider, $this->block['file'], $parms);
    }
    else {
      $xml = $this
        ->dataManager()
        ->data($this->block_name, $raw_mode);
    }
    $driver = get_class($this
      ->dataManager()
      ->repository($this->provider));

    // Allow modules to alter data returned.
    $context = array(
      'block' => $this->block_name,
      'definition' => $this->block,
      'provider' => $this->provider,
      'parameters' => $parms,
      'raw_mode' => $raw_mode,
      'driver' => $driver,
    );
    drupal_alter('forena_data', $xml, $context);
    if ($parms) {
      $this
        ->popData();
    }
    return $xml;
  }

  /**
   * Writes blocks from the old db structure to the new one.
   */
  public function revertDBBLocks() {
    $block = array();
    $fo = FrxAPI::DataFile();
    if (db_table_exists('forena_data_blocks') && is_writable($fo->dir)) {

      // Get all blocks from the db.
      $sql = 'SELECT * FROM {forena_data_blocks} order by repository, block_name';
      $rs = db_query($sql);
      $empty_table = TRUE;
      foreach ($rs as $b) {
        $block = array(
          'repository' => $b->repository,
          'block_name' => $b->block_name,
          'type' => $b->block_type,
          'file' => $b->src,
          'builder' => $b->builder,
          'access' => $b->access,
          'title' => $b->title,
          'locked' => $b->locked,
          'modified' => $b->modified,
        );
        $d = $this
          ->dataManager()
          ->repository($b->repository);
        $block = array_merge($block, $d
          ->parseSQLFile($block['file']));
        if ($block['builder']) {
          $block['builder'] = unserialize($block['builder']);
        }
        $path = $b->repository . '/' . $b->block_name;
        $this
          ->dataManager()
          ->saveBlock($path, $block);
        if (FrxAPI::DataFile()
          ->isCustom($path . '.sql')) {
          db_delete('forena_data_blocks')
            ->condition('repository', $b->repository)
            ->condition('block_name', $b->block_name)
            ->execute();
        }
        $empty_table = FALSE;
      }
      if ($empty_table) {
        db_drop_table('forena_data_blocks');
      }
      $fo
        ->validateAllCache();
    }
  }

  /**
   * Return the tokens for the block.
   */
  public function tokens() {

    // skip non-sql blocks
    if (!isset($this->block['file'])) {
      return array();
    }
    $block = $this
      ->dataManager()
      ->sqlBlock($this->provider, $this->block['file']);
    $tokens = @$block['tokens'];
    $c_idx = array_search('current_user', $tokens);
    if ($c_idx !== FALSE) {
      unset($tokens[$c_idx]);
    }
    return $tokens;
  }

  /**
   * Get persisted parateters from a block from a session.
   */
  public function getParms() {
    return $_SESSION['forena_data_block_parms'][$this->block_name];
  }

  /**
   * Persist paramaters for a block into a session
   */
  public function saveParms() {
    $parms = FrxAPI::Data()
      ->getContext('parm');
    $_SESSION['forena_data_block_parms'][$this->block_name] = $parms;
  }

  /**
   * Instantiate the builders if necessary
   */
  public function getBuilders() {
    if (!$this->builders) {
      $this->builders = array();
      $builders = \Drupal::moduleHandler()
        ->invokeAll('forena_query_builders');
      foreach ($builders as $builder) {
        if (isset($builder['file'])) {
          @(include_once $builder['file']);
        }
        if (class_exists($builder['class'])) {
          $b = new $builder['class']();
          $this->builders[$builder['class']] = $b;
        }
      }
    }
  }
  public function builderList() {
    $this
      ->getBuilders();
    $r = $this
      ->dataManager()
      ->repository($this->provider);
    $plugin = get_class($r);
    $list = array();
    foreach ($this->builders as $class => $b) {
      if (array_search($plugin, $b->supportedPlugins) !== FALSE && $b->name && $b->type == $this->block['type']) {
        $list[$class] = $b->name;
      }
    }
    asort($list);
    return $list;
  }

  /**
   * Use the classes configForm method to build the form.
   * @param $builder
   * @param $config
   * @return array
   *   Form elements
   */
  public function configForm($builder, &$config) {
    $this
      ->getBuilders();
    $form = array();
    if (isset($this->builders[$builder])) {
      $b = $this->builders[$builder];
      if (method_exists($b, 'configForm')) {
        $form = $b
          ->configForm($config);
      }
    }
    return $form;
  }

  /**
   * Use the classes generate method to generate the block.
   * @param $builder
   * @param $config
   * @return array
   *   Template configuration
   */
  public function generate($builder, &$config) {
    $this
      ->getBuilders();
    $form = array();
    if (isset($this->builders[$builder])) {
      $b = $this->builders[$builder];
      if (method_exists($b, 'generate')) {
        $form = $b
          ->generate($config);
      }
    }
    return $form;
  }

  /**
   * Use the classes validate method to validate the block.
   * @param $builder
   * @param $config
   * @return array
   *   errors by field name.
   */
  public function configValidate($builder, &$config) {
    $this
      ->getBuilders();
    $errors = array();
    if (isset($this->builders[$builder])) {
      $b = $this->builders[$builder];
      if (method_exists($b, 'configValidate')) {
        $errors = $b
          ->configValidate($config);
      }
      if ($errors) {
        foreach ($errors as $name => $error) {
          form_set_error($name, $error);
        }
      }
    }
    return $errors;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockEditor::$block	public	property
BlockEditor::$block_name	public	property
BlockEditor::$builders	private	property
BlockEditor::$cache	public	property
BlockEditor::$edit	public	property
BlockEditor::$instance	private static	property
BlockEditor::$modified	public	property
BlockEditor::$new_block	private	property
BlockEditor::$provider	public	property
BlockEditor::$teng	private	property
BlockEditor::builderList	public	function
BlockEditor::cancel	public	function	Cancel the editing event.
BlockEditor::configForm	public	function	Use the classes configForm method to build the form.
BlockEditor::configValidate	public	function	Use the classes validate method to validate the block.
BlockEditor::data	public	function	Get data and working cache.
BlockEditor::generate	public	function	Use the classes generate method to generate the block.
BlockEditor::getBuilders	public	function	Instantiate the builders if necessary
BlockEditor::getParms	public	function	Get persisted parateters from a block from a session.
BlockEditor::load	public	function	Block loader method.
BlockEditor::rename	public	function	Rename the exisiting block.
BlockEditor::repos	public	function	Return repository.
BlockEditor::revertDBBLocks	public	function	Writes blocks from the old db structure to the new one.
BlockEditor::save	public	function	Saves the data block
BlockEditor::saveParms	public	function	Persist paramaters for a block into a session
BlockEditor::tokens	public	function	Return the tokens for the block.
BlockEditor::update	public	function	Update the block data.
BlockEditor::__construct	public	function
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.

You are here

class BlockEditor in Forena Reports 8

Hierarchy

File

Namespace

Members

API Navigation