views.module 35.3 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\Html;
13
use Drupal\Component\Utility\SafeMarkup;
14
use Drupal\Core\Cache\Cache;
15
use Drupal\Core\Database\Query\AlterableInterface;
16
use Drupal\Core\Form\FormStateInterface;
17
use Drupal\Core\Render\Element;
18
use Drupal\Core\Routing\RouteMatchInterface;
19
use Drupal\Core\Url;
20
use Drupal\views\Plugin\Derivative\ViewsLocalTask;
21
use Drupal\Core\Template\AttributeArray;
22
use Drupal\views\ViewExecutable;
23
use Drupal\Component\Plugin\Exception\PluginException;
24
use Drupal\views\Entity\View;
25
use Drupal\views\Views;
26
use Drupal\field\FieldConfigInterface;
27

28 29 30
/**
 * Implements hook_help().
 */
31
function views_help($route_name, RouteMatchInterface $route_match) {
32 33
  switch ($route_name) {
    case 'help.page.views':
34 35 36
      $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>';
37
      $output .= '<p>' . t('For more information, see the <a href="!views">online documentation for the Views module</a>.', array('!views' => 'https://www.drupal.org/documentation/modules/views')) . '</p>';
38
      $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::moduleHandler()->moduleExists('views_ui')) ? \Drupal::url('help.page', array('name' => 'views_ui'))  : '#')) . '</p>';
39 40 41 42 43
      $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>';
44
      $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://www.drupal.org/documentation/modules/views/add-ons')) . '</dd>';
45 46
      $output .= '<dt>' . t('Improving table accessibility') . '</dt>';
      $output .= '<dd>' . t('Views tables include semantic markup to improve accessibility. Data cells are automatically associated with header cells through id and header attributes. To improve the accessibility of your tables you can add descriptive elements within the Views table settings. The <em>caption</em> element can introduce context for a table, making it easier to understand. The <em>summary</em> element can provide an overview of how the data has been organized and how to navigate the table. Both the caption and summary are visible by default and also implemented according to HTML5 guidelines.') . '</dd>';
47 48 49 50
      $output .= '<dt>' . t('Working with multilingual views') . '</dt>';
      $output .= '<dd>' . t('If your site has multiple languages and translated entities, each result row in a view will contain one translation of each involved entity (a view can involve multiple entities if it uses relationships). You can use a filter to restrict your view to one language: without filtering, if an entity has three translations it will add three rows to the results; if you filter by language, at most one result will appear (it could be zero if that particular entity does not have a translation matching your language filter choice). If a view uses relationships, each entity in the relationship needs to be filtered separately. You can filter a view to a fixed language choice, such as English or Spanish, or to the language selected by the page the view is displayed on (the language that is selected for the page by the language detection settings either for Content or User interface).') . '</dd>';
      $output .= '<dd>' . t('Because each result row contains a specific translation of each entity, field-level filters are also relative to these entity translations. For example, if your view has a filter that specifies that the entity title should contain a particular English word, you will presumably filter out all rows containing Chinese translations, since they will not contain the English word. If your view also has a second filter specifying that the title should contain a particular Chinese word, and if you are using "And" logic for filtering, you will presumably end up with no results in the view, because there are probably not any entity translations containing both the English and Chinese words in the title.') . '</dd>';
      $output .= '<dd>' . t('Independent of filtering, you can choose the display language (the language used to display the entities and their fields) via a setting on the display. Your language choices are the same as the filter language choices, with an additional choice of "Content language of view row" and "Original language of content in view row", which means to display each entity in the result row using the language that entity has or in which it was originally created. In theory, this would give you the flexibility to filter to French translations, for instance, and then display the results in Spanish. The more usual choices would be to use the same language choices for the display language and each entity filter in the view, or to use the Row language setting for the display.') . '</dd>';
51 52 53 54 55
      $output .= '</dl>';
      return $output;
  }
}

