references_dialog_plugin_display.inc in References dialog 7

Contains the default display plugin.

File

views/references_dialog_plugin_display.inc

<?php

/**
 * @file
 * Contains the default display plugin.
 */

/**
 * A plugin to handle defaults on a view.
 *
 * @ingroup views_display_plugins
 */
class references_dialog_plugin_display extends views_plugin_display {
  function option_definition() {
    $options = parent::option_definition();

    // Allow the use of any style plugin.
    unset($options['style_plugin']['default']);
    $options['defaults']['default']['style_plugin'] = TRUE;
    $options['defaults']['default']['style_options'] = FALSE;
    $options['row_plugin']['default'] = 'fields';
    $options['defaults']['default']['row_plugin'] = FALSE;
    $options['defaults']['default']['row_options'] = FALSE;

    // Set the things we actually add with this plugin.
    $options['attach'] = array(
      'default' => array(),
    );
    return $options;
  }
  function options_summary(&$categories, &$options) {
    parent::options_summary($categories, $options);
    $categories['references_dialog'] = array(
      'title' => t('References Dialog'),
      'column' => 'second',
      'build' => array(
        '#weight' => -10,
      ),
    );
    $attachables = $this
      ->get_option('attach');
    $options['attach'] = array(
      'category' => 'references_dialog',
      'title' => t('Attached to'),
      'value' => views_ui_truncate(implode(',', $attachables), 24),
    );
  }
  function get_entity_type() {

    // Find the entity that matches our base table.
    $entities = entity_get_info();
    foreach ($entities as $entity_type => $entity_info) {
      if ($entity_info['base table'] == $this->view->base_table) {
        return $entity_type;
      }
    }
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    if ($form_state['section'] == 'attach') {

      // Find the entity that matches our base table.
      $entities = entity_get_info();
      foreach ($entities as $entity_type => $entity_info) {
        if ($entity_info['base table'] == $this->view->base_table) {
          break;
        }
      }
      $attachables = references_dialog_get_search_view_attachables($entity_type);
      $options = array();
      foreach ($attachables as $name => $attachable) {
        $options[$name] = $attachable['label'];
      }
      $form['attach'] = array(
        '#type' => 'checkboxes',
        '#options' => $options,
        '#default_value' => $this
          ->get_option('attach'),
        '#title' => t('Attach to'),
        '#description' => t('Choose what to attach this view to.'),
      );
    }
  }
  function options_submit(&$form, &$form_state) {
    parent::options_submit($form, $form_state);
    if ($form_state['section'] == 'attach') {
      $this
        ->set_option('attach', $this
        ->_sanitize_checkboxes($form_state['values']['attach']));
    }
  }
  function _sanitize_checkboxes($boxes) {
    $sanitized = array();
    foreach ($boxes as $key => $box) {
      if ($box) {
        $sanitized[] = $box;
      }
    }
    return $sanitized;
  }
  function _set_access_arguments(&$items) {
    $access_plugin = $this
      ->get_plugin('access');
    if (!isset($access_plugin)) {
      $access_plugin = views_get_plugin('access', 'none');
    }

    // Get access callback might return an array of the callback + the dynamic arguments.
    $access_plugin_callback = $access_plugin
      ->get_access_callback();
    if (is_array($access_plugin_callback)) {
      $access_arguments = array();

      // Find the plugin arguments.
      $access_plugin_method = array_shift($access_plugin_callback);
      $access_plugin_arguments = array_shift($access_plugin_callback);
      if (!is_array($access_plugin_arguments)) {
        $access_plugin_arguments = array();
      }
      $access_arguments[0] = array(
        $access_plugin_method,
        &$access_plugin_arguments,
      );

      // Move the plugin arguments to the access arguments array.
      $i = 1;
      foreach ($access_plugin_arguments as $key => $value) {
        if (is_int($value)) {
          $access_arguments[$i] = $value;
          $access_plugin_arguments[$key] = $i;
          $i++;
        }
      }
    }
    else {
      $access_arguments = array(
        $access_plugin_callback,
      );
    }
    foreach ($items as &$item) {
      $item['access arguments'] = $access_arguments;
    }
  }
  function execute_hook_menu() {
    $items = array();
    $attachables = $this
      ->get_option('attach');
    $view_name = $this->view->name;
    $display_name = $this->display->id;
    foreach ($attachables as $attachable) {
      $items['references-dialog/search/' . $view_name . '/' . $display_name . '/' . $attachable] = array(
        'type' => MENU_CALLBACK,
        'page callback' => 'references_dialog_search_view',
        'page arguments' => array(
          $view_name,
          $display_name,
          $attachable,
        ),
        'access callback' => 'views_access',
      );
    }
    $this
      ->_set_access_arguments($items);
    return $items;
  }
  function uses_exposed() {
    return TRUE;
  }

  /**
   * Override references_plugin_display, and
   * allow for other style types.
   */
  function get_style_type() {
    return 'normal';
  }
  function get_path() {

    // If we have information about the instance, then use it to build the proper
    // path.
    if (isset($this->view->references_dialog['attachable'])) {
      $attachable =& $this->view->references_dialog['attachable']['name'];
      $view_name = $this->view->name;
      $display_name = $this->display->id;
      return 'references-dialog/search/' . $view_name . '/' . $display_name . '/' . $attachable;
    }
    else {
      return parent::get_path();
    }
  }
  function execute() {

    // Let the world know that this is the page view we're using.
    views_set_page_view($this->view);

    // Prior to this being called, the $view should already be set to this
    // display, and arguments should be set on the view.
    $this->view
      ->build();
    if (!empty($this->view->build_info['fail'])) {
      return drupal_not_found();
    }
    $this->view
      ->get_breadcrumb(TRUE);

    // And the title, which is much easier.
    drupal_set_title(filter_xss_admin($this->view
      ->get_title()), PASS_THROUGH);
    $content = $this->view
      ->render();
    return $content;
  }
  function query() {

    // At this point we need to see if our widget needs to inject something
    // into the query in order to filter out unwanted data.
    if (isset($this->view->references_dialog['attachable']['query'])) {
      $this->view->references_dialog['attachable']['query']($this->view);
    }
  }
  function render() {
    $output = theme($this
      ->theme_functions(), array(
      'view' => $this->view,
    ));

    // Let's add the data necessary to javascript, so that we can
    // act upon it there.
    $js_result = array();
    $entity_type = $this
      ->get_entity_type();

    // The only safe way to determine the title of each item is to load the entities.
    // We also need to know the specific
    $entity_ids = array();
    foreach ($this->view->result as $row => $result) {
      $entity_ids[] = $result->{$this->view->base_field};
    }
    $entities = entity_load($entity_type, $entity_ids);
    foreach ($this->view->result as $result) {
      $js_result[] = array(
        'entity_id' => $result->{$this->view->base_field},
        'title' => entity_label($entity_type, $entities[$result->{$this->view->base_field}]),
        'entity_type' => $entity_type,
      );
    }
    drupal_add_js(drupal_get_path('module', 'references_dialog') . '/js/search-reference.js');
    drupal_add_js(array(
      'ReferencesDialog' => array(
        'entities' => $js_result,
      ),
    ), 'setting');
    return $output;
  }

}

Classes

Name	Description
references_dialog_plugin_display	A plugin to handle defaults on a view.