views.module 45.1 KB
Newer Older
merlinofchaos's avatar
merlinofchaos committed
1 2 3 4 5 6 7 8 9 10 11
<?php

/**
 * @file
 * Primarily Drupal hooks and global API functions to manipulate views.
 *
 * This is the main module file for Views. The main entry points into
 * this module are views_page() and views_block(), where it handles
 * incoming page and block requests.
 */

12
use Drupal\Core\Cache\Cache;
13
use Drupal\Core\Database\Query\AlterableInterface;
14
use Drupal\Core\Language\Language;
15
use Drupal\views\Plugin\Derivative\ViewsLocalTask;
16
use Drupal\views\ViewExecutable;
17
use Drupal\Component\Plugin\Exception\PluginException;
18
use Drupal\views\Entity\View;
19
use Drupal\views\Views;
20
use Drupal\field\FieldInstanceInterface;
21

22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
/**
 * Implements hook_element_info().
 */
function views_element_info() {
  $types['view'] = array(
    '#theme_wrappers' => array('container'),
    '#pre_render' => array('views_pre_render_view_element'),
    '#name' => NULL,
    '#display_id' => 'default',
    '#arguments' => array(),
  );
  return $types;
}

/**
 * View element pre render callback.
 */
function views_pre_render_view_element($element) {
  $element['#attributes']['class'][] = 'views-element-container';

  $view = views_get_view($element['#name']);
  if ($view && $view->access($element['#display_id'])) {
44
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
45 46 47 48 49
  }

  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
50
/**
51 52 53 54
 * Implements hook_theme().
 *
 * Register views theming functions and those that are defined via views plugin
 * definitions.
merlinofchaos's avatar
merlinofchaos committed
55 56
 */
function views_theme($existing, $type, $theme, $path) {
57
  \Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
58 59 60

  // Some quasi clever array merging here.
  $base = array(
61
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
62 63 64 65 66
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
67
    'template' => 'views-mini-pager',
merlinofchaos's avatar
merlinofchaos committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
  );

  $variables = array(
    // For displays, we pass in a dummy array as the first parameter, since
    // $view is an object but the core contextual_preprocess() function only
    // attaches contextual links when the primary theme argument is an array.
    'display' => array('view_array' => array(), 'view' => NULL),
    'style' => array('view' => NULL, 'options' => NULL, 'rows' => NULL, 'title' => NULL),
    'row' => array('view' => NULL, 'options' => NULL, 'row' => NULL, 'field_alias' => NULL),
    'exposed_form' => array('view' => NULL, 'options' => NULL),
    'pager' => array(
      'view' => NULL, 'options' => NULL,
      'tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()
    ),
  );

  // Default view themes
  $hooks['views_view_field'] = $base + array(
    'variables' => array('view' => NULL, 'field' => NULL, 'row' => NULL),
  );
  $hooks['views_view_grouping'] = $base + array(
    'variables' => array('view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL),
90
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
91 92
  );

93
  $plugins = views_get_plugin_definitions();
94
  $module_handler = \Drupal::moduleHandler();
merlinofchaos's avatar
merlinofchaos committed
95

96 97 98 99
  // Register theme functions for all style plugins. It provides a basic auto
  // implementation of theme functions or template files by using the plugin
  // definitions (theme, theme_file, module, register_theme). Template files are
  // assumed to be located in the templates folder.
merlinofchaos's avatar
merlinofchaos committed
100
  foreach ($plugins as $type => $info) {
101
    foreach ($info as $def) {
102 103 104 105 106
      // Not all plugins have theme functions, and they can also explicitly
      // prevent a theme function from being registered automatically.
      if (!isset($def['theme']) || empty($def['register_theme'])) {
        continue;
      }
107 108 109 110
      // For each theme registration we a base directory to look for the
      // templates folder. This will be in any case the root of the given module
      // so we always need a module definition.
      // @todo: watchdog or exception?
111
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
112 113
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
114

115 116 117
      $hooks[$def['theme']] = array(
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
118

119 120
      // For the views module we ensure views.theme.inc is included.
      if ($def['provider'] == 'views') {
121 122
        $def['theme_file'] = 'views.theme.inc';
      }
123 124
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
merlinofchaos's avatar
merlinofchaos committed
125

126
      // The theme_file definition is always relative to the modules directory.
127
      if (isset($def['theme_file'])) {
128
        $hooks[$def['theme']]['path'] = $module_dir;
129 130
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
131 132 133 134
      // Whenever we got a theme file, we include it directly so we can
      // auto-detect the theme function.
      if (isset($def['theme_file'])) {
        $include = DRUPAL_ROOT . '/' . $module_dir. '/' . $def['theme_file'];
135 136
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
137 138
        }
      }
139 140 141 142 143 144
     // If there is no theme function for the given theme definition, we assume
     // a template file shall be used. By default this file is located in the
     // /templates directory of the module's folder.
     // If a module wants to define its own location it has to set
     // register_theme of the plugin to FALSE and implement hook_theme() by
     // itself.
145
      if (!function_exists('theme_' . $def['theme'])) {
146 147
        $hooks[$def['theme']]['path'] = $module_dir;
        $hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
148
      }
merlinofchaos's avatar
merlinofchaos committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162
    }
  }

  $hooks['views_form_views_form'] = $base + array(
    'render element' => 'form',
  );

  $hooks['views_exposed_form'] = $base + array(
    'template' => 'views-exposed-form',
    'render element' => 'form',
  );

  $hooks['views_more'] = $base + array(
    'variables' => array('more_url' => NULL, 'link_text' => 'more', 'view' => NULL),
163
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
164 165 166 167 168 169 170 171 172 173 174 175 176
  );

  return $hooks;
}

/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 *
 * The 'modules/node.views.inc' file is a better place for this, but
 * we haven't got a chance to load that file before Drupal builds the
 * node portion of the theme registry.
 */
177
function views_preprocess_node(&$variables) {
178
  \Drupal::moduleHandler()->loadInclude('node', 'views.inc');
179 180
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
181 182
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
183 184 185 186 187 188 189
    // If a node is being rendered in a view, and the view does not have a path,
    // prevent drupal from accidentally setting the $page variable:
    if (!empty($variables['view']->current_display)
        && $variables['page']
        && $variables['view_mode'] == 'full'
        && !$variables['view']->display_handler->hasPath()) {
      $variables['page'] = FALSE;
merlinofchaos's avatar
merlinofchaos committed
190 191 192 193
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
194 195
  if (!empty($variables['view']->rowPlugin) && $variables['view']->rowPlugin->getPluginId() == 'entity:node') {
    node_row_node_view_preprocess_node($variables);
merlinofchaos's avatar
merlinofchaos committed
196 197 198
  }
}

199 200 201 202 203 204 205 206 207 208 209 210 211
/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_node_alter(array &$suggestions, array $variables) {
  $node = $variables['elements']['#node'];
  if (!empty($node->view) && $node->view->storage->id()) {
    $suggestions[] = 'node__view__' . $node->view->storage->id();
    if (!empty($node->view->current_display)) {
      $suggestions[] = 'node__view__' . $node->view->storage->id() . '__' . $node->view->current_display;
    }
  }
}

merlinofchaos's avatar
merlinofchaos committed
212 213 214 215
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
216
function views_preprocess_comment(&$variables) {
217 218
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
219
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
220
    $variables['view'] = $variables['comment']->view;
221 222 223 224 225 226 227 228 229 230 231 232
  }
}

/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_comment_alter(array &$suggestions, array $variables) {
  $comment = $variables['elements']['#comment'];
  if (!empty($comment->view) && $comment->view->storage->id()) {
    $suggestions[] = 'comment__view__' . $comment->view->storage->id();
    if (!empty($comment->view->current_display)) {
      $suggestions[] = 'comment__view__' . $comment->view->storage->id() . '__' . $comment->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
233 234 235 236 237
    }
  }
}

/**
238
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
239 240 241 242 243 244
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
245
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
246 247 248 249
    ),
  );
}

250 251 252 253 254 255 256 257 258 259 260 261 262 263
/**
 * Implement hook_menu().
 */
function views_menu() {
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'theme callback' => 'ajax_base_page_theme',
    'route_name' => 'views.ajax',
    'type' => MENU_CALLBACK,
  );
  return $items;
}

merlinofchaos's avatar
merlinofchaos committed
264 265 266 267 268
/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
269
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
270 271
  foreach ($views as $data) {
    list($view, $display_id) = $data;
272
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
    if (is_array($result)) {
      // The menu system doesn't support having two otherwise
      // identical paths with different placeholders.  So we
      // want to remove the existing items from the menu whose
      // paths would conflict with ours.

      // First, we must find any existing menu items that may
      // conflict.  We use a regular expression because we don't
      // know what placeholders they might use.  Note that we
      // first construct the regex itself by replacing %views_arg
      // in the display path, then we use this constructed regex
      // (which will be something like '#^(foo/%[^/]*/bar)$#') to
      // search through the existing paths.
      $regex = '#^(' . preg_replace('#%views_arg#', '%[^/]*', implode('|', array_keys($result))) . ')$#';
      $matches = preg_grep($regex, array_keys($callbacks));

      // Remove any conflicting items that were found.
      foreach ($matches as $path) {
        // Don't remove the paths we just added!
        if (!isset($our_paths[$path])) {
          unset($callbacks[$path]);
        }
      }
      foreach ($result as $path => $item) {
        if (!isset($callbacks[$path])) {
          // Add a new item, possibly replacing (and thus effectively
          // overriding) one that we removed above.
          $callbacks[$path] = $item;
        }
        $our_paths[$path] = TRUE;
      }
    }
    $view->destroy();
  }
}

/**
 * Helper function for menu loading. This will automatically be
 * called in order to 'load' a views argument; primarily it
 * will be used to perform validation.
 *
 * @param $value
 *   The actual value passed.
 * @param $name
 *   The name of the view. This needs to be specified in the 'load function'
 *   of the menu entry.
 * @param $display_id
 *   The display id that will be loaded for this menu item.
 * @param $index
 *   The menu argument index. This counts from 1.
 */
function views_arg_load($value, $name, $display_id, $index) {
  static $views = array();

  // Make sure we haven't already loaded this views argument for a similar menu
  // item elsewhere.
  $key = $name . ':' . $display_id . ':' . $value . ':' . $index;
  if (isset($views[$key])) {
    return $views[$key];
  }

  if ($view = views_get_view($name)) {
335 336
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
337 338 339 340

    $ids = array_keys($view->argument);

    $indexes = array();
341
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
342 343 344 345 346 347 348 349 350

    foreach ($path as $id => $piece) {
      if ($piece == '%' && !empty($ids)) {
        $indexes[$id] = array_shift($ids);
      }
    }

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
351
        $arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
merlinofchaos's avatar
merlinofchaos committed
352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
        $view->destroy();

        // Store the output in case we load this same menu item again.
        $views[$key] = $arg;
        return $arg;
      }
    }
    $view->destroy();
  }
}

