views.module 38.7 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\Component\Utility\String;
13
use Drupal\Core\Cache\Cache;
14
use Drupal\Core\Database\Query\AlterableInterface;
15
use Drupal\Core\Language\Language;
16
use Drupal\Core\Render\Element;
17
use Drupal\views\Plugin\Derivative\ViewsLocalTask;
18
use Drupal\Core\Template\AttributeArray;
19
use Drupal\views\ViewExecutable;
20
use Drupal\Component\Plugin\Exception\PluginException;
21
use Drupal\views\Entity\View;
22
use Drupal\views\Views;
23
use Drupal\field\FieldInstanceConfigInterface;
24

25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46
/**
 * Implements hook_help().
 */
function views_help($path, $arg) {
  switch($path) {
    case 'admin/help#views':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('The Views module provides a back end to fetch information from content, user accounts, taxonomy terms, and other entities from the database and present it to the user as a grid, HTML list, table, unformatted list, etc. The resulting displays are known generally as <em>views</em>.') . '</p>';
      $output .= '<p>' . t('For more information, see the <a href="!views">online documentation for the Views module</a>.', array('!views' => 'https://drupal.org/documentation/modules/views')) . '</p>';
      $output .= '<p>' . t('In order to create and modify your own views using the administration and configuration user interface, you will need to enable either the Views UI module in core or a contributed module that provides a user interface for Views. See the <a href="!views-ui">Views UI module help page</a> for more information.', array('!views-ui' => \Drupal::url('help.page', array('name' => 'views_ui')))) . '</p>';
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('Adding functionality to administrative pages') . '</dt>';
      $output .= '<dd>' . t('The Views module adds functionality to some core administration pages. For example, <em>admin/content</em> uses Views to filter and sort content. With Views uninstalled, <em>admin/content</em> is more limited.') . '</dd>';
      $output .= '<dt>' . t('Expanding Views functionality') . '</dt>';
      $output .= '<dd>' . t('Contributed projects that support the Views module can be found in the <a href="!node">online documentation for Views-related contributed modules</a>.', array('!node' => 'https://drupal.org/documentation/modules/views/add-ons')) . '</dd>';
      $output .= '</dl>';
      return $output;
  }
}

47 48 49 50 51 52 53 54 55 56 57 58 59 60
/**
 * 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;
}

61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91
/**
 * Implements hook_views_pre_render().
 */
function views_views_pre_render($view) {
  // If using AJAX, send identifying data about this view.
  if ($view->ajaxEnabled() && empty($view->is_attachment) && empty($view->live_preview)) {
    $settings = array(
      'views' => array(
        'ajax_path' => url('views/ajax'),
        'ajaxViews' => array(
          'views_dom_id:' . $view->dom_id => array(
            'view_name' => $view->storage->id(),
            'view_display_id' => $view->current_display,
            'view_args' => String::checkPlain(implode('/', $view->args)),
            'view_path' => String::checkPlain(current_path()),
            'view_base_path' => $view->getPath(),
            'view_dom_id' => $view->dom_id,
            // To fit multiple views on a page, the programmer may have
            // overridden the display's pager_element.
            'pager_element' => isset($view->pager) ? $view->pager->getPagerId() : 0,
          ),
        ),
      ),
    );
    $view->element['#attached']['js'][] = array('type' => 'setting', 'data' => $settings);
    $view->element['#attached']['library'][] = 'views/views.ajax';
  }

  return $view;
}

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

98
  $view = Views::getView($element['#name']);
99
  if ($view && $view->access($element['#display_id'])) {
100
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
101 102 103 104 105
  }

  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
106
/**
107 108 109 110
 * Implements hook_theme().
 *
 * Register views theming functions and those that are defined via views plugin
 * definitions.
merlinofchaos's avatar
merlinofchaos committed
111 112
 */
function views_theme($existing, $type, $theme, $path) {
113
  \Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
114 115 116

  // Some quasi clever array merging here.
  $base = array(
117
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
118 119 120 121 122
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
123
    'template' => 'views-mini-pager',
merlinofchaos's avatar
merlinofchaos committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145
  );

  $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),
146
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
147 148
  );

149
  $plugins = Views::getPluginDefinitions();
150
  $module_handler = \Drupal::moduleHandler();
