tvi.admin.inc in Taxonomy Views Integrator 6

TVI Administration Interface

File

includes/tvi.admin.inc

<?php

// $Id: tvi.admin.inc,v 1.1 2009/12/04 01:40:56 awebb Exp $

/**
 * @file
 * TVI Administration Interface
 */

/**
 * @defgroup menu callbacks
 * @{
 */

/**
 * Returns html option set of available displays for view with specified view id
 */
function tvi_display_options_ahah() {
  $view_name = $_GET['view_name'];
  $options = '';
  if (strlen($view_name) > 0) {
    foreach (tvi_get_view_displays($view_name) as $name => $label) {
      $options .= "<option value='{$name}'>{$label}</option>";
    }
  }
  print $options;
  exit;
}

/**
 * Form builder for the tvi_settings_form() form.
 *
 * @ingroup forms
 */
function tvi_settings_form($form_state) {
  $form = array();
  $form['tvi_default_view_skip'] = array(
    '#type' => 'checkbox',
    '#title' => t('Disable search for default view'),
    '#default_value' => variable_get('tvi_default_view_skip', 0),
    '#description' => t('When there is no view specified for a given term and vocabulary, TVI tries to find a view whose arguments are matching with taxonomy terms. If you have such a view but want to use the default taxonomy page, please enable this checkbox.'),
  );
  return system_settings_form($form);
}

/**
 * @} End of "defgroup menu callbacks".
 * 
 * @defgroup forms
 * @{
 */

/**
 * Adds TVI administration form to the vocabulary edit page
 *
 * admin/content/taxonomy/edit/vocabulary/$vid
 */
function tvi_vocab_form(&$form) {
  if (!($vid = $form['vid']['#value'])) {
    return;
  }

  // A bit of re-ordering
  $form['identification']['#weight'] = -4;

  // core taxonomy fieldset
  $form['content_types']['#weight'] = -3;

  // core taxonomy fieldset
  $form['settings']['#weight'] = -2;

  // core taxonomy fieldset
  tvi_include('query');
  tvi_taxonomy_admin_form($form, tvi_load_settings($vid, TVI_TYPE_VOCAB));
}

/**
 * Adds TVI administration form to the term edit page
 *
 * admin/content/taxonomy/edit/term/$tid
 */
function tvi_term_form(&$form) {
  if (!($tid = $form['#term']['tid'])) {
    return;
  }

  // A bit of re-ordering
  $form['identification']['#weight'] = -2;

  // core taxonomy fieldset
  $form['advanced']['#weight'] = 0;

  // core taxonomy fieldset
  tvi_include('query');
  tvi_taxonomy_admin_form($form, tvi_load_settings($tid, TVI_TYPE_TERM));
}

/**
 * Form builder for the main TVI administration form.
 *
 * This is added to both vocabulary and term edit forms.
 * 
 * @see tvi_validate_handler().
 * @see tvi_submit_handler().
 */
function tvi_taxonomy_admin_form(&$form, $settings) {
  $path = drupal_get_path('module', 'tvi');
  drupal_add_js("{$path}/tvi.js");
  drupal_add_css("{$path}/tvi.css");

  // Add validate and submit handlers
  $form['#validate'][] = 'tvi_validate_handler';
  $form['#submit'][] = 'tvi_submit_handler';

  // Form container
  $form['tvi'] = array(
    '#type' => 'fieldset',
    '#title' => t('View usage'),
    '#weight' => -1,
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
    '#tree' => TRUE,
  );

  // Javascript warning message
  $message = t('This form is best used with Javascript enabled. Please enable your Javascript, then refresh this page.');
  $form['tvi']['javascript_message'] = array(
    '#type' => 'markup',
    '#value' => '<p class="javascript-warning">' . $message . '</p>',
  );
  $form['tvi']['is_default'] = array(
    '#type' => 'value',
    '#value' => $settings->is_default,
  );
  $form['tvi']['type'] = array(
    '#type' => 'value',
    '#value' => $settings->type,
  );
  $form['tvi']['xid'] = array(
    '#type' => 'value',
    '#value' => $settings->xid,
  );

  //  View selector
  $form['tvi']['view_name'] = array(
    '#id' => 'tvi-view-selector',
    '#type' => 'select',
    '#title' => t('Using the view'),
    '#default_value' => $settings->view_name ? $settings->view_name : NULL,
    '#options' => tvi_get_views(),
    '#description' => t('The view that you wish to use for this display'),
  );

  // Display selector
  $form['tvi']['display'] = array(
    '#id' => 'tvi-display-selector',
    '#type' => 'select',
    '#title' => t('View display'),
    '#default_value' => $settings->view_name ? $settings->view_name . ':' . $settings->display : NULL,
    '#options' => tvi_get_view_displays(),
    // Assume no Javascript
    '#description' => t('The view display you select from the option above will be used to render this taxonomy term. <b>NOTE:</b> Views defined for vocabulary are trumped by views for terms.'),
  );

  // Status toggle switch
  $form['tvi']['status'] = array(
    '#id' => 'tvi-status-check',
    '#type' => 'checkbox',
    '#title' => t('Use view override.'),
    '#default_value' => $settings->status,
    '#description' => t('Unchecking this field will disable the use of the view when displaying this taxonomy page.'),
  );
  $form['tvi']['description_enabled'] = array(
    '#type' => 'checkbox',
    '#title' => t('Display term description'),
    '#default_value' => $settings->description_enabled,
    '#description' => t('When enabled, the term description is displayed before the rendered view on term page.'),
  );
}