/**
 * Page callback: Displays a page view, given a name and display id.
 *
 * @param $name
 *   The name of a view.
 * @param $display_id
 *   The display id of a view.
 *
 * @return
 *   Either the HTML of a fully-executed view, or MENU_NOT_FOUND.
 */
function views_page($name, $display_id) {
  $args = func_get_args();
  // Remove $name and $display_id from the arguments.
  array_shift($args);
  array_shift($args);

  // Load the view and render it.
  if ($view = views_get_view($name)) {
382 383 384 385 386 387
    if ($output = $view->executeDisplay($display_id, $args)) {
      return $output;
    }
    else {
      return array();
    }
merlinofchaos's avatar
merlinofchaos committed
388 389
  }

390
  // Fallback if we get here no view was found.
merlinofchaos's avatar
merlinofchaos committed
391 392 393 394 395 396 397 398 399 400
  return MENU_NOT_FOUND;
}

/**
 * Implements hook_page_alter().
 */
function views_page_alter(&$page) {
  // If the main content of this page contains a view, attach its contextual
  // links to the overall page array. This allows them to be rendered directly
  // next to the page title.
401
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
402 403 404 405 406 407 408 409
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
410 411 412 413 414
  // Early-return to prevent adding unnecessary JavaScript.
  if (!user_access('access contextual links')) {
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
415 416 417 418 419 420 421 422 423
  // If the page contains a view as its main content, contextual links may have
  // been attached to the page as a whole; for example, by views_page_alter().
  // This allows them to be associated with the page and rendered by default
  // next to the page title (which we want). However, it also causes the
  // Contextual Links module to treat the wrapper for the entire page (i.e.,
  // the <body> tag) as the HTML element that these contextual links are
  // associated with. This we don't want; for better visual highlighting, we
  // prefer a smaller region to be chosen. The region we prefer differs from
  // theme to theme and depends on the details of the theme's markup in
424 425
  // page.html.twig, so we can only find it using JavaScript. We therefore
  // remove the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
426
  // JavaScript that will insert it back in the correct place.
427
  if (!empty($variables['page']['#views_contextual_links'])) {
428
    $key = array_search('contextual-region', $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
429
    if ($key !== FALSE) {
430
      unset($variables['attributes']['class'][$key]);
431
      $variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
432
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    }
  }
}

/**
 * Adds contextual links associated with a view display to a renderable array.
 *
 * This function should be called when a view is being rendered in a particular
 * location and you want to attach the appropriate contextual links (e.g.,
 * links for editing the view) to it.
 *
 * The function operates by checking the view's display plugin to see if it has
 * defined any contextual links that are intended to be displayed in the
 * requested location; if so, it attaches them. The contextual links intended
 * for a particular location are defined by the 'contextual links' and
448 449 450
 * 'contextual_links_locations' properties in the plugin annotation; as a
 * result, these hook implementations have full control over where and how
 * contextual links are rendered for each display.
merlinofchaos's avatar
merlinofchaos committed
451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485
 *
 * In addition to attaching the contextual links to the passed-in array (via
 * the standard #contextual_links property), this function also attaches
 * additional information via the #views_contextual_links_info property. This
 * stores an array whose keys are the names of each module that provided
 * views-related contextual links (same as the keys of the #contextual_links
 * array itself) and whose values are themselves arrays whose keys ('location',
 * 'view_name', and 'view_display_id') store the location, name of the view,
 * and display ID that were passed in to this function. This allows you to
 * access information about the contextual links and how they were generated in
 * a variety of contexts where you might be manipulating the renderable array
 * later on (for example, alter hooks which run later during the same page
 * request).
 *
 * @param $render_element
 *   The renderable array to which contextual links will be added. This array
 *   should be suitable for passing in to drupal_render() and will normally
 *   contain a representation of the view display whose contextual links are
 *   being requested.
 * @param $location
 *   The location in which the calling function intends to render the view and
 *   its contextual links. The core system supports three options for this
 *   parameter:
 *   - 'block': Used when rendering a block which contains a view. This
 *     retrieves any contextual links intended to be attached to the block
 *     itself.
 *   - 'page': Used when rendering the main content of a page which contains a
 *     view. This retrieves any contextual links intended to be attached to the
 *     page itself (for example, links which are displayed directly next to the
 *     page title).
 *   - 'view': Used when rendering the view itself, in any context. This
 *     retrieves any contextual links intended to be attached directly to the
 *     view.
 *   If you are rendering a view and its contextual links in another location,
 *   you can pass in a different value for this parameter. However, you will
486 487 488
 *   also need to set 'contextual_links_locations' in your plugin annotation to
 *   indicate which view displays support having their contextual links
 *   rendered in the location you have defined.
merlinofchaos's avatar
merlinofchaos committed
489 490 491 492 493
 * @param $view
 *   The view whose contextual links will be added.
 * @param $display_id
 *   The ID of the display within $view whose contextual links will be added.
 *
494
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
495 496 497
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
498
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
499 500
  // Do not do anything if the view is configured to hide its administrative
  // links.
501
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
502 503 504
    // Also do not do anything if the display plugin has not defined any
    // contextual links that are intended to be displayed in the requested
    // location.
505
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
506
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
507
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
508
    // avoid displaying any contextual links at all, a display plugin can still
509
    // set 'contextual_links_locations' to, e.g., {""}.)
510 511 512

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
513
    }
514
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
515 516
      $plugin['contextual_links_locations'] = array();
    }
517 518 519 520
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
521
    // On exposed_forms blocks contextual links should always be visible.
522
    $plugin['contextual_links_locations'][] = 'exposed_filter';
523 524
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
525
      foreach ($plugin['contextual links'] as $group => $link) {
merlinofchaos's avatar
merlinofchaos committed
526 527
        $args = array();
        $valid = TRUE;
528 529
        if (!empty($link['route_parameters_names'])) {
          foreach ($link['route_parameters_names'] as $parameter_name => $property) {
merlinofchaos's avatar
merlinofchaos committed
530
            // If the plugin is trying to create an invalid contextual link
531 532 533 534
            // (for example, "path/to/{$view->storage->property}", where
            // $view->storage->{property} does not exist), we cannot construct
            // the link, so we skip it.
            if (!property_exists($view->storage, $property)) {
merlinofchaos's avatar
merlinofchaos committed
535 536 537 538
              $valid = FALSE;
              break;
            }
            else {
539
              $args[$parameter_name] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
540 541 542 543 544 545
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
546
          $render_element['#views_contextual_links'] = TRUE;
547 548 549
          $render_element['#contextual_links'][$group] = array(
            'route_parameters' => $args,
            'metadata' => array(
550 551 552
              'location' => $location,
              'name' => $view->storage->id(),
              'display_id' => $display_id,
553
            ),
merlinofchaos's avatar
merlinofchaos committed
554 555 556 557 558 559 560 561
          );
        }
      }
    }
  }
}

/**
562
 * Prepares a list of language names.
merlinofchaos's avatar
merlinofchaos committed
563
 *
564
 * This is a wrapper around language_list to return a plain key value array.
merlinofchaos's avatar
merlinofchaos committed
565
 *
566 567 568 569 570
 * @param string $field
 *   The field of the language object which should be used as the value of the
 *   array.
 * @param int $flags
 *   (optional) Specifies the state of the languages that have to be returned.
571 572
 *   It can be: Language::STATE_CONFIGURABLE, Language::STATE_LOCKED,
 *   Language::STATE_ALL.
573 574 575
 *
 * @return array
 *   An array of language names (or $field) keyed by the langcode.
merlinofchaos's avatar
merlinofchaos committed
576 577 578
 *
 * @see locale_language_list()
 */
579
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
580
  $languages = language_list($flags);
merlinofchaos's avatar
merlinofchaos committed
581 582
  $list = array();
  foreach ($languages as $language) {
583
    $list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
584 585 586 587 588
  }
  return $list;
}

/**
589
 * Implements hook_ENTITY_TYPE_create() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
590
 */
591
function views_field_instance_create(FieldInstanceInterface $field_instance) {
592 593
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
594
}
595

merlinofchaos's avatar
merlinofchaos committed
596
/**
597
 * Implements hook_ENTITY_TYPE_update() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
598
 */
599
function views_field_instance_update(FieldInstanceInterface $field_instance) {
600 601
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
602 603 604
}

/**
605
 * Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
606
 */
607
function views_field_instance_delete(FieldInstanceInterface $field_instance) {
608 609
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
610 611 612 613 614 615
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
616
  // Clear the views cache.
617
  cache('views_info')->deleteAll();
618 619

  // Clear the page and block cache.
620
  Cache::deleteTags(array('content' => TRUE));
621 622

  // Set the menu as needed to be rebuilt.
623
  \Drupal::state()->set('menu_rebuild_needed', TRUE);
624

625
  $module_handler = \Drupal::moduleHandler();
626

627 628 629
  // Reset the RouteSubscriber from views.
  \Drupal::getContainer()->get('views.route_subscriber')->reset();

630 631 632 633
  // Set the router to be rebuild.
  // @todo Figure out why the cache rebuild is trigged but the route table
  //   does not exist yet.
  if (db_table_exists('router')) {
634
    \Drupal::service('router.builder')->rebuild();
635 636
  }

637
  // Invalidate the block cache to update views block derivatives.
638
  if ($module_handler->moduleExists('block')) {
639
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
640 641
  }

642
  // Allow modules to respond to the Views cache being cleared.
643
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
}

/**
 * Set the current 'page view' that is being displayed so that it is easy
 * for other modules or the theme to identify.
 */
function &views_set_page_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
660
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
661
 *
662 663 664 665
 * Note that this returns a reference, so be careful! You can unintentionally
 * modify the $view object.
 *
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
666 667 668 669 670 671 672 673 674 675
 *   A fully formed, empty $view object.
 */
function &views_get_page_view() {
  return views_set_page_view();
}

/**
 * Set the current 'current view' that is being built/rendered so that it is
 * easy for other modules or items in drupal_eval to identify
 *
676
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
677 678 679 680 681 682 683 684 685 686 687
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
688
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
689
 *
690 691 692 693
 * Note that this returns a reference, so be careful! You can unintentionally
 * modify the $view object.
 *
 * @return \Drupal\views\ViewExecutable
jhodgdon's avatar
jhodgdon committed
694
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
695 696 697 698 699
 */
function &views_get_current_view() {
  return views_set_current_view();
}

700 701 702 703
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
704 705 706 707 708 709 710 711 712
  $hooks = array();

  $hooks += array_fill_keys(array(
    'views_data',
    'views_data_alter',
    'views_analyze',
    'views_invalidate_cache',
  ), array('group' => 'views'));

713 714 715 716 717 718 719
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

720 721 722 723 724 725 726 727 728 729 730 731
  $hooks += array_fill_keys(array(
    'views_query_substitutions',
    'views_form_substitutions',
    'views_pre_view',
    'views_pre_build',
    'views_post_build',
    'views_pre_execute',
    'views_post_execute',
    'views_pre_render',
    'views_post_render',
    'views_query_alter',
  ), array('group' => 'views_execution'));
732 733

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
734 735 736
}