merlinofchaos's avatar
merlinofchaos committed
151

152 153 154 155
  // 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
156
  foreach ($plugins as $type => $info) {
157
    foreach ($info as $def) {
158 159 160 161 162
      // 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;
      }
163 164 165 166
      // 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?
167
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
168 169
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
170

171 172 173
      $hooks[$def['theme']] = array(
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
174

175 176
      // For the views module we ensure views.theme.inc is included.
      if ($def['provider'] == 'views') {
177 178
        $def['theme_file'] = 'views.theme.inc';
      }
179 180
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
merlinofchaos's avatar
merlinofchaos committed
181

182
      // The theme_file definition is always relative to the modules directory.
183
      if (isset($def['theme_file'])) {
184
        $hooks[$def['theme']]['path'] = $module_dir;
185 186
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
187 188 189 190
      // 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'];
191 192
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
193 194
        }
      }
195 196 197 198 199 200
     // 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.
201
      if (!function_exists('theme_' . $def['theme'])) {
202 203
        $hooks[$def['theme']]['path'] = $module_dir;
        $hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
204
      }
merlinofchaos's avatar
merlinofchaos committed
205 206 207 208 209 210 211 212 213 214 215 216 217 218
    }
  }

  $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),
219
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
220 221 222 223 224 225 226 227 228 229 230 231 232
  );

  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.
 */
233
function views_preprocess_node(&$variables) {
234
  \Drupal::moduleHandler()->loadInclude('node', 'views.inc');
235 236
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
237 238
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
239 240 241 242 243 244 245
    // 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
246 247 248 249
    }
  }

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

255 256 257 258 259 260 261 262 263 264 265 266 267
/**
 * 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
268 269 270 271
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
272
function views_preprocess_comment(&$variables) {
273 274
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
275
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
276
    $variables['view'] = $variables['comment']->view;
277 278 279 280 281 282 283 284 285 286 287 288
  }
}

/**
 * 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
289 290 291 292 293
    }
  }
}

/**
294
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
295 296 297 298 299 300
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
301
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
302 303 304 305
    ),
  );
}

306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
/**
 * Implements hook_menu_link_defaults_alter().
 */
function views_menu_link_defaults_alter(array &$links) {
  // @todo Decide what to do with all the crazy logic in views_menu_alter() in
  // https://drupal.org/node/2107533.
  $views = Views::getApplicableViews('uses_hook_menu');
  foreach ($views as $data) {
    /** @var \Drupal\views\ViewExecutable $view */
    list($view, $display_id) = $data;
    $result = $view->executeHookMenuLinkDefaults($display_id, $links);
    foreach ($result as $link_id => $link) {
      $links[$link_id] = $link;
    }
  }
}

merlinofchaos's avatar
merlinofchaos committed
323 324 325 326 327 328 329
/**
 * 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.
330
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
331 332 333 334 335 336 337
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
338
function views_preprocess_page(&$variables) {
339 340 341 342 343
  // Early-return to prevent adding unnecessary JavaScript.
  if (!user_access('access contextual links')) {
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
344 345 346 347 348 349 350 351 352
  // 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
353 354
  // 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
355
  // JavaScript that will insert it back in the correct place.
356
  if (!empty($variables['page']['#views_contextual_links']) && isset($variables['attributes']['class'])) {
357 358 359 360 361 362
    /** @var \Drupal\Core\Page\HtmlPage $page_object */
    $page_object = $variables['page']['#page'];
    $attributes = $page_object->getBodyAttributes();
    $class = $attributes['class'] ?: array();

    $key = array_search('contextual-region', $variables['attributes']['class'] instanceof AttributeArray ? $variables['attributes']['class']->value() : $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
363
    if ($key !== FALSE) {
364 365 366 367
      /** @var \Drupal\Core\Page\HtmlPage $page_object */
      unset($class[$key]);
      $attributes['class'] = $class;
      $attributes['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
368 369
      $attached['#attached']['library'][] = 'views/views.contextual-links';
      drupal_render($attached);
merlinofchaos's avatar
merlinofchaos committed
370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    }
  }
}

