views_content.module in Chaos Tool Suite (ctools) 7

Provides views as panels content, configurable by the administrator. Each view provided as panel content must be configured in advance, but once configured, building panels with views is a little bit simpler.

File

views_content/views_content.module

<?php

/**
 * @file
 * Provides views as panels content, configurable by the administrator.
 * Each view provided as panel content must be configured in advance,
 * but once configured, building panels with views is a little bit simpler.
 */

/**
 * Implements hook_menu().
 */
function views_content_menu() {
  $items = array();
  if (!module_exists('panels')) {
    $items['admin/config/content-views'] = array(
      'title' => 'Views panes',
      'access arguments' => array(
        'administer views content plugin',
      ),
      'page callback' => 'drupal_get_form',
      'page arguments' => array(
        'views_content_admin_page',
      ),
      'description' => 'Configure Views to be used as CTools content.',
      'type' => MENU_NORMAL_ITEM,
    );
  }
  return $items;
}

/**
 * Implements hook_ctools_plugin_dierctory().
 *
 * To let the system know where our content_type plugins are.
 */
function views_content_ctools_plugin_directory($owner, $plugin_type) {
  if ($owner == 'ctools') {
    return 'plugins/' . $plugin_type;
  }
}

/**
 * Don't show Views' blocks; we expose them already.
 */
function views_ctools_block_info($module, $delta, &$info) {
  if (strlen($delta) == 32) {
    $hashes = variable_get('views_block_hashes', array());
    if (!empty($hashes[$delta])) {
      $delta = $hashes[$delta];
    }
  }
  if (substr($delta, 0, 1) != '-') {
    $info = NULL;
  }
  else {
    $info['category'] = t('Views');
    $info['icon'] = 'icon_views_block_legacy.png';
    $info['path'] = drupal_get_path('module', 'views_content');
    $info['edit form'] = 'views_content_exposed_form_pane_edit';
    $info['add form'] = 'views_content_exposed_form_pane_edit';
    $info['render callback'] = 'views_content_exposed_form_pane_render';
  }
}

/**
 * Add settings to the "exposed form in block" views.
 */
function views_content_exposed_form_pane_edit($form, &$form_state) {

  // This is a cheesy way to add defaults only to new versions of the block
  // but leave older blocks without the setting alone. We can tell because
  // all older content will have something set for override_title which is
  // the only pre-existing setting.
  if (!isset($form_state['conf']['inherit_path']) && !isset($form_state['conf']['override_title'])) {
    $form_state['conf']['inherit_path'] = TRUE;
  }
  $form['inherit_path'] = array(
    '#type' => 'checkbox',
    '#title' => t('Inherit path'),
    '#default_value' => !empty($form_state['conf']['inherit_path']),
  );
  return $form;
}

/**
 * Store data for the exposed form in block settings page.
 */
function views_content_exposed_form_pane_edit_submit($form, &$form_state) {
  $form_state['conf']['inherit_path'] = $form_state['values']['inherit_path'];
}

/**
 * Render function for 'special' view blocks.
 *
 * We took over the render for the special view blocks so that we could
 * add options to it.
 */
function views_content_exposed_form_pane_render($subtype, $conf, $panel_args, $contexts) {
  $delta = str_replace('views-', '', $subtype);
  if (strlen($delta) == 32) {
    $hashes = variable_get('views_block_hashes', array());
    if (!empty($hashes[$delta])) {
      $delta = $hashes[$delta];
    }
  }
  list($nothing, $type, $name, $display_id) = explode('-', $delta);

  // Put the - back on. For views special blocks, the first character is always - but
  // the explode killed it. Note that this code is mostly copied from views_block().
  $type = '-' . $type;
  if ($view = views_get_view($name)) {
    if ($view
      ->access($display_id)) {
      if (!empty($conf['inherit_path'])) {
        $view->override_path = $_GET['q'];
      }
      $view
        ->set_display($display_id);
      if (isset($view->display_handler)) {
        $block = (object) $view->display_handler
          ->view_special_blocks($type);
        return $block;
      }
    }
    $view
      ->destroy();
  }
}

/**
 * Implements hook_views_api().
 *
 * This one is used as the base to reduce errors when updating.
 */
function views_content_views_api() {
  return array(
    'api' => 2,
    'path' => drupal_get_path('module', 'views_content') . '/plugins/views',
  );
}

/**
 * Page callback to provide the basic administration form.
 */
function views_content_admin_page() {
  $form = array();
  views_content_admin_form($form);
  return system_settings_form($form);
}
function views_content_admin_form(&$form) {
  $form['ctools_content_all_views'] = array(
    '#type' => 'checkbox',
    '#title' => t('Make all views available as panes'),
    '#description' => t("If checked, all views will be made available as content panes to be added to content types. If not checked, only Views that have a 'Content pane' display will be available as content panes. Uncheck this if you want to be able to more carefully control what view content is available to users using the panels layout UI."),
    '#default_value' => variable_get('ctools_content_all_views', TRUE),
  );
}

