You are here

ajax.inc in Views (for Drupal 7) 8.3

Same filename and directory in other branches
  1. 6.3 includes/ajax.inc
  2. 6.2 includes/ajax.inc
  3. 7.3 includes/ajax.inc

Handles the server side AJAX interactions of Views.

File

includes/ajax.inc
View source
<?php

/**
 * @file
 * Handles the server side AJAX interactions of Views.
 */
use Symfony\Component\HttpFoundation\JsonResponse;

/**
 * @defgroup ajax Views AJAX library
 * @{
 * Handles the server side AJAX interactions of Views.
 */

/**
 * Menu callback to load a view via AJAX.
 */
function views_ajax() {
  $request = drupal_container()
    ->get('request');
  $name = $request->request
    ->get('view_name');
  $display_id = $request->request
    ->get('view_display_id');
  if (isset($name) && isset($display_id)) {
    $args = $request->request
      ->get('view_args');
    $args = isset($args) && $args !== '' ? explode('/', $args) : array();
    $path = $request->request
      ->get('view_path');
    $dom_id = $request->request
      ->get('view_dom_id');
    $dom_id = isset($dom_id) ? preg_replace('/[^a-zA-Z0-9_-]+/', '-', $dom_id) : NULL;
    $pager_element = $request->request
      ->get('pager_element');
    $pager_element = isset($pager_element) ? intval($pager_element) : NULL;
    $commands = array();

    // Remove all of this stuff from the query of the request so it doesn't end
    // up in pagers and tablesort URLs.
    foreach (array(
      'view_name',
      'view_display_id',
      'view_args',
      'view_path',
      'view_dom_id',
      'pager_element',
      'view_base_path',
      'ajax_html_ids',
      'ajax_page_state',
    ) as $key) {
      if ($request->query
        ->has($key)) {
        $request->query
          ->remove($key);
      }
      if ($request->request
        ->has($key)) {
        $request->request
          ->remove($key);
      }
    }

    // Load the view.
    $view = views_get_view($name);
    if ($view && $view
      ->access($display_id)) {

      // Fix the current path for paging.
      if (!empty($path)) {
        _current_path($path);
      }

      // Add all $_POST data, because AJAX is always a post and many things,
      // such as tablesorts, exposed filters and paging assume $_GET.
      $request_all = $request->request
        ->all();
      $query_all = $request->query
        ->all();
      $request->query
        ->replace($request_all + $query_all);

      // Overwrite the destination.
      // @see drupal_get_destination()
      $origin_destination = $path;
      $query = drupal_http_build_query($request->query
        ->all());
      if ($query != '') {
        $origin_destination .= '?' . $query;
      }
      $destination =& drupal_static('drupal_get_destination');
      $destination = array(
        'destination' => $origin_destination,
      );

      // Override the display's pager_element with the one actually used.
      if (isset($pager_element)) {
        $commands[] = views_ajax_command_scroll_top('.view-dom-id-' . $dom_id);
        $view->displayHandlers[$display_id]
          ->setOption('pager_element', $pager_element);
      }

      // Reuse the same DOM id so it matches that in Drupal.settings.
      $view->dom_id = $dom_id;
      $commands[] = ajax_command_replace('.view-dom-id-' . $dom_id, $view
        ->preview($display_id, $args));
    }
    drupal_alter('views_ajax_data', $commands, $view);
    return array(
      '#type' => 'ajax',
      '#commands' => $commands,
    );
  }
}