56 57 58 59 60 61
/**
 * 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)) {
62
    $view->element['#attached']['drupalSettings']['views'] = array(
63 64 65 66 67
      'ajax_path' => \Drupal::url('views.ajax'),
      'ajaxViews' => array(
        'views_dom_id:' . $view->dom_id => array(
          'view_name' => $view->storage->id(),
          'view_display_id' => $view->current_display,
68 69
          'view_args' => SafeMarkup::checkPlain(implode('/', $view->args)),
          'view_path' => SafeMarkup::checkPlain(Url::fromRoute('<current>')->toString()),
70 71 72 73 74
          '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,
75 76 77 78 79 80 81 82 83
        ),
      ),
    );
    $view->element['#attached']['library'][] = 'views/views.ajax';
  }

  return $view;
}

merlinofchaos's avatar
merlinofchaos committed
84
/**
85 86 87 88
 * Implements hook_theme().
 *
 * Register views theming functions and those that are defined via views plugin
 * definitions.
merlinofchaos's avatar
merlinofchaos committed
89 90
 */
function views_theme($existing, $type, $theme, $path) {
91
  \Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
92 93 94

  // Some quasi clever array merging here.
  $base = array(
95
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
96 97 98 99
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
100
    'variables' => array('tags' => array(), 'quantity' => 9, 'element' => 0, 'parameters' => array()),
merlinofchaos's avatar
merlinofchaos committed
101 102 103 104 105 106
  );

  $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.
107 108 109 110 111 112 113 114 115
    'display' => array(
      'view_array' => array(),
      'view' => NULL,
      'rows' => array(),
      'header' => array(),
      'footer' => array(),
      'empty' => array(),
      'exposed' => array(),
      'more' => array(),
116
      'feed_icons' => array(),
117 118 119 120 121
      'pager' => array(),
      'title' => '',
      'attachment_before' => array(),
      'attachment_after' => array(),
    ),
merlinofchaos's avatar
merlinofchaos committed
122 123 124 125 126
    '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,
127
      'tags' => array(), 'quantity' => 9, 'element' => 0, 'parameters' => array()
merlinofchaos's avatar
merlinofchaos committed
128 129 130 131 132 133
    ),
  );

  // Default view themes
  $hooks['views_view_field'] = $base + array(
    'variables' => array('view' => NULL, 'field' => NULL, 'row' => NULL),
134
    'function' => 'theme_views_view_field',
merlinofchaos's avatar
merlinofchaos committed
135 136 137 138 139
  );
  $hooks['views_view_grouping'] = $base + array(
    'variables' => array('view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL),
  );

140 141 142 143 144 145 146 147 148 149 150 151 152
  // Only display, pager, row, and style plugins can provide theme hooks.
  $plugin_types = [
    'display',
    'pager',
    'row',
    'style',
    'exposed_form',
  ];
  $plugins = array();
  foreach ($plugin_types as $plugin_type) {
    $plugins[$plugin_type] = Views::pluginManager($plugin_type)->getDefinitions();
  }

153
  $module_handler = \Drupal::moduleHandler();
merlinofchaos's avatar
merlinofchaos committed
154

155 156 157 158
  // 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
159
  foreach ($plugins as $type => $info) {
160
    foreach ($info as $def) {
161 162 163 164 165
      // 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;
      }
166 167 168
      // For each theme registration, we have a base directory to check for the
      // templates folder. This will be relative to the root of the given module
      // folder, so we always need a module definition.
169
      // @todo: watchdog or exception?
170
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
171 172
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
173

174 175 176
      $hooks[$def['theme']] = array(
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
177

178 179
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
180
      $hooks[$def['theme']]['path'] = $module_dir;
merlinofchaos's avatar
merlinofchaos committed
181

182 183 184 185 186 187 188 189 190
      // For the views module we ensure views.theme.inc is included.
      if ($def['provider'] == 'views') {
        if (!isset($hooks[$def['theme']]['includes'])) {
          $hooks[$def['theme']]['includes'] = array();
        }
        if (!in_array('views.theme.inc', $hooks[$def['theme']]['includes'])) {
          $hooks[$def['theme']]['includes'][] = $module_dir . '/views.theme.inc';
        }
      }
191
      // The theme_file definition is always relative to the modules directory.
192
      elseif (!empty($def['theme_file'])) {
193 194
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
195 196

      // Whenever we have a theme file, we include it directly so we can
197 198
      // auto-detect the theme function.
      if (isset($def['theme_file'])) {
199
        $include = \Drupal::root() . '/' . $module_dir. '/' . $def['theme_file'];
200 201
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
202 203
        }
      }
204 205 206 207 208 209

      // If there is no theme function for the given theme definition, it must
      // be a template file. 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.
210
      if (!function_exists('theme_' . $def['theme'])) {
211
        $hooks[$def['theme']]['path'] .= '/templates';
212
        $hooks[$def['theme']]['template'] = Html::cleanCssIdentifier($def['theme']);
213 214 215
      }
      else {
        $hooks[$def['theme']]['function'] = 'theme_' . $def['theme'];
216
      }
merlinofchaos's avatar
merlinofchaos committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
    }
  }

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

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

  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.
 */
239
function views_preprocess_node(&$variables) {
240 241
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
242 243
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
244 245 246 247 248 249 250
    // 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
251 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 295 296
/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_container_alter(array &$suggestions, array $variables) {
297
  if (!empty($variables['element']['#type']) && $variables['element']['#type'] == 'more_link' && !empty($variables['element']['#view']) && $variables['element']['#view'] instanceof ViewExecutable) {
298 299 300 301
    $suggestions = array_merge($suggestions, $variables['element']['#view']->buildThemeFunctions('container__more_link'));
  }
}

merlinofchaos's avatar
merlinofchaos committed
302
/**
303 304 305 306 307 308 309 310 311 312 313
 * Implements hook_element_info_alter().
 *
 * @see views_page_display_pre_render()
 * @see views_preprocess_page()
 */
function views_element_info_alter(&$types) {
  $types['page']['#pre_render'][] = 'views_page_display_pre_render';
}

/**
 * #pre_render callback to set contextual links for views using a Page display.
merlinofchaos's avatar
merlinofchaos committed
314
 */
315
function views_page_display_pre_render(array $element) {
merlinofchaos's avatar
merlinofchaos committed
316 317 318
  // 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.
319
  if ($view = views_get_page_view()) {
320
    views_add_contextual_links($element, 'page', $view, $view->current_display);
merlinofchaos's avatar
merlinofchaos committed
321
  }
322
  return $element;
merlinofchaos's avatar
merlinofchaos committed
323 324 325 326 327
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
328
function views_preprocess_html(&$variables) {
329
  // Early-return to prevent adding unnecessary JavaScript.
330
  if (!\Drupal::moduleHandler()->moduleExists('contextual') || !\Drupal::currentUser()->hasPermission('access contextual links')) {
331 332 333
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
334
  // If the page contains a view as its main content, contextual links may have
335 336
  // been attached to the page as a whole; for example, by
  // views_page_display_pre_render().
merlinofchaos's avatar
merlinofchaos committed
337 338 339 340 341 342 343
  // 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
344 345
  // 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
346
  // JavaScript that will insert it back in the correct place.
347 348
  if (!empty($variables['page']['#views_contextual_links'])) {
    $variables['attributes']['data-views-page-contextual-id'] = _contextual_links_to_id($variables['page']['#contextual_links']);
merlinofchaos's avatar
merlinofchaos committed
349 350 351 352 353 354 355 356 357 358 359 360 361 362
  }
}

/**
 * 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
363 364 365
 * '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
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400
 *
 * 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
401 402 403
 *   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
404 405 406 407 408
 * @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.
 *
409
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
410
 * @see views_preprocess_page()
merlinofchaos's avatar
merlinofchaos committed
411 412
 * @see template_preprocess_views_view()
 */
413
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
414
  // Do not do anything if the view is configured to hide its administrative
415 416
  // links or if the Contextual Links module is not enabled.
  if (\Drupal::moduleHandler()->moduleExists('contextual') && $view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
417 418 419
    // 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.
420
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
421
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
422
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
423
    // avoid displaying any contextual links at all, a display plugin can still
424
    // set 'contextual_links_locations' to, e.g., {""}.)
425 426 427

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
428
    }
429
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
430 431
      $plugin['contextual_links_locations'] = array();
    }
432 433 434 435
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
436
    // On exposed_forms blocks contextual links should always be visible.
437
    $plugin['contextual_links_locations'][] = 'exposed_filter';
438 439
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
440
      foreach ($plugin['contextual links'] as $group => $link) {
merlinofchaos's avatar
merlinofchaos committed
441 442
        $args = array();
        $valid = TRUE;
443 444
        if (!empty($link['route_parameters_names'])) {
          foreach ($link['route_parameters_names'] as $parameter_name => $property) {
merlinofchaos's avatar
merlinofchaos committed
445
            // If the plugin is trying to create an invalid contextual link
446 447 448 449
            // (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
450 451 452 453
              $valid = FALSE;
              break;
            }
            else {
454
              $args[$parameter_name] = $view->storage->get($property);
merlinofchaos's avatar
merlinofchaos committed
455 456 457 458 459 460
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
461
          $render_element['#views_contextual_links'] = TRUE;
462 463 464
          $render_element['#contextual_links'][$group] = array(
            'route_parameters' => $args,
            'metadata' => array(
465 466 467
              'location' => $location,
              'name' => $view->storage->id(),
              'display_id' => $display_id,
468
            ),
merlinofchaos's avatar
merlinofchaos committed
469
          );
470 471 472 473 474 475
          // If we're setting contextual links on a page, for a page view, for a
          // user that may use contextual links, attach Views' contextual links
          // JavaScript.
          if ($location === 'page' && $render_element['#type'] === 'page' && \Drupal::currentUser()->hasPermission('access contextual links')) {
            $render_element['#attached']['library'][] = 'views/views.contextual-links';
          }
merlinofchaos's avatar
merlinofchaos committed
476 477 478 479 480 481
        }
      }
    }
  }
}

482
/**
483
 * Implements hook_ENTITY_TYPE_insert() for 'field_config'.
484
 */
485
function views_field_config_insert(FieldConfigInterface $field) {
486
  Views::viewsData()->clear();
487 488
}

merlinofchaos's avatar
merlinofchaos committed
489
/**
490
 * Implements hook_ENTITY_TYPE_update() for 'field_config'.
merlinofchaos's avatar
merlinofchaos committed
491
 */
492
function views_field_config_update(FieldConfigInterface $field) {
493
  Views::viewsData()->clear();
merlinofchaos's avatar
merlinofchaos committed
494 495 496
}

/**
497
 * Implements hook_ENTITY_TYPE_delete() for 'field_config'.
merlinofchaos's avatar
merlinofchaos committed
498
 */
499
function views_field_config_delete(FieldConfigInterface $field) {
500
  Views::viewsData()->clear();
merlinofchaos's avatar
merlinofchaos committed
501 502 503 504 505 506
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
507
  // Set the menu as needed to be rebuilt.
508
  \Drupal::service('router.builder')->setRebuildNeeded();
509

510
  $module_handler = \Drupal::moduleHandler();
511

512 513 514
  // Reset the RouteSubscriber from views.
  \Drupal::getContainer()->get('views.route_subscriber')->reset();

515
  // Invalidate the block cache to update views block derivatives.
516
  if ($module_handler->moduleExists('block')) {
517
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
518 519
  }

520
  // Allow modules to respond to the Views cache being cleared.
521
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537
}

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

/**
538
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
539
 *
540 541 542 543
 * 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
544 545 546 547 548 549 550 551 552 553
 *   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
 *
554
 * @return \Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
555 556 557 558 559 560 561 562 563 564 565
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
566
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
567
 *
568 569 570 571
 * 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
572
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
573 574 575 576 577
 */
function &views_get_current_view() {
  return views_set_current_view();
}

578 579 580 581
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
582 583 584 585 586 587 588 589 590
  $hooks = array();

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

591 592 593 594 595 596 597
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

598 599 600 601 602 603 604 605 606 607 608 609
  $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'));
610

611 612 613 614 615 616 617
  $hooks['field_views_data'] = array(
    'group' => 'views',
  );
  $hooks['field_views_data_alter'] = array(
    'group' => 'views',
  );

618
  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
619 620 621
}

