views.module 46.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\ViewExecutable;
16
use Drupal\Component\Plugin\Exception\PluginException;
17
use Drupal\views\Entity\View;
18
use Drupal\views\Views;
19
use Drupal\field\FieldInstanceInterface;
20

21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/**
 * 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'])) {
43
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
44 45 46 47 48
  }

  return $element;
}

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

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

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

  $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),
89
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
90 91
  );

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

95 96 97 98
  // 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
99
  foreach ($plugins as $type => $info) {
100
    foreach ($info as $def) {
101 102 103 104 105
      // 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;
      }
106 107 108 109
      // 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?
110
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
111 112
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
113

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

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

125
      // The theme_file definition is always relative to the modules directory.
126
      if (isset($def['theme_file'])) {
127
        $hooks[$def['theme']]['path'] = $module_dir;
128 129
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
130 131 132 133
      // 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'];
134 135
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
136 137
        }
      }
138 139 140 141 142 143
     // 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.
144
      if (!function_exists('theme_' . $def['theme'])) {
145 146
        $hooks[$def['theme']]['path'] = $module_dir;
        $hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
147
      }
merlinofchaos's avatar
merlinofchaos committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161
    }
  }

  $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),
162
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
163 164 165 166 167 168 169 170 171 172 173 174 175
  );

  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.
 */
176
function views_preprocess_node(&$variables) {
177
  \Drupal::moduleHandler()->loadInclude('node', 'views.inc');
178 179
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
180 181
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
182 183 184 185 186 187 188
    // 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
189 190 191 192
    }
  }

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

198 199 200 201 202 203 204 205 206 207 208 209 210
/**
 * 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
211 212 213 214
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
215
function views_preprocess_comment(&$variables) {
216 217
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
218
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
219
    $variables['view'] = $variables['comment']->view;
220 221 222 223 224 225 226 227 228 229 230 231
  }
}

/**
 * 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
232 233 234 235 236
    }
  }
}

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

/**
 * Implement hook_menu().
 */
function views_menu() {
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'theme callback' => 'ajax_base_page_theme',
257
    'route_name' => 'views.ajax',
merlinofchaos's avatar
merlinofchaos committed
258 259 260 261 262 263 264 265 266 267
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
268
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
269 270
  foreach ($views as $data) {
    list($view, $display_id) = $data;
271
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
272 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
    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)) {
334 335
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
336 337 338 339

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

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

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

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
350
        $arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
merlinofchaos's avatar
merlinofchaos committed
351 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
        $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)) {
381 382 383 384 385 386
    if ($output = $view->executeDisplay($display_id, $args)) {
      return $output;
    }
    else {
      return array();
    }
merlinofchaos's avatar
merlinofchaos committed
387 388
  }

389
  // Fallback if we get here no view was found.
merlinofchaos's avatar
merlinofchaos committed
390 391 392 393 394 395 396 397 398 399
  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.
400
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
401 402 403 404 405 406 407 408
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

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

merlinofchaos's avatar
merlinofchaos committed
414 415 416 417 418 419 420 421 422
  // 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
423 424
  // 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
425
  // JavaScript that will insert it back in the correct place.
426
  if (!empty($variables['page']['#views_contextual_links'])) {
427
    $key = array_search('contextual-region', $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
428
    if ($key !== FALSE) {
429
      unset($variables['attributes']['class'][$key]);
430
      $variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
431
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
    }
  }
}

/**
 * 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
447 448 449
 * '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
450 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
 *
 * 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
485 486 487
 *   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
488 489 490 491 492
 * @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.
 *
493
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
494 495 496
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
497
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
498 499
  // Do not do anything if the view is configured to hide its administrative
  // links.
500
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
501 502 503
    // 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.
504
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
505
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
506
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
507
    // avoid displaying any contextual links at all, a display plugin can still
508
    // set 'contextual_links_locations' to, e.g., {""}.)
509 510 511

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

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

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

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

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

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

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

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

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

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

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

629 630 631 632
  // 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')) {
633
    \Drupal::service('router.builder')->rebuild();
634 635
  }

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

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

/**
 * 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;
}

/**
659
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
660
 *
661 662 663 664
 * 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
665 666 667 668 669 670 671 672 673 674
 *   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
 *
675
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
676 677 678 679 680 681 682 683 684 685 686
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

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

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

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

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

719 720 721 722 723 724 725 726 727 728 729 730
  $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'));
731 732

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

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

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

/**
 * 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'.
799 800
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::fetchPluginNames().
merlinofchaos's avatar
merlinofchaos committed
801 802
 */
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
803
  return Views::fetchPluginNames($type, $key, $base);
merlinofchaos's avatar
merlinofchaos committed
804 805
}

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

818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833
/**
 * 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();
834 835
}

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

merlinofchaos's avatar
merlinofchaos committed
845 846 847 848
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
849 850 851 852 853
 * @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
854 855 856 857 858 859
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
860 861
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getApplicableViews().
merlinofchaos's avatar
merlinofchaos committed
862 863
 */
function views_get_applicable_views($type) {
864
  return Views::getApplicableViews($type);
merlinofchaos's avatar
merlinofchaos committed
865 866 867
}

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

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

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

/**
 * 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
906
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
907 908 909 910 911
 *  - 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
912 913
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
914 915 916 917
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
918 919
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getViewsAsOptions().
merlinofchaos's avatar
merlinofchaos committed
920
 */
921
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
922
  return Views::getViewsAsOptions($views_only, $filter, $exclude_view, $optgroup, $sort);
merlinofchaos's avatar
merlinofchaos committed
923 924 925
}

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

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

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

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

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