/**
 * Creates a Drupal AJAX 'viewsSetForm' command.
 *
 * @param $output
 *   The form to display in the modal.
 * @param $title
 *   The title.
 * @param $url
 *   An optional URL.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_set_form($output, $title, $url = NULL) {
  $command = array(
    'command' => 'viewsSetForm',
    'output' => $output,
    'title' => $title,
  );
  if (isset($url)) {
    $command['url'] = $url;
  }
  return $command;
}

/**
 * Creates a Drupal AJAX 'viewsDismissForm' command.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_dismiss_form() {
  $command = array(
    'command' => 'viewsDismissForm',
  );
  return $command;
}

/**
 * Creates a Drupal AJAX 'viewsHilite' command.
 *
 * @param $selector
 *   The selector to highlight
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_hilite($selector) {
  return array(
    'command' => 'viewsHilite',
    'selector' => $selector,
  );
}

/**
 * Creates a Drupal AJAX 'addTab' command.
 *
 * @param $id
 *   The DOM ID.
 * @param $title
 *   The title.
 * @param $body
 *   The body.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_add_tab($id, $title, $body) {
  $command = array(
    'command' => 'viewsAddTab',
    'id' => $id,
    'title' => $title,
    'body' => $body,
  );
  return $command;
}

/**
 * Scroll to top of the current view.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_scroll_top($selector) {
  $command = array(
    'command' => 'viewsScrollTop',
    'selector' => $selector,
  );
  return $command;
}

/**
 * Shows Save and Cancel buttons.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_show_buttons() {
  $command = array(
    'command' => 'viewsShowButtons',
  );
  return $command;
}

/**
 * Trigger the Views live preview.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_trigger_preview() {
  $command = array(
    'command' => 'viewsTriggerPreview',
  );
  return $command;
}

/**
 * Replace the page title.
 *
 * @return
 *   An array suitable for use with the ajax_render() function.
 */
function views_ajax_command_replace_title($title) {
  $command = array(
    'command' => 'viewsReplaceTitle',
    'title' => $title,
    'siteName' => config('system.site')
      ->get('name'),
  );
  return $command;
}

/**
 * Return an AJAX error.
 */
function views_ajax_error($message) {
  $commands = array();
  $commands[] = views_ajax_command_set_form($message, t('Error'));
  return $commands;
}

/**
 * Wrapper around drupal_build_form to handle some AJAX stuff automatically.
 * This makes some assumptions about the client.
 */
function views_ajax_form_wrapper($form_id, &$form_state) {

  // This won't override settings already in.
  $form_state += array(
    'rerender' => FALSE,
    'no_redirect' => !empty($form_state['ajax']),
    'no_cache' => TRUE,
    'build_info' => array(
      'args' => array(),
    ),
  );
  $form = drupal_build_form($form_id, $form_state);
  $output = drupal_render($form);

  // These forms have the title built in, so set the title here:
  if (empty($form_state['ajax']) && !empty($form_state['title'])) {
    drupal_set_title($form_state['title']);
    drupal_add_css(drupal_get_path('module', 'views_ui') . '/css/views-admin.css');
  }
  if (!empty($form_state['ajax']) && (empty($form_state['executed']) || !empty($form_state['rerender']))) {

    // If the form didn't execute and we're using ajax, build up a
    // Ajax command list to execute.
    $commands = array();
    $display = '';
    if ($messages = theme('status_messages')) {
      $display = '<div class="views-messages">' . $messages . '</div>';
    }
    $display .= $output;
    $title = empty($form_state['title']) ? '' : $form_state['title'];
    $url = empty($form_state['url']) ? url(current_path(), array(
      'absolute' => TRUE,
    )) : $form_state['url'];
    $commands[] = views_ajax_command_set_form($display, $title, $url);
    if (!empty($form_state['#section'])) {
      $commands[] = views_ajax_command_hilite('.' . drupal_clean_css_identifier($form_state['#section']));
    }
    return $commands;
  }

  // These forms have the title built in, so set the title here:
  if (empty($form_state['ajax']) && !empty($form_state['title'])) {
    drupal_set_title($form_state['title']);
  }
  return $output;
}

/**
 * Page callback for views user autocomplete
 */