/**
737 738 739
 * Implements hook_library_info().
 */
function views_library_info() {
740 741 742
  $path = drupal_get_path('module', 'views');
  $libraries['views.module'] = array(
    'title' => 'Views base',
743
    'version' => \Drupal::VERSION,
744 745 746 747
    'css' => array(
      "$path/css/views.module.css"
    ),
  );
748 749
  $libraries['views.ajax'] = array(
    'title' => 'Views AJAX',
750
    'version' => \Drupal::VERSION,
751
    'js' => array(
752 753
      "$path/js/base.js" => array('group' => JS_DEFAULT),
      "$path/js/ajax_view.js" => array('group' => JS_DEFAULT),
754 755 756 757 758 759 760 761 762 763
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupalSettings'),
      array('system', 'jquery.once'),
      array('system', 'jquery.form'),
      array('system', 'drupal.ajax'),
    ),
  );
764 765
  $libraries['views.contextual-links'] = array(
    'title' => 'Views Contextual links',
766
    'version' => \Drupal::VERSION,
767
    'js' => array(
768
      // Set to -10 to move it before the contextual links javascript file.
769
      "$path/js/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
770 771 772 773 774 775
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );
776 777
  $libraries['views.exposed-form'] = array(
    'title' => 'Views exposed form',
778
    'version' => \Drupal::VERSION,
779 780 781 782
    'css' => array(
      "$path/css/views.exposed_form.css",
    ),
  );
merlinofchaos's avatar
merlinofchaos committed
783

784
  return $libraries;
merlinofchaos's avatar
merlinofchaos committed
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
}

/**
 * Fetch a list of all base tables available
 *
 * @param $type
 *   Either 'display', 'style' or 'row'
 * @param $key
 *   For style plugins, this is an optional type to restrict to. May be 'normal',
 *   'summary', 'feed' or others based on the neds of the display.
 * @param $base
 *   An array of possible base tables.
 *
 * @return
 *   A keyed array of in the form of 'base_table' => 'Description'.
800 801
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::fetchPluginNames().
merlinofchaos's avatar
merlinofchaos committed
802 803
 */
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
804
  return Views::fetchPluginNames($type, $key, $base);
merlinofchaos's avatar
merlinofchaos committed
805 806
}