/**
 * 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
385 386 387
 * '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
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422
 *
 * 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
423 424 425
 *   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
426 427 428 429 430
 * @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.
 *
431
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
432 433 434
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
435
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
436 437
  // Do not do anything if the view is configured to hide its administrative
  // links.
438
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
439 440 441
    // 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.
442
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
443
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
444
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
445
    // avoid displaying any contextual links at all, a display plugin can still
446
    // set 'contextual_links_locations' to, e.g., {""}.)
447 448 449

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
450
    }
451
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
452 453
      $plugin['contextual_links_locations'] = array();
    }
454 455 456 457
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
458
    // On exposed_forms blocks contextual links should always be visible.
459
    $plugin['contextual_links_locations'][] = 'exposed_filter';
460 461
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
462
      foreach ($plugin['contextual links'] as $group => $link) {
merlinofchaos's avatar
merlinofchaos committed
463 464
        $args = array();
        $valid = TRUE;
465 466
        if (!empty($link['route_parameters_names'])) {
          foreach ($link['route_parameters_names'] as $parameter_name => $property) {
merlinofchaos's avatar
merlinofchaos committed
467
            // If the plugin is trying to create an invalid contextual link
468 469 470 471
            // (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
472 473 474 475
              $valid = FALSE;
              break;
            }
            else {
476
              $args[$parameter_name] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
477 478 479 480 481 482
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
483
          $render_element['#views_contextual_links'] = TRUE;
484 485 486
          $render_element['#contextual_links'][$group] = array(
            'route_parameters' => $args,
            'metadata' => array(
487 488 489
              'location' => $location,
              'name' => $view->storage->id(),
              'display_id' => $display_id,
490
            ),
merlinofchaos's avatar
merlinofchaos committed
491 492 493 494 495 496 497 498
          );
        }
      }
    }
  }
}

/**
499
 * Prepares a list of language names.
merlinofchaos's avatar
merlinofchaos committed
500
 *
501 502
 * This is a wrapper around \Drupal::languageManager()->getLanguages() to return
 * a plain key value array.
merlinofchaos's avatar
merlinofchaos committed
503
 *
504 505 506 507 508
 * @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.
509 510
 *   It can be: Language::STATE_CONFIGURABLE, Language::STATE_LOCKED,
 *   Language::STATE_ALL.
511 512 513
 *
 * @return array
 *   An array of language names (or $field) keyed by the langcode.
merlinofchaos's avatar
merlinofchaos committed
514 515 516
 *
 * @see locale_language_list()
 */
517
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
518
  $languages = \Drupal::languageManager()->getLanguages($flags);
merlinofchaos's avatar
merlinofchaos committed
519 520
  $list = array();
  foreach ($languages as $language) {
521
    $list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
522 523 524 525
  }
  return $list;
}

526 527 528 529 530 531 532 533
/**
 * Implements hook_ENTITY_TYPE_create() for 'field_instance_config'.
 */
function views_field_instance_config_create(FieldInstanceConfigInterface $field_instance) {
  // @todo: Is this necessary? Use cache tags to only delete Views' cache data?
  \Drupal::cache('discovery')->deleteAll();
}

merlinofchaos's avatar
merlinofchaos committed
534
/**
535
 * Implements hook_ENTITY_TYPE_update() for 'field_instance_config'.
merlinofchaos's avatar
merlinofchaos committed
536
 */
537
function views_field_instance_config_update(FieldInstanceConfigInterface $field_instance) {
538
  Cache::deleteTags(array('extension' => 'views'));
539
  \Drupal::cache('render')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
540 541 542
}

/**
543
 * Implements hook_ENTITY_TYPE_delete() for 'field_instance_config'.
merlinofchaos's avatar
merlinofchaos committed
544
 */
545
function views_field_instance_config_delete(FieldInstanceConfigInterface $field_instance) {
546
  Cache::deleteTags(array('extension' => 'views'));
547
  \Drupal::cache('render')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
548 549 550 551 552 553
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
554 555
  // Clear the page and block cache and Views' info cache entries.
  Cache::deleteTags(array('content' => TRUE, 'extension' => 'views'));
556 557

  // Set the menu as needed to be rebuilt.
558
  \Drupal::service('router.builder')->setRebuildNeeded();
559

560
  $module_handler = \Drupal::moduleHandler();
561

562 563 564
  // Reset the RouteSubscriber from views.
  \Drupal::getContainer()->get('views.route_subscriber')->reset();

565
  // Invalidate the block cache to update views block derivatives.
566
  if ($module_handler->moduleExists('block')) {
567
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
568 569
  }

570
  // Allow modules to respond to the Views cache being cleared.
571
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
}

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