/**
dawehner's avatar
dawehner committed
622 623
 * Returns whether the view is enabled.
 *
624
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
625
 *   The view object to check.
dawehner's avatar
dawehner committed
626 627 628
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
629
 */
630
function views_view_is_enabled(View $view) {
631
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
632 633 634
}

/**
dawehner's avatar
dawehner committed
635 636
 * Returns whether the view is disabled.
 *
637
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
638
 *   The view object to check.
dawehner's avatar
dawehner committed
639 640 641
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
642
 */
643
function views_view_is_disabled(View $view) {
644
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
645 646
}

647
/**
648
 * Enables and saves a view.
649
 *
650
 * @param \Drupal\views\Entity\View $view
651
 *   The View object to disable.
652
 */
653
function views_enable_view(View $view) {
654
  $view->enable()->save();
655 656 657
}

/**
658
 * Disables and saves a view.
659
 *
660
 * @param \Drupal\views\Entity\View $view
661
 *   The View object to disable.
662
 */
663
function views_disable_view(View $view) {
664
  $view->disable()->save();
665 666
}

667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690
/**
 * 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().
691
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
692 693 694 695 696 697
  foreach ($substitutions as $placeholder => $substitution) {
    $search[] = $placeholder;
    $replace[] = $substitution;
  }

  // Apply substitutions to the rendered output.
698
  $element['output'] = ['#markup' => SafeMarkup::replace($search, $replace, drupal_render($element['output']))];
699

700
  // Sort, render and add remaining form fields.
701
  $children = Element::children($element, TRUE);
702
  $element['#children'] = drupal_render_children($element, $children);
703

704 705 706
  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
707
/**
708
 * Implements hook_form_alter() for the exposed form.
merlinofchaos's avatar
merlinofchaos committed
709 710 711 712
 *
 * Since the exposed form is a GET form, we don't want it to send a wide
 * variety of information.
 */