807
/**
808 809 810
 * Gets all the views plugin definitions.
 *
 * @return array
811
 *   An array of plugin definitions for all types.
812 813
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getPluginDefinitions().
814
 */
815
function views_get_plugin_definitions() {
816 817
  return Views::getPluginDefinitions();
}
818

819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834
/**
 * Returns a list of plugins and metadata about them.
 *
 * @return array
 *   An array keyed by PLUGIN_TYPE:PLUGIN_NAME, like 'display:page' or
 *   'pager:full', containing an array with the following keys:
 *   - title: The plugin's title.
 *   - type: The plugin type.
 *   - module: The module providing the plugin.
 *   - views: An array of enabled Views that are currently using this plugin,
 *     keyed by machine name.
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::pluginList().
 */
function views_plugin_list() {
  return Views::pluginList();
835 836
}

837 838
/**
 * Get enabled display extenders.
839 840
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getEnabledDisplayExtenders().
841 842
 */
function views_get_enabled_display_extenders() {
843
  return Views::getEnabledDisplayExtenders();
844 845
}

merlinofchaos's avatar
merlinofchaos committed
846 847 848 849
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
850 851 852 853 854
 * @param string $type
 *   A flag from the display plugin definitions (e.g, 'uses_hook_menu').
 *
 * @return array
 *   A list of arrays containing the $view and $display_id.
