You are here

Home » API reference » Quick Tabs 7.3 » QuickViewContent.inc

class QuickViewContent in Quick Tabs 7.3

Class for tab content of type "view" - this is for rendering a view as tab content.

Hierarchy

Expanded class hierarchy of QuickViewContent

1 string reference to 'QuickViewContent'
quicktabs_quicktabs_contents in ./quicktabs.module
Implements hook_quicktabs_contents().

File

plugins/QuickViewContent.inc, line 7

View source 
class QuickViewContent extends QuickContent {

  // Each view that we render, whether via ajax or not, will need a unique DOM
  // id. Unfortunately we can only control the ones that Quicktabs is responsible
  // for, so if there are other views on the page, there may be duplicate ids.
  static $view_dom_id = 1;
  public static function getType() {
    return 'view';
  }
  public function optionsForm($delta, $qt) {
    $tab = $this->settings;
    $form = array();
    $views = quicktabs_get_views();
    $views_keys = array_keys($views);
    $selected_view = isset($tab['vid']) ? $tab['vid'] : (isset($views_keys[0]) ? $views_keys[0] : '');
    $form['view']['vid'] = array(
      '#type' => 'select',
      '#options' => $views,
      '#default_value' => $selected_view,
      '#title' => t('Select a view'),
      '#ajax' => array(
        'callback' => '_quicktabs_replace_view_displays_callback',
      ),
    );
    $form['view']['display'] = array(
      '#type' => 'select',
      '#title' => 'display',
      '#options' => _quicktabs_get_views_displays($selected_view),
      '#default_value' => isset($tab['display']) ? $tab['display'] : '',
      '#prefix' => '<div id="view-display-dropdown-' . $delta . '">',
      '#suffix' => '</div>',
    );
    $form['view']['args'] = array(
      '#type' => 'textfield',
      '#title' => 'arguments',
      '#size' => '40',
      '#required' => FALSE,
      '#default_value' => isset($tab['args']) ? $tab['args'] : '',
      '#description' => t('Additional arguments to send to the view as if they were part of the URL in the form of arg1/arg2/arg3. You may use %0, %1, ..., %N to grab arguments from the URL.'),
    );
    $form['view']['use_title'] = array(
      '#type' => 'checkbox',
      '#return_value' => TRUE,
      '#title' => 'Use display title',
      '#default_value' => isset($tab['use_title']) ? $tab['use_title'] : FALSE,
      '#description' => t('Should quicktabs use the rendered title of the view?'),
    );
    return $form;
  }
  public function __construct($item) {
    parent::__construct($item);
    if (module_exists('views')) {
      views_add_js('ajax_view');
    }
    $this->settings['view_path'] = rawurlencode($_GET['q']);
    $this->settings['view_dom_id'] = self::$view_dom_id++;
    $args_array = array();
    $ajax_args = '';
    if (isset($item['args'])) {
      $url_args = arg();
      $args = $item['args'];
      foreach ($url_args as $id => $arg) {
        $args = str_replace("%{$id}", $arg, $args);
      }
      $args = preg_replace(',/?(%\\d),', '', $args);
      if (!empty($args)) {
        $ajax_args = rawurlencode($args);
        $args_array = explode('/', $args);
      }
    }
    $this->settings['ajax_args'] = $ajax_args;
    $this->settings['actual_args'] = $args_array;
  }
  public function render($hide_empty = FALSE, $args = array()) {
    if (!empty($args)) {

      // The args have been passed in from an ajax request. We use Views' own
      // ajax functionality to get the view.
      // The first element of the args array is the qt_name, which we don't need
      // for this content type.
      array_shift($args);

      // The order of these arguments corresponds to the array returned in
      // $this->getAjaxKeys().
      $_REQUEST['view_name'] = array_shift($args);
      $_REQUEST['view_display_id'] = array_shift($args);
      $_REQUEST['view_dom_id'] = array_shift($args);
      $view_path = array_shift($args);
      $_REQUEST['view_path'] = rawurldecode($view_path);
      if (!empty($args)) {
        $view_args = array_shift($args);
        $_REQUEST['view_args'] = rawurldecode($view_args);
      }
      module_load_include('inc', 'views', 'includes/ajax');
      $view = views_ajax();
      foreach ($view['#commands'] as $command) {
        if ($command['command'] == 'insert') {
          return array(
            '#markup' => trim($command['data']),
          );
        }
      }
      return array();
    }

    // Non-ajax rendering of a view.
    if ($this->rendered_content) {
      return $this->rendered_content;
    }
    $item = $this->settings;
    $output = array();
    if (isset($item['vid'])) {
      if (module_exists('views')) {
        if ($view = views_get_view($item['vid'])) {
          if ($view
            ->access($item['display'])) {
            $view
              ->set_display($item['display']);
            $view
              ->set_arguments($item['actual_args']);
            $view_output = $view
              ->preview();
            if (!empty($view->result) || $view->display_handler
              ->get_option('empty') || !empty($view->style_plugin->definition['even empty'])) {
              $output['#markup'] = $view_output;
            }
          }
          elseif (!$hide_empty) {
            $output['#markup'] = theme('quicktabs_tab_access_denied', array(
              'tab' => $item,
            ));
          }
          if (isset($this->settings['use_title']) && $this->settings['use_title'] > 0) {
            $this->title = $view
              ->get_title();
          }
          $view
            ->destroy();
        }
      }
      elseif (!$hide_empty) {
        $output['#markup'] = t('Views module is not enabled, cannot display content.');
      }
    }
    $this->rendered_content = $output;
    return $output;
  }
  public function getAjaxKeys() {
    return array(
      'vid',
      'display',
      'view_dom_id',
      'view_path',
      'ajax_args',
    );
  }
  public function getUniqueKeys() {
    return array(
      'vid',
      'display',
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
QuickContent::$rendered_content protected property A render array of the contents.
QuickContent::$settings protected property An array containing the information that defines the tab content, specific to its type.
QuickContent::$title protected property Used as the title of the tab.
QuickContent::factory public static function Instantiate a content type object.
QuickContent::getSettings public function Accessor for the tab settings. Overrides QuickContentRenderable::getSettings
QuickContent::getTitle public function Accessor for the tab title. Overrides QuickContentRenderable::getTitle
QuickViewContent::$view_dom_id static property
QuickViewContent::getAjaxKeys public function Returns an array of keys to use for constructing the correct arguments for an ajax callback to retrieve content of this type. The order of the keys returned affects the order of the args passed in to the render method when called via ajax (see the… Overrides QuickContentRenderable::getAjaxKeys
QuickViewContent::getType public static function Returns the short type name of the content plugin, e.g. 'block', 'node', 'prerendered'. Overrides QuickContentRenderable::getType
QuickViewContent::getUniqueKeys public function Returns an array of keys, sufficient to represent the content uniquely. Overrides QuickContentRenderable::getUniqueKeys
QuickViewContent::optionsForm public function Method for returning the form elements to display for this tab type on the admin form. Overrides QuickContent::optionsForm
QuickViewContent::render public function Renders the content. Overrides QuickContentRenderable::render
QuickViewContent::__construct public function Constructor Overrides QuickContent::__construct