function views_ajax_autocomplete_user($string = '') {

  // The user enters a comma-separated list of user name. We only autocomplete the last name.
  $array = drupal_explode_tags($string);

  // Fetch last name
  $last_string = trim(array_pop($array));
  $matches = array();
  if ($last_string != '') {
    $prefix = count($array) ? implode(', ', $array) . ', ' : '';
    if (strpos('anonymous', strtolower($last_string)) !== FALSE) {
      $matches[$prefix . 'Anonymous'] = 'Anonymous';
    }
    $result = db_select('users', 'u')
      ->fields('u', array(
      'uid',
      'name',
    ))
      ->condition('u.name', db_like($last_string) . '%', 'LIKE')
      ->range(0, 10)
      ->execute()
      ->fetchAllKeyed();
    foreach ($result as $account) {
      $n = $account;

      // Commas and quotes in terms are special cases, so encode 'em.
      if (strpos($account, ',') !== FALSE || strpos($account, '"') !== FALSE) {
        $n = '"' . str_replace('"', '""', $account) . '"';
      }
      $matches[$prefix . $n] = check_plain($account);
    }
  }
  return new JsonResponse($matches);
}

/**
 * Page callback for views taxonomy autocomplete.
 *
 * @param $vid
 *   The vocabulary id of the tags which should be returned.
 *
 * @param $tags_typed
 *   The typed string of the user.
 *
 * @see taxonomy_autocomplete()
 */
function views_ajax_autocomplete_taxonomy($vid, $tags_typed = '') {

  // The user enters a comma-separated list of tags. We only autocomplete the last tag.
  $tags_typed = drupal_explode_tags($tags_typed);
  $tag_last = drupal_strtolower(array_pop($tags_typed));
  $matches = array();
  if ($tag_last != '') {
    $query = db_select('taxonomy_term_data', 't');
    $query
      ->addTag('translatable');
    $query
      ->addTag('term_access');

    // Do not select already entered terms.
    if (!empty($tags_typed)) {
      $query
        ->condition('t.name', $tags_typed, 'NOT IN');
    }

    // Select rows that match by term name.
    $tags_return = $query
      ->fields('t', array(
      'tid',
      'name',
    ))
      ->condition('t.vid', $vid)
      ->condition('t.name', '%' . db_like($tag_last) . '%', 'LIKE')
      ->range(0, 10)
      ->execute()
      ->fetchAllKeyed();
    $prefix = count($tags_typed) ? drupal_implode_tags($tags_typed) . ', ' : '';
    $term_matches = array();
    foreach ($tags_return as $tid => $name) {
      $n = $name;

      // Term names containing commas or quotes must be wrapped in quotes.
      if (strpos($name, ',') !== FALSE || strpos($name, '"') !== FALSE) {
        $n = '"' . str_replace('"', '""', $name) . '"';
      }

      // Add term name to list of matches.
      $term_matches[$prefix . $n] = check_plain($name);
    }
  }
  return new JsonResponse($term_matches);
}

/**
 * @}
 */

Functions

Namesort descending Description
views_ajax Menu callback to load a view via AJAX.
views_ajax_autocomplete_taxonomy Page callback for views taxonomy autocomplete.
views_ajax_autocomplete_user Page callback for views user autocomplete
views_ajax_command_add_tab Creates a Drupal AJAX 'addTab' command.
views_ajax_command_dismiss_form Creates a Drupal AJAX 'viewsDismissForm' command.
views_ajax_command_hilite Creates a Drupal AJAX 'viewsHilite' command.
views_ajax_command_replace_title Replace the page title.
views_ajax_command_scroll_top Scroll to top of the current view.
views_ajax_command_set_form Creates a Drupal AJAX 'viewsSetForm' command.
views_ajax_command_show_buttons Shows Save and Cancel buttons.
views_ajax_command_trigger_preview Trigger the Views live preview.
views_ajax_error Return an AJAX error.
views_ajax_form_wrapper Wrapper around drupal_build_form to handle some AJAX stuff automatically. This makes some assumptions about the client.