merlinofchaos's avatar
merlinofchaos committed
855 856 857 858 859 860
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
861 862
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getApplicableViews().
merlinofchaos's avatar
merlinofchaos committed
863 864
 */
function views_get_applicable_views($type) {
865
  return Views::getApplicableViews($type);
merlinofchaos's avatar
merlinofchaos committed
866 867 868
}

/**
869
 * Returns an array of all views as fully loaded $view objects.
870 871
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getAllViews().
merlinofchaos's avatar
merlinofchaos committed
872
 */
873
function views_get_all_views() {
874
  return Views::getAllViews();
875 876
}

merlinofchaos's avatar
merlinofchaos committed
877 878
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
879 880
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getEnabledViews().
merlinofchaos's avatar
merlinofchaos committed
881 882
 */
function views_get_enabled_views() {
883
  return Views::getEnabledViews();
merlinofchaos's avatar
merlinofchaos committed
884 885 886 887
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
888 889
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getDisabledViews().
merlinofchaos's avatar
merlinofchaos committed
890 891
 */
function views_get_disabled_views() {
892
  return Views::getDisabledViews();
merlinofchaos's avatar
merlinofchaos committed
893 894 895 896 897 898 899 900 901 902 903 904 905 906
}

/**
 * Return an array of view as options array, that can be used by select,
 * checkboxes and radios as #options.
 *
 * @param bool $views_only
 *  If TRUE, only return views, not displays.
 * @param string $filter
 *  Filters the views on status. Can either be 'all' (default), 'enabled' or
 *  'disabled'
 * @param  mixed $exclude_view
 *  view or current display to exclude
 *  either a
907
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
908 909 910 911 912
 *  - views name as string:  e.g. my_view
 *  - views name and display id (separated by ':'): e.g. my_view:default
 * @param bool $optgroup
 *  If TRUE, returns an array with optgroups for each view (will be ignored for
 *  $views_only = TRUE). Can be used by select
913 914
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
915 916 917 918
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
919 920
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getViewsAsOptions().
merlinofchaos's avatar
merlinofchaos committed
921
 */
922
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
923
  return Views::getViewsAsOptions($views_only, $filter, $exclude_view, $optgroup, $sort);
merlinofchaos's avatar
merlinofchaos committed
924 925 926
}