/**
 * Validate the TVI administration form submission.
 * 
 * If the view and the display do not line up, throw an error.
 * 
 * @see tvi_taxonomy_admin_form().
 * @see tvi_submit_handler().
 */
function tvi_validate_handler($form, &$form_state) {
  $values = $form_state['values']['tvi'];
  $view = views_get_view($values['view_name']);
  list($view_name, $display_name) = explode(':', $values['display']);
  $form_state['values']['tvi']['display'] = $display_name;
  if ($view->name != $view_name) {
    form_set_error('tvi][display', t("You must select a display from the selected view. You wouldn't have this problem if you enable Javascript."));
  }
}

/**
 * Save the view taxonomy data to the database.
 * 
 * @see tvi_taxonomy_admin_form().
 * @see tvi_validate_handler().
 */
function tvi_submit_handler($form, &$form_state) {
  $settings = (object) $form_state['values']['tvi'];
  if (!$settings->is_default || $settings->status) {
    tvi_update_settings($settings);
  }
}

/**
 * @} End of "defgroup forms".
 * 
 * defgroup internal utilities
 * @{
 */

/**
 * Gathers a listing of all views so that the admin may choose ANY view
 */
function tvi_get_views($return_object = FALSE) {
  $views = array();
  foreach (views_get_all_views() as $view) {
    if ($return_object) {
      $views[$view->name] = $view;
    }
    else {
      $views[$view->name] = $view->name;
    }
  }
  return $views;
}

/**
 * Gathers the available display options for the view operating on this term 
 * or vocabulary.
 */
function tvi_get_view_displays($view = NULL) {
  $displays = array();
  if ($view === NULL) {
    foreach (tvi_get_views(TRUE) as $view_name => $view) {
      foreach ($view->display as $display_name => $display) {

        // Suppress the 'default' plugin display
        $add = $display->display_plugin != 'default' ? ' - ' . $display->display_plugin : '';
        $displays[$view_name . ':' . $display_name] = $view->name . ' - ' . $display->display_title . $add;
      }
    }
  }
  else {

    // If it is a name or vid we can use this...
    if (!is_object($view)) {
      $view = views_get_view($view);
    }
    if (is_object($view)) {
      foreach ($view->display as $display_name => $display) {

        // Suppress the 'default' plugin display
        $add = $display->display_plugin != 'default' ? ' - ' . $display->display_plugin : '';
        $displays[$view->name . ':' . $display_name] = $display->display_title . $add;
      }
    }
  }
  return $displays;
}

/**
 * @} End of "defgroup internal utilities".
 */

Functions

Name	Description
tvi_display_options_ahah	Returns html option set of available displays for view with specified view id
tvi_get_views	Gathers a listing of all views so that the admin may choose ANY view
tvi_get_view_displays	Gathers the available display options for the view operating on this term or vocabulary.
tvi_settings_form	Form builder for the tvi_settings_form() form.
tvi_submit_handler	Save the view taxonomy data to the database.
tvi_taxonomy_admin_form	Form builder for the main TVI administration form.
tvi_term_form	Adds TVI administration form to the term edit page
tvi_validate_handler	Validate the TVI administration form submission.
tvi_vocab_form	Adds TVI administration form to the vocabulary edit page