713
function views_form_views_exposed_form_alter(&$form, FormStateInterface $form_state) {
merlinofchaos's avatar
merlinofchaos committed
714 715 716 717 718 719 720 721 722 723 724
  $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().
 */
725
function views_query_views_alter(AlterableInterface $query) {
merlinofchaos's avatar
merlinofchaos committed
726
  $substitutions = $query->getMetaData('views_substitutions');
727 728
  $tables = &$query->getTables();
  $where = &$query->conditions();
merlinofchaos's avatar
merlinofchaos committed
729

730
  // Replaces substitutions in tables.
merlinofchaos's avatar
merlinofchaos committed
731 732 733 734 735 736 737 738
  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];
      }
    }
  }

739
  // Replaces substitutions in filter criteria.
merlinofchaos's avatar
merlinofchaos committed
740 741 742 743 744 745
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
746
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
merlinofchaos's avatar
merlinofchaos committed
747 748 749 750 751 752
  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'])) {
753
        $sub_conditions = &$condition['field']->conditions();
merlinofchaos's avatar
merlinofchaos committed
754 755 756
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
757
      // Therefore make sure to get the metadata of the main query.
merlinofchaos's avatar
merlinofchaos committed
758 759 760 761 762 763
      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'])) {
764 765 766 767 768 769 770 771 772 773 774 775
        // We can not use a simple str_replace() here because it always returns
        // a string and we have to keep the type of the condition value intact.
        if (is_array($condition['value'])) {
          foreach ($condition['value'] as &$value) {
            if (is_string($value)) {
              $value = str_replace(array_keys($substitutions), array_values($substitutions), $value);
            }
          }
        }
        elseif (is_string($condition['value'])) {
          $condition['value'] = str_replace(array_keys($substitutions), array_values($substitutions), $condition['value']);
        }