/**
588
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
589
 *
590 591 592 593
 * 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
594 595 596 597 598 599 600 601 602 603
 *   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
 *
604
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
605 606 607 608 609 610 611 612 613 614 615
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
616
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
617
 *
618 619 620 621
 * 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
622
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
623 624 625 626 627
 */
function &views_get_current_view() {
  return views_set_current_view();
}

628 629 630 631
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
632 633 634 635 636 637 638 639 640
  $hooks = array();

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

641 642 643 644 645 646 647
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

648 649 650 651 652 653 654 655 656 657 658 659
  $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'));
660 661

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
662 663 664 665 666 667 668 669 670 671 672 673 674 675 676
}

/**
 * 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'.
677
 *
678 679
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::fetchPluginNames().
merlinofchaos's avatar
merlinofchaos committed
680 681
 */
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
682
  return Views::fetchPluginNames($type, $key, $base);
merlinofchaos's avatar
merlinofchaos committed
683 684
}

685
/**
686 687 688
 * Gets all the views plugin definitions.
 *
 * @return array
689
 *   An array of plugin definitions for all types.
690
 *
691 692
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getPluginDefinitions().
693
 */
694
function views_get_plugin_definitions() {
695 696
  return Views::getPluginDefinitions();
}
697

698 699 700 701 702 703 704 705 706 707 708 709
/**
 * 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.
 *
710 711
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::pluginList().
712 713 714
 */
function views_plugin_list() {
  return Views::pluginList();
715 716
}

717 718
/**
 * Get enabled display extenders.
719
 *
720 721
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getEnabledDisplayExtenders().
722 723
 */
function views_get_enabled_display_extenders() {
724
  return Views::getEnabledDisplayExtenders();
725 726
}

merlinofchaos's avatar
merlinofchaos committed
727 728 729 730
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
731 732 733 734 735
 * @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
736 737 738 739 740 741
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
742
 *
743 744
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getApplicableViews().
merlinofchaos's avatar
merlinofchaos committed
745 746
 */
function views_get_applicable_views($type) {
747
  return Views::getApplicableViews($type);
merlinofchaos's avatar
merlinofchaos committed
748 749 750
}

/**
751
 * Returns an array of all views as fully loaded $view objects.
752
 *
753 754
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getAllViews().
merlinofchaos's avatar
merlinofchaos committed
755
 */
756
function views_get_all_views() {
757
  return Views::getAllViews();
758 759
}

merlinofchaos's avatar
merlinofchaos committed
760 761
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
762
 *
763 764
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getEnabledViews().
merlinofchaos's avatar
merlinofchaos committed
765 766
 */
function views_get_enabled_views() {
767
  return Views::getEnabledViews();
merlinofchaos's avatar
merlinofchaos committed
768 769 770 771
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
772
 *
773 774
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getDisabledViews().
merlinofchaos's avatar
merlinofchaos committed
775 776
 */
function views_get_disabled_views() {
777
  return Views::getDisabledViews();
merlinofchaos's avatar
merlinofchaos committed
778 779 780 781 782 783 784 785 786 787 788 789 790 791
}

/**
 * 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
792
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
793 794 795 796 797
 *  - 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
798 799
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
800 801 802 803
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
804
 *
805 806
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getViewsAsOptions().
merlinofchaos's avatar
merlinofchaos committed
807
 */
808
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
809
  return Views::getViewsAsOptions($views_only, $filter, $exclude_view, $optgroup, $sort);
merlinofchaos's avatar
merlinofchaos committed
810 811 812
}

/**
dawehner's avatar
dawehner committed
813 814
 * Returns whether the view is enabled.
 *
815
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
816
 *   The view object to check.
dawehner's avatar
dawehner committed
817 818 819
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
820
 */
821
function views_view_is_enabled(View $view) {
822
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
823 824 825
}

/**
dawehner's avatar
dawehner committed
826 827
 * Returns whether the view is disabled.
 *
828
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
829
 *   The view object to check.
dawehner's avatar
dawehner committed
830 831 832
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
833
 */