/**
 * 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) {
    if (property_exists($field, 'views_form_callback') || method_exists($field, 'views_form')) {
      return TRUE;
    }
  }
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
    if (method_exists($area, 'views_form') && !$area->views_form_empty($empty)) {
      return TRUE;
    }
  }
  return FALSE;
}

1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030
/**
 * 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().
1031
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
1032 1033 1034 1035 1036 1037 1038 1039
  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']);

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

merlinofchaos's avatar
merlinofchaos committed
1046 1047 1048
/**
 * Form builder for the exposed widgets form.
 *
1049
 * Be sure that $display is a reference.
merlinofchaos's avatar
merlinofchaos committed
1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062
 */
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;
1063
  $view = $form_state['view'];
merlinofchaos's avatar
merlinofchaos committed
1064 1065
  $display = &$form_state['display'];

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

  // Let form plugins know this is for exposed widgets.
  $form_state['exposed'] = TRUE;
  // Check if the form was already created
1071
  if ($cache = views_exposed_form_cache($view->storage->id(), $view->current_display)) {
merlinofchaos's avatar
merlinofchaos committed
1072 1073 1074 1075 1076 1077 1078 1079
    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) {
1080
      if ($handler->canExpose() && $handler->isExposed()) {
1081 1082 1083 1084 1085
        // 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.
1086
        if ($handler->isAGroup()) {
1087
          $handler->groupForm($form, $form_state);
1088 1089 1090
          $id = $handler->options['group_info']['identifier'];
        }
        else {
1091
          $handler->buildExposedForm($form, $form_state);
1092
        }
1093
        if ($info = $handler->exposedInfo()) {
merlinofchaos's avatar
merlinofchaos committed
1094 1095 1096 1097 1098 1099
          $form['#info']["$type-$id"] = $info;
        }
      }
    }
  }

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

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

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

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

  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) {
1142
      $handlers[$key]->validateExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1143 1144 1145
    }
  }
  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1146
  $exposed_form_plugin->exposedFormValidate($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1147 1148 1149 1150 1151 1152 1153 1154 1155
}

/**
 * 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) {
1156
      $handlers[$key]->submitExposed($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1157 1158 1159 1160 1161
    }
  }
  $form_state['view']->exposed_data = $form_state['values'];
  $form_state['view']->exposed_raw_input = array();

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

  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) {
1186 1187 1188
  // When running tests for exposed filters, this cache should
  // be cleared between each test.
  $views_exposed = &drupal_static(__FUNCTION__);
merlinofchaos's avatar
merlinofchaos committed
1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205

  // 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().
 */
1206
function views_query_views_alter(AlterableInterface $query) {
merlinofchaos's avatar
merlinofchaos committed
1207
  $substitutions = $query->getMetaData('views_substitutions');
1208 1209
  $tables = &$query->getTables();
  $where = &$query->conditions();
merlinofchaos's avatar
merlinofchaos committed
1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226

  // 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];
      }
    }
  }

  // Replaces substitions in filter criterias.
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
1227
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
merlinofchaos's avatar
merlinofchaos committed
1228 1229 1230 1231 1232 1233
  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'])) {
1234
        $sub_conditions = &$condition['field']->conditions();
merlinofchaos's avatar
merlinofchaos committed
1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
      // Therefore take sure to get the metadata of the main query.
      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
1261
 * loading the view, getting the preview and then getting $view->getTitle().
merlinofchaos's avatar
merlinofchaos committed
1262 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
 *
 * @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)) {
1313
      $view->setArguments($args);
merlinofchaos's avatar
merlinofchaos committed
1314 1315
    }
    if (is_string($display_id)) {
1316
      $view->setDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
1317 1318
    }
    else {
1319
      $view->initDisplay();
merlinofchaos's avatar
merlinofchaos committed
1320
    }
1321
    $view->preExecute();
merlinofchaos's avatar
merlinofchaos committed
1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345
    $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;
}

1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
/**
 * 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)) {
      form_error($element, t('The query tags may only contain lower-case alphabetical characters and underscores.'));
      return;
    }
  }
}

1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372
/**
 * Set a cached item in the views cache.
 *
 * This is just a convenience wrapper around cache_set().
 *
 * @param $cid
 *   The cache ID of the data to store.
 * @param $data
 *   The data to store in the cache. Complex data types will be automatically serialized before insertion.
 *   Strings will be stored as plain text and not serialized.
 * @param $use_language
 *   If TRUE, the data will be cached specific to the currently active language.
 */
function views_cache_set($cid, $data, $use_language = FALSE) {
1373
  if (\Drupal::config('views.settings')->get('skip_cache')) {
1374 1375 1376
    return;
  }
  if ($use_language) {
1377
    $cid .= ':' . language(Language::TYPE_INTERFACE)->id;
1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396
  }

  cache('views_info')->set($cid, $data);
}

/**
 * Return data from the persistent views cache.
 *
 * This is just a convenience wrapper around cache_get().
 *
 * @param int $cid
 *   The cache ID of the data to retrieve.
 * @param bool $use_language
 *   If TRUE, the data will be requested specific to the currently active language.
 *
 * @return stdClass|bool
 *   The cache or FALSE on failure.
 */
function views_cache_get($cid, $use_language = FALSE) {
1397
  if (\Drupal::config('views.settings')->get('skip_cache')) {
1398 1399 1400
    return FALSE;
  }
  if ($use_language) {
1401
    $cid .= ':' . language(Language::TYPE_INTERFACE)->id;
1402 1403 1404 1405
  }

  return cache('views_info')->get($cid);
}
1406