/**
dawehner's avatar
dawehner committed
927 928
 * Returns whether the view is enabled.
 *
929
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
930
 *   The view object to check.
dawehner's avatar
dawehner committed
931 932 933
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
934
 */
935
function views_view_is_enabled(View $view) {
936
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
937 938 939
}

/**
dawehner's avatar
dawehner committed
940 941
 * Returns whether the view is disabled.
 *
942
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
943
 *   The view object to check.
dawehner's avatar
dawehner committed
944 945 946
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
947
 */
948
function views_view_is_disabled(View $view) {
949
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
950 951
}

952
/**
953
 * Enables and saves a view.
954
 *
955
 * @param \Drupal\views\Entity\View $view
956
 *   The View object to disable.
957
 */
958
function views_enable_view(View $view) {
959
  $view->enable()->save();
960 961 962
}

/**
963
 * Disables and saves a view.
964
 *
965
 * @param \Drupal\views\Entity\View $view
966
 *   The View object to disable.
967
 */
968
function views_disable_view(View $view) {
969
  $view->disable()->save();
970 971
}

merlinofchaos's avatar
merlinofchaos committed
972
/**
xjm's avatar
xjm committed
973
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
974
 *
xjm's avatar
xjm committed
975
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
976
 *   The name of the view.
xjm's avatar
xjm committed
977
 *
978
 * @return \Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
979
 *   A reference to the $view object.
980 981 982
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getView().
 *
merlinofchaos's avatar
merlinofchaos committed
983
 */
984
function views_get_view($name) {
985
  return Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
986 987 988 989 990 991 992 993
}

/**
 * Returns TRUE if the passed-in view contains handlers with views form
 * implementations, FALSE otherwise.
 */
function views_view_has_form_elements($view) {
  foreach ($view->field as $field) {
994
    if (property_exists($field, 'views_form_callback') || method_exists($field, 'viewsForm')) {
merlinofchaos's avatar
merlinofchaos committed
995 996 997 998 999 1000
      return TRUE;
    }
  }
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
1001
    if (method_exists($area, 'viewsForm') && !$area->viewsFormEmpty($empty)) {
merlinofchaos's avatar
merlinofchaos committed
1002 1003 1004 1005 1006 1007
      return TRUE;
    }
  }
  return FALSE;
}

1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
/**
 * Replaces views substitution placeholders.
 *
 * @param array $element
 *   An associative array containing the properties of the element.
 *   Properties used: #substitutions, #children.
 * @return array
 *   The $element with prepared variables ready for #theme 'form'
 *   in views_form_views_form.
 */