merlinofchaos's avatar
merlinofchaos committed
776 777 778 779 780 781 782 783 784 785 786 787 788 789 790
      }
    }
  }
}

/**
 * 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
791
 * loading the view, getting the preview and then getting $view->getTitle().
merlinofchaos's avatar
merlinofchaos committed
792 793 794 795 796 797 798 799 800 801 802
 *
 * @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();
803 804
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
merlinofchaos's avatar
merlinofchaos committed
805

806
  $view = Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832
  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();
833 834
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
merlinofchaos's avatar
merlinofchaos committed
835

836
  $view = Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
837 838
  if (is_object($view)) {
    if (is_array($args)) {
839
      $view->setArguments($args);
merlinofchaos's avatar
merlinofchaos committed
840 841
    }
    if (is_string($display_id)) {
842
      $view->setDisplay($display_id);
merlinofchaos's avatar
merlinofchaos committed
843 844
    }
    else {
845
      $view->initDisplay();
merlinofchaos's avatar
merlinofchaos committed
846
    }
847
    $view->preExecute();
merlinofchaos's avatar
merlinofchaos committed
848 849 850 851 852 853 854 855
    $view->execute();
    return $view->result;
  }
  else {
    return array();
  }
}

856 857 858
/**
 * Validation callback for query tags.
 */
859
function views_element_validate_tags($element, FormStateInterface $form_state) {
860 861 862
  $values = array_map('trim', explode(',', $element['#value']));
  foreach ($values as $value) {
    if (preg_match("/[^a-z_]/", $value)) {
863
      $form_state->setError($element, t('The query tags may only contain lower-case alphabetical characters and underscores.'));
864 865 866 867
      return;
    }
  }
}
868 869 870 871 872 873 874 875 876

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