834
function views_view_is_disabled(View $view) {
835
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
836 837
}

838
/**
839
 * Enables and saves a view.
840
 *
841
 * @param \Drupal\views\Entity\View $view
842
 *   The View object to disable.
843
 */
844
function views_enable_view(View $view) {
845
  $view->enable()->save();
846 847 848
}

/**
849
 * Disables and saves a view.
850
 *
851
 * @param \Drupal\views\Entity\View $view
852
 *   The View object to disable.
853
 */
854
function views_disable_view(View $view) {
855
  $view->disable()->save();
856 857
}

merlinofchaos's avatar
merlinofchaos committed
858
/**
xjm's avatar
xjm committed
859
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
860
 *
xjm's avatar
xjm committed
861
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
862
 *   The name of the view.
xjm's avatar
xjm committed
863
 *
864
 * @return \Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
865
 *   A reference to the $view object.
866
 *
867 868
 * @deprecated in Drupal 8.x-dev, will be removed before Drupal 8.0.
 *   Use \Drupal\views\Views::getView().
merlinofchaos's avatar
merlinofchaos committed
869
 */
870
function views_get_view($name) {
871
  return Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
872 873
}

874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897
/**
 * 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().
898
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
899 900 901 902 903 904 905 906
  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']);

907
  // Sort, render and add remaining form fields.
908
  $children = Element::children($element, TRUE);
909
  $element['#children'] = drupal_render_children($element, $children);
910 911 912
  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
/**
 * 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;
}

/**
 * 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().
 */
931
function views_query_views_alter(AlterableInterface $query) {
merlinofchaos's avatar
merlinofchaos committed
932
  $substitutions = $query->getMetaData('views_substitutions');
933 934
  $tables = &$query->getTables();
  $where = &$query->conditions();
merlinofchaos's avatar
merlinofchaos committed
935 936 937 938 939 940 941 942 943 944

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

945
  // Replaces substitions in filter criteria.
merlinofchaos's avatar
merlinofchaos committed
946 947 948 949 950 951
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
952
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
merlinofchaos's avatar
merlinofchaos committed
953 954 955 956 957 958
  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'])) {
959
        $sub_conditions = &$condition['field']->conditions();
merlinofchaos's avatar
merlinofchaos committed
960 961 962
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
963
      // Therefore make sure to get the metadata of the main query.
merlinofchaos's avatar
merlinofchaos committed
964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
      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
986
 * loading the view, getting the preview and then getting $view->getTitle().
merlinofchaos's avatar
merlinofchaos committed
987 988 989 990 991 992 993 994 995 996 997
 *
 * @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();
998 999
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
merlinofchaos's avatar
merlinofchaos committed
1000

1001
  $view = Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027
  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();
1028 1029
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
merlinofchaos's avatar
merlinofchaos committed
1030

1031
  $view = Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
1032 1033
  if (is_object($view)) {
    if (is_array($args)) {
1034
      $view->setArguments($args);
merlinofchaos's avatar
merlinofchaos committed
1035 1036
    }
    if (is_string($display_id)) {
1037
      $view->setDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
1038 1039
    }
    else {
1040
      $view->initDisplay();
merlinofchaos's avatar
merlinofchaos committed
1041
    }
1042
    $view->preExecute();
merlinofchaos's avatar
merlinofchaos committed
1043 1044 1045 1046 1047 1048 1049 1050 1051
    $view->execute();
    return $view->result;
  }
  else {
    return array();
  }
}

/**
1052
 * #process callback to see if we need to String::checkPlain() the options.
merlinofchaos's avatar
merlinofchaos committed
1053 1054 1055 1056 1057 1058 1059 1060 1061
 *
 * 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') {
1062
    $element['#options'] = array_map('\Drupal\Component\Utility\String::checkPlain', $element['#options']);
merlinofchaos's avatar
merlinofchaos committed
1063 1064 1065 1066
  }
  return $element;
}

1067 1068 1069 1070 1071 1072 1073
/**
 * 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)) {
1074
      form_error($element, $form_state, t('The query tags may only contain lower-case alphabetical characters and underscores.'));
1075 1076 1077 1078
      return;
    }
  }
}
1079 1080 1081 1082 1083 1084 1085 1086 1087

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