function views_pre_render_views_form_views_form($element) {
  // Placeholders and their substitutions (usually rendered form elements).
  $search = array();
  $replace = array();

  // Add in substitutions provided by the form.
  foreach ($element['#substitutions']['#value'] as $substitution) {
    $field_name = $substitution['field_name'];
    $row_id = $substitution['row_id'];

    $search[] = $substitution['placeholder'];
    $replace[] = isset($element[$field_name][$row_id]) ? drupal_render($element[$field_name][$row_id]) : '';
  }
  // Add in substitutions from hook_views_form_substitutions().
1032
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
1033 1034 1035 1036 1037 1038 1039 1040
  foreach ($substitutions as $placeholder => $substitution) {
    $search[] = $placeholder;
    $replace[] = $substitution;
  }

  // Apply substitutions to the rendered output.
  $element['output']['#markup'] = str_replace($search, $replace, $element['output']['#markup']);

1041 1042 1043
  // Sort, render and add remaining form fields.
  $children = element_children($element, TRUE);
  $element['#children'] = drupal_render_children($element, $children);
1044 1045 1046
  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
1047 1048 1049
/**
 * Form builder for the exposed widgets form.
 *
1050
 * Be sure that $display is a reference.
merlinofchaos's avatar
merlinofchaos committed
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
 */
function views_exposed_form($form, &$form_state) {
  // Don't show the form when batch operations are in progress.
  if ($batch = batch_get() && isset($batch['current_set'])) {
    return array(
      // Set the theme callback to be nothing to avoid errors in template_preprocess_views_exposed_form().
      '#theme' => '',
    );
  }

  // Make sure that we validate because this form might be submitted
  // multiple times per page.
  $form_state['must_validate'] = TRUE;
1064
  $view = $form_state['view'];
merlinofchaos's avatar
merlinofchaos committed
1065 1066
  $display = &$form_state['display'];

1067
  $form_state['input'] = $view->getExposedInput();
merlinofchaos's avatar
merlinofchaos committed
1068 1069 1070 1071

  // Let form plugins know this is for exposed widgets.
  $form_state['exposed'] = TRUE;
  // Check if the form was already created
1072
  if ($cache = views_exposed_form_cache($view->storage->id(), $view->current_display)) {
merlinofchaos's avatar
merlinofchaos committed
1073 1074 1075 1076 1077 1078 1079 1080
    return $cache;
  }

  $form['#info'] = array();

  // Go through each handler and let it generate its exposed widget.
  foreach ($view->display_handler->handlers as $type => $value) {
    foreach ($view->$type as $id => $handler) {
1081
      if ($handler->canExpose() && $handler->isExposed()) {
1082 1083 1084 1085 1086
        // Grouped exposed filters have their own forms.
        // Instead of render the standard exposed form, a new Select or
        // Radio form field is rendered with the available groups.
        // When an user choose an option the selected value is split
        // into the operator and value that the item represents.
1087
        if ($handler->isAGroup()) {
1088
          $handler->groupForm($form, $form_state);
1089 1090 1091
          $id = $handler->options['group_info']['identifier'];
        }
        else {
1092
          $handler->buildExposedForm($form, $form_state);
1093
        }
1094
        if ($info = $handler->exposedInfo()) {
merlinofchaos's avatar
merlinofchaos committed
1095 1096 1097 1098 1099 1100
          $form['#info']["$type-$id"] = $info;
        }
      }
    }
  }

1101 1102
  $form['actions'] = array('#type' => 'actions');
  $form['actions']['submit'] = array(
1103
    // Prevent from showing up in \Drupal::request()->query.
1104
    '#name' => '',
merlinofchaos's avatar
merlinofchaos committed
1105 1106
    '#type' => 'submit',
    '#value' => t('Apply'),
1107
    '#id' => drupal_html_id('edit-submit-' . $view->storage->id()),
merlinofchaos's avatar
merlinofchaos committed
1108 1109
  );

1110
  $form['#action'] = url($view->display_handler->getUrl());
1111
  $form['#theme'] = $view->buildThemeFunctions('views_exposed_form');
1112
  $form['#id'] = drupal_clean_css_identifier('views_exposed_form-' . check_plain($view->storage->id()) . '-' . check_plain($display['id']));
merlinofchaos's avatar
merlinofchaos committed
1113 1114 1115
//  $form['#attributes']['class'] = array('views-exposed-form');

  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1116
  $exposed_form_plugin->exposedFormAlter($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1117 1118

  // Save the form
1119
  views_exposed_form_cache($view->storage->id(), $view->current_display, $form);
merlinofchaos's avatar
merlinofchaos committed
1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142

  return $form;
}

/**
 * Implement hook_form_alter for the exposed form.
 *
 * Since the exposed form is a GET form, we don't want it to send a wide
 * variety of information.
 */
function views_form_views_exposed_form_alter(&$form, &$form_state) {
  $form['form_build_id']['#access'] = FALSE;
  $form['form_token']['#access'] = FALSE;
  $form['form_id']['#access'] = FALSE;
}

/**
 * Validate handler for exposed filters
 */
function views_exposed_form_validate(&$form, &$form_state) {
  foreach (array('field', 'filter') as $type) {
    $handlers = &$form_state['view']->$type;
    foreach ($handlers as $key => $handler) {
1143
      $handlers[$key]->validateExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1144 1145 1146
    }
  }
  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1147
  $exposed_form_plugin->exposedFormValidate($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1148 1149 1150 1151 1152 1153 1154 1155 1156
}

/**
 * Submit handler for exposed filters
 */
function views_exposed_form_submit(&$form, &$form_state) {
  foreach (array('field', 'filter') as $type) {
    $handlers = &$form_state['view']->$type;
    foreach ($handlers as $key => $info) {
1157
      $handlers[$key]->submitExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1158 1159 1160 1161 1162
    }
  }
  $form_state['view']->exposed_data = $form_state['values'];
  $form_state['view']->exposed_raw_input = array();

1163
  $exclude = array('submit', 'form_build_id', 'form_id', 'form_token', 'exposed_form_plugin', '', 'reset');
merlinofchaos's avatar
merlinofchaos committed
1164
  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1165
  $exposed_form_plugin->exposedFormSubmit($form, $form_state, $exclude);
merlinofchaos's avatar
merlinofchaos committed
1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186

  foreach ($form_state['values'] as $key => $value) {
    if (!in_array($key, $exclude)) {
      $form_state['view']->exposed_raw_input[$key] = $value;
    }
  }
}

/**
 * Save the Views exposed form for later use.
 *
 * @param $views_name
 *   String. The views name.
 * @param $display_name
 *   String. The current view display name.
 * @param $form_output
 *   Array (optional). The form structure. Only needed when inserting the value.
 * @return
 *   Array. The form structure, if any. Otherwise, return FALSE.
 */
function views_exposed_form_cache($views_name, $display_name, $form_output = NULL) {
1187 1188 1189
  // When running tests for exposed filters, this cache should
  // be cleared between each test.
  $views_exposed = &drupal_static(__FUNCTION__);
merlinofchaos's avatar
merlinofchaos committed
1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206

  // Save the form output
  if (!empty($form_output)) {
    $views_exposed[$views_name][$display_name] = $form_output;
    return;
  }

  // Return the form output, if any
  return empty($views_exposed[$views_name][$display_name]) ? FALSE : $views_exposed[$views_name][$display_name];
}

/**
 * Implements hook_query_TAG_alter().
 *
 * This is the hook_query_alter() for queries tagged by Views and is used to
 * add in substitutions from hook_views_query_substitutions().
 */
1207
function views_query_views_alter(AlterableInterface $query) {
merlinofchaos's avatar
merlinofchaos committed
1208
  $substitutions = $query->getMetaData('views_substitutions');
1209 1210
  $tables = &$query->getTables();
  $where = &$query->conditions();
merlinofchaos's avatar
merlinofchaos committed
1211 1212 1213 1214 1215 1216 1217 1218 1219 1220

  // Replaces substitions in tables.
  foreach ($tables as $table_name => $table_metadata) {
    foreach ($table_metadata['arguments'] as $replacement_key => $value) {
      if (isset($substitutions[$value])) {
        $tables[$table_name]['arguments'][$replacement_key] = $substitutions[$value];
      }
    }
  }

1221
  // Replaces substitions in filter criteria.
merlinofchaos's avatar
merlinofchaos committed
1222 1223 1224 1225 1226 1227
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
1228
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
merlinofchaos's avatar
merlinofchaos committed
1229 1230 1231 1232 1233 1234
  foreach ($conditions as $condition_id => &$condition) {
    if (is_numeric($condition_id)) {
      if (is_string($condition['field'])) {
        $condition['field'] = str_replace(array_keys($substitutions), array_values($substitutions), $condition['field']);
      }
      elseif (is_object($condition['field'])) {
1235
        $sub_conditions = &$condition['field']->conditions();
merlinofchaos's avatar
merlinofchaos committed
1236 1237 1238
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
1239
      // Therefore make sure to get the metadata of the main query.
merlinofchaos's avatar
merlinofchaos committed
1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261
      if (is_object($condition['value'])) {
        $subquery = $condition['value'];
        $subquery->addMetaData('views_substitutions', $query->getMetaData('views_substitutions'));
        views_query_views_alter($condition['value']);
      }
      elseif (isset($condition['value'])) {
        $condition['value'] = str_replace(array_keys($substitutions), array_values($substitutions), $condition['value']);
      }
    }
  }
}

/**
 * Embed a view using a PHP snippet.
 *
 * This function is meant to be called from PHP snippets, should one wish to
 * embed a view in a node or something. It's meant to provide the simplest
 * solution and doesn't really offer a lot of options, but breaking the function
 * apart is pretty easy, and this provides a worthwhile guide to doing so.
 *
 * Note that this function does NOT display the title of the view. If you want
 * to do that, you will need to do what this function does manually, by
1262
 * loading the view, getting the preview and then getting $view->getTitle().
merlinofchaos's avatar
merlinofchaos committed
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
 *
 * @param $name
 *   The name of the view to embed.
 * @param $display_id
 *   The display id to embed. If unsure, use 'default', as it will always be
 *   valid. But things like 'page' or 'block' should work here.
 * @param ...
 *   Any additional parameters will be passed as arguments.
 */
function views_embed_view($name, $display_id = 'default') {
  $args = func_get_args();
  array_shift($args); // remove $name
  if (count($args)) {
    array_shift($args); // remove $display_id
  }

  $view = views_get_view($name);
  if (!$view || !$view->access($display_id)) {
    return;
  }

  return $view->preview($display_id, $args);
}

/**
 * Get the result of a view.
 *
 * @param string $name
 *   The name of the view to retrieve the data from.
 * @param string $display_id
 *   The display id. On the edit page for the view in question, you'll find
 *   a list of displays at the left side of the control area. "Master"
 *   will be at the top of that list. Hover your cursor over the name of the
 *   display you want to use. An URL will appear in the status bar of your
 *   browser. This is usually at the bottom of the window, in the chrome.
 *   Everything after #views-tab- is the display ID, e.g. page_1.
 * @param ...
 *   Any additional parameters will be passed as arguments.
 * @return array
 *   An array containing an object for each view item.
 */
function views_get_view_result($name, $display_id = NULL) {
  $args = func_get_args();
  array_shift($args); // remove $name
  if (count($args)) {
    array_shift($args); // remove $display_id
  }

  $view = views_get_view($name);
  if (is_object($view)) {
    if (is_array($args)) {
1314
      $view->setArguments($args);
merlinofchaos's avatar
merlinofchaos committed
1315 1316
    }
    if (is_string($display_id)) {
1317
      $view->setDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
1318 1319
    }
    else {
1320
      $view->initDisplay();
merlinofchaos's avatar
merlinofchaos committed
1321
    }
1322
    $view->preExecute();
merlinofchaos's avatar
merlinofchaos committed
1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346
    $view->execute();
    return $view->result;
  }
  else {
    return array();
  }
}

/**
 * #process callback to see if we need to check_plain() the options.
 *
 * Since FAPI is inconsistent, the #options are sanitized for you in all cases
 * _except_ checkboxes. We have form elements that are sometimes 'select' and
 * sometimes 'checkboxes', so we need decide late in the form rendering cycle
 * if the options need to be sanitized before they're rendered. This callback
 * inspects the type, and if it's still 'checkboxes', does the sanitation.
 */
function views_process_check_options($element, &$form_state) {
  if ($element['#type'] == 'checkboxes' || $element['#type'] == 'checkbox') {
    $element['#options'] = array_map('check_plain', $element['#options']);
  }
  return $element;
}

1347 1348 1349 1350 1351 1352 1353
/**
 * Validation callback for query tags.
 */
function views_element_validate_tags($element, &$form_state) {
  $values = array_map('trim', explode(',', $element['#value']));
  foreach ($values as $value) {
    if (preg_match("/[^a-z_]/", $value)) {
1354
      form_error($element, $form_state, t('The query tags may only contain lower-case alphabetical characters and underscores.'));
1355 1356 1357 1358
      return;
    }
  }
}
1359 1360 1361 1362 1363 1364 1365 1366 1367

/**
 * Implements hook_local_tasks_alter().
 */
function views_local_tasks_alter(&$local_tasks) {
  $container = \Drupal::getContainer();
  $local_task = ViewsLocalTask::create($container, 'views_view');
  $local_task->alterLocalTasks($local_tasks);
}