/**
 * API function to get the view.
 */
function views_content_context_get_view(&$context) {
  if (empty($context->view) || get_class($context->view) == '__PHP_Incomplete_Class') {
    $context->view = views_get_view($context->data['name']);
    if ($context->view) {
      $context->view
        ->set_display($context->data['display']);
      $context->view
        ->set_arguments($context->data['args']);
    }
  }
  return $context->view;
}

/**
 * API function to get the view.
 */
function views_content_context_get_output(&$context) {
  if (empty($context->output)) {
    $view = views_content_context_get_view($context);
    $context->output = $view
      ->execute_display($context->data['display']);
  }
  return $context->output;
}

/**
 * Get the title to display for a views content display for pane or context.
 */
function views_content_get_display_title($view, $display_id, $option = 'pane_title') {
  $handler = $view->display[$display_id]->handler;
  $title = $handler
    ->get_option($option);
  if (!$title) {
    if ($handler->display->display_title == $handler->definition['title']) {
      $title = t('View: @view', array(
        '@view' => $view
          ->get_human_name(),
      ));
    }
    else {
      $title = t('View: @view: @display', array(
        '@view' => $view
          ->get_human_name(),
        '@display' => $handler->display->display_title,
      ));
    }
  }
  return $title;
}

/**
 * Get the proper label for a display.
 *
 * Views renamed the default to Master, but it can still have a conflicting
 * display title. Fix that.
 */
function views_content_get_display_label($view, $display_id) {
  $title = $display_id == 'default' ? t('Master') : $view->display[$display_id]->display_title;
  return $title;
}

/**
 * Get the child plugin for a view context display.
 *
 * This can return both the context and relationship style. The
 * $required parameter is used to distinguish if context is required
 * or not, so we know whether we need it suitable as a pure context
 * (i.e, no context required) or a relationship (i.e, context required).
 */
function _views_content_get_context_from_display($view, $id, $parent, $required = TRUE) {
  $title = views_content_get_display_title($view, $id, 'admin_title');
  $description = $view->description;
  $contexts = array();
  $arguments = $view->display_handler
    ->get_argument_input();
  ctools_include('views');
  foreach ($arguments as $argument) {
    $argument['label'] = $argument['name'] ? $argument['name'] : '';
    $contexts[] = ctools_views_get_argument_context($argument);
  }
  $pass = FALSE;
  if ($required) {

    // If context is required, make sure we have at least one optional
    // or required context.
    foreach ($contexts as $context) {
      if (is_object($context)) {
        $pass = TRUE;
        break;
      }
    }
    if (!$pass) {
      return;
    }
  }
  else {

    // If context is not required, then having any required context
    // causes a fail.
    foreach ($contexts as $context) {
      if (is_object($context) && get_class($context) == 'ctools_context_required') {
        return;
      }
    }

    // Since we know we don't want contexts, we an unset this now.
    $contexts = array();
  }
  if ($required) {
    $function = 'views_content_view_from_argument_context';
  }
  else {
    $function = 'views_content_context_view_create';
  }
  return array(
    'title' => $title,
    'description' => filter_xss_admin($description),
    'required context' => $contexts,
    'keyword' => 'view',
    'context' => $function,
    'context name' => $view->name,
    'name' => $parent . ':' . $view->name . '-' . $id,
    'view name' => $view->name,
    'view display id' => $id,
  );
}

/**
 * Implements hook_get_pane_links_alter().
 */
function views_content_get_pane_links_alter(&$links, $pane, $content_type) {
  if ($pane->type === 'views_panes') {
    list($view_name, $display_name) = explode('-', $pane->subtype);
    $destination = array(
      'destination' => current_path(),
    );
    $links['top'][] = array(
      'title' => t('Edit view'),
      'href' => url('admin/structure/views/view/' . $view_name . '/edit/' . $display_name, array(
        'query' => $destination,
        'absolute' => TRUE,
      )),
    );
  }
}

Functions

Name	Description
views_content_admin_form
views_content_admin_page	Page callback to provide the basic administration form.
views_content_context_get_output	API function to get the view.
views_content_context_get_view	API function to get the view.
views_content_ctools_plugin_directory	Implements hook_ctools_plugin_dierctory().
views_content_exposed_form_pane_edit	Add settings to the "exposed form in block" views.
views_content_exposed_form_pane_edit_submit	Store data for the exposed form in block settings page.
views_content_exposed_form_pane_render	Render function for 'special' view blocks.
views_content_get_display_label	Get the proper label for a display.
views_content_get_display_title	Get the title to display for a views content display for pane or context.
views_content_get_pane_links_alter	Implements hook_get_pane_links_alter().
views_content_menu	Implements hook_menu().
views_content_views_api	Implements hook_views_api().
views_ctools_block_info	Don't show Views' blocks; we expose them already.
_views_content_get_context_from_display	Get the child plugin for a view context display.