views.module 35.3 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Primarily Drupal hooks and global API functions to manipulate views.
 */

8
use Drupal\Component\Render\MarkupInterface;
9
use Drupal\Component\Utility\Html;
10
use Drupal\Core\Database\Query\AlterableInterface;
11
use Drupal\Core\Entity\EntityInterface;
12
use Drupal\Core\Form\FormStateInterface;
13
use Drupal\Core\Routing\RouteMatchInterface;
14
use Drupal\Core\Url;
15
use Drupal\views\Plugin\Derivative\ViewsLocalTask;
16
use Drupal\views\ViewEntityInterface;
17
use Drupal\views\ViewExecutable;
18
use Drupal\views\Entity\View;
19
use Drupal\views\Render\ViewsRenderPipelineMarkup;
20
use Drupal\views\Views;
21

22 23 24
/**
 * Implements hook_help().
 */
25
function views_help($route_name, RouteMatchInterface $route_match) {
26 27
  switch ($route_name) {
    case 'help.page.views':
28 29 30
      $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>';
31 32
      $output .= '<p>' . t('For more information, see the <a href=":views">online documentation for the Views module</a>.', [':views' => 'https://www.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.', [':views-ui' => (\Drupal::moduleHandler()->moduleExists('views_ui')) ? \Drupal::url('help.page', ['name' => 'views_ui']) : '#']) . '</p>';
33 34 35 36 37
      $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>';
38
      $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>.', [':node' => 'https://www.drupal.org/documentation/modules/views/add-ons']) . '</dd>';
39 40
      $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>';
41 42 43 44
      $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>';
45 46 47 48 49
      $output .= '</dl>';
      return $output;
  }
}

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

  return $view;
}

78
/**
79 80 81 82
 * Implements hook_theme().
 *
 * Register views theming functions and those that are defined via views plugin
 * definitions.
83 84
 */
function views_theme($existing, $type, $theme, $path) {
85
  \Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
86 87

  // Some quasi clever array merging here.
88
  $base = [
89
    'file' => 'views.theme.inc',
90
  ];
91 92

  // Our extra version of pager from pager.inc
93 94 95
  $hooks['views_mini_pager'] = $base + [
    'variables' => ['tags' => [], 'quantity' => 9, 'element' => 0, 'parameters' => []],
  ];
96

97
  $variables = [
98 99 100
    // 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.
101 102
    'display' => [
      'view_array' => [],
103
      'view' => NULL,
104 105 106 107 108 109 110 111
      'rows' => [],
      'header' => [],
      'footer' => [],
      'empty' => [],
      'exposed' => [],
      'more' => [],
      'feed_icons' => [],
      'pager' => [],
112
      'title' => '',
113 114 115 116 117 118 119
      'attachment_before' => [],
      'attachment_after' => [],
    ],
    'style' => ['view' => NULL, 'options' => NULL, 'rows' => NULL, 'title' => NULL],
    'row' => ['view' => NULL, 'options' => NULL, 'row' => NULL, 'field_alias' => NULL],
    'exposed_form' => ['view' => NULL, 'options' => NULL],
    'pager' => [
120 121 122 123 124 125
      'view' => NULL,
      'options' => NULL,
      'tags' => [],
      'quantity' => 9,
      'element' => 0,
      'parameters' => [],
126 127
    ],
  ];
128 129

  // Default view themes
130 131 132 133 134 135
  $hooks['views_view_field'] = $base + [
    'variables' => ['view' => NULL, 'field' => NULL, 'row' => NULL],
  ];
  $hooks['views_view_grouping'] = $base + [
    'variables' => ['view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL],
  ];
136

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

150
  $module_handler = \Drupal::moduleHandler();
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.
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
      // 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.
166
      // @todo: watchdog or exception?
167
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
168 169
        continue;
      }
170

171
      $hooks[$def['theme']] = [
172
        'variables' => $variables[$type],
173
      ];
174

175 176
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
177
      $hooks[$def['theme']]['path'] = $module_dir;
178

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

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

      // 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.
207
      if (!function_exists('theme_' . $def['theme'])) {
208
        $hooks[$def['theme']]['path'] .= '/templates';
209
        $hooks[$def['theme']]['template'] = Html::cleanCssIdentifier($def['theme']);
210 211 212
      }
      else {
        $hooks[$def['theme']]['function'] = 'theme_' . $def['theme'];
213
      }
214 215 216
    }
  }

217
  $hooks['views_form_views_form'] = $base + [
218
    'render element' => 'form',
219
  ];
220

221
  $hooks['views_exposed_form'] = $base + [
222
    'render element' => 'form',
223
  ];
224 225 226 227 228 229 230 231 232 233 234 235

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

252 253 254 255 256 257 258 259 260 261 262 263 264
/**
 * 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;
    }
  }
}

265 266 267 268
/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
269
function views_preprocess_comment(&$variables) {
270 271
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
272
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
273
    $variables['view'] = $variables['comment']->view;
274 275 276 277 278 279 280 281 282 283 284 285
  }
}

/**
 * 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;
286 287 288 289
    }
  }
}

290 291 292 293
/**
 * Implements hook_theme_suggestions_HOOK_alter().
 */
function views_theme_suggestions_container_alter(array &$suggestions, array $variables) {
294
  if (!empty($variables['element']['#type']) && $variables['element']['#type'] == 'more_link' && !empty($variables['element']['#view']) && $variables['element']['#view'] instanceof ViewExecutable) {
295 296 297 298
    $suggestions = array_merge($suggestions, $variables['element']['#view']->buildThemeFunctions('container__more_link'));
  }
}

299 300 301 302 303 304 305 306 307 308 309
/**
 * 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
310 311 312
 * '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.
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
 *
 * 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
329 330 331 332
 *   should be suitable for passing in to
 *   \Drupal\Core\Render\RendererInterface::render() and will normally contain a
 *   representation of the view display whose contextual links are being
 *   requested.
333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348
 * @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
349 350 351
 *   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.
352
 * @param string $display_id
353
 *   The ID of the display within $view whose contextual links will be added.
354 355 356 357 358 359
 * @param array $view_element
 *   The render array of the view. It should contain the following properties:
 *     - #view_id: The ID of the view.
 *     - #view_display_show_admin_links: A boolean whether the admin links
 *       should be shown.
 *     - #view_display_plugin_id: The plugin ID of the display.
360
 *
361
 * @see \Drupal\views\Plugin\Block\ViewsBlock::addContextualLinks()
362
 * @see views_preprocess_page()
363 364
 * @see template_preprocess_views_view()
 */
365 366 367 368 369 370 371 372 373
function views_add_contextual_links(&$render_element, $location, $display_id, array $view_element = NULL) {
  if (!isset($view_element)) {
    $view_element = $render_element;
  }
  $view_element['#cache_properties'] = ['view_id', 'view_display_show_admin_links', 'view_display_plugin_id'];
  $view_id = $view_element['#view_id'];
  $show_admin_links = $view_element['#view_display_show_admin_links'];
  $display_plugin_id = $view_element['#view_display_plugin_id'];

374
  // Do not do anything if the view is configured to hide its administrative
375
  // links or if the Contextual Links module is not enabled.
376
  if (\Drupal::moduleHandler()->moduleExists('contextual') && $show_admin_links) {
377 378 379
    // 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.
380
    $plugin = Views::pluginManager('display')->getDefinition($display_plugin_id);
381
    // If contextual_links_locations are not set, provide a sane default. (To
382
    // avoid displaying any contextual links at all, a display plugin can still
383
    // set 'contextual_links_locations' to, e.g., {""}.)
384 385

    if (!isset($plugin['contextual_links_locations'])) {
386
      $plugin['contextual_links_locations'] = ['view'];
387
    }
388 389
    elseif ($plugin['contextual_links_locations'] == [] || $plugin['contextual_links_locations'] == ['']) {
      $plugin['contextual_links_locations'] = [];
390
    }
391
    else {
392
      $plugin += ['contextual_links_locations' => ['view']];
393 394
    }

395
    // On exposed_forms blocks contextual links should always be visible.
396
    $plugin['contextual_links_locations'][] = 'exposed_filter';
397 398
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
399
      foreach ($plugin['contextual links'] as $group => $link) {
400
        $args = [];
401
        $valid = TRUE;
402
        if (!empty($link['route_parameters_names'])) {
403 404 405
          $view_storage = \Drupal::entityManager()
            ->getStorage('view')
            ->load($view_id);
406
          foreach ($link['route_parameters_names'] as $parameter_name => $property) {
407
            // If the plugin is trying to create an invalid contextual link
408 409 410
            // (for example, "path/to/{$view->storage->property}", where
            // $view->storage->{property} does not exist), we cannot construct
            // the link, so we skip it.
411
            if (!property_exists($view_storage, $property)) {
412 413 414 415
              $valid = FALSE;
              break;
            }
            else {
416
              $args[$parameter_name] = $view_storage->get($property);
417 418 419 420 421 422
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
423
          $render_element['#views_contextual_links'] = TRUE;
424
          $render_element['#contextual_links'][$group] = [
425
            'route_parameters' => $args,
426
            'metadata' => [
427
              'location' => $location,
428
              'name' => $view_id,
429
              'display_id' => $display_id,
430 431
            ],
          ];
432 433 434
          // 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.
435
          $render_element['#cache']['contexts'][] = 'user.permissions';
436 437 438 439 440 441
        }
      }
    }
  }
}

442
/**
443
 * Implements hook_ENTITY_TYPE_insert() for 'field_config'.
444
 */
445
function views_field_config_insert(EntityInterface $field) {
446
  Views::viewsData()->clear();
447 448
}

449
/**
450
 * Implements hook_ENTITY_TYPE_update() for 'field_config'.
451
 */
452
function views_field_config_update(EntityInterface $entity) {
453
  Views::viewsData()->clear();
454 455 456
}

/**
457
 * Implements hook_ENTITY_TYPE_delete() for 'field_config'.
458
 */
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
function views_field_config_delete(EntityInterface $entity) {
  Views::viewsData()->clear();
}

/**
 * Implements hook_ENTITY_TYPE_insert().
 */
function views_base_field_override_insert(EntityInterface $entity) {
  Views::viewsData()->clear();
}

/**
 * Implements hook_ENTITY_TYPE_update().
 */
function views_base_field_override_update(EntityInterface $entity) {
  Views::viewsData()->clear();
}

/**
 * Implements hook_ENTITY_TYPE_delete().
 */
function views_base_field_override_delete(EntityInterface $entity) {
481
  Views::viewsData()->clear();
482 483 484 485 486 487
}

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

491
  $module_handler = \Drupal::moduleHandler();
492

493 494 495
  // Reset the RouteSubscriber from views.
  \Drupal::getContainer()->get('views.route_subscriber')->reset();

496
  // Invalidate the block cache to update views block derivatives.
497
  if ($module_handler->moduleExists('block')) {
498
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
499 500
  }

501
  // Allow modules to respond to the Views cache being cleared.
502
  $module_handler->invokeAll('views_invalidate_cache');
503 504 505 506 507 508
}

/**
 * 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
 *
509
 * @return \Drupal\views\ViewExecutable
510 511 512 513 514 515 516 517 518 519 520
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
521
 * Find out what, if any, current view is currently in use.
522
 *
523 524 525 526
 * Note that this returns a reference, so be careful! You can unintentionally
 * modify the $view object.
 *
 * @return \Drupal\views\ViewExecutable
527
 *   The current view object.
528 529 530 531 532
 */
function &views_get_current_view() {
  return views_set_current_view();
}

533 534 535 536
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
537
  $hooks = [];
538

539
  $hooks += array_fill_keys([
540 541 542 543
    'views_data',
    'views_data_alter',
    'views_analyze',
    'views_invalidate_cache',
544
  ], ['group' => 'views']);
545

546 547
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
548
    $hooks['views_plugins_' . $type . '_alter'] = [
549
      'group' => 'views',
550
    ];
551 552
  }

553
  $hooks += array_fill_keys([
554 555 556 557 558 559 560 561 562 563
    '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',
564
  ], ['group' => 'views_execution']);
565

566
  $hooks['field_views_data'] = [
567
    'group' => 'views',
568 569
  ];
  $hooks['field_views_data_alter'] = [
570
    'group' => 'views',
571
  ];
572

573
  return $hooks;
574 575 576
}

/**
577 578
 * Returns whether the view is enabled.
 *
579
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
580
 *   The view object to check.
581 582 583
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
584
 */
585
function views_view_is_enabled(View $view) {
586
  return $view->status();
587 588 589
}

/**
590 591
 * Returns whether the view is disabled.
 *
592
 * @param \Drupal\views\Entity\View $view
xjm's avatar
xjm committed
593
 *   The view object to check.
594 595 596
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
597
 */
598
function views_view_is_disabled(View $view) {
599
  return !$view->status();
600 601
}

602
/**
603
 * Enables and saves a view.
604
 *
605
 * @param \Drupal\views\Entity\View $view
606
 *   The View object to disable.
607
 */
608
function views_enable_view(View $view) {
609
  $view->enable()->save();
610 611 612
}

/**
613
 * Disables and saves a view.
614
 *
615
 * @param \Drupal\views\Entity\View $view
616
 *   The View object to disable.
617
 */
618
function views_disable_view(View $view) {
619
  $view->disable()->save();
620 621
}

622 623 624 625 626 627 628 629 630 631 632 633
/**
 * 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).
634 635
  $search = [];
  $replace = [];
636 637 638 639 640 641 642

  // 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'];
643
    $replace[] = isset($element[$field_name][$row_id]) ? \Drupal::service('renderer')->render($element[$field_name][$row_id]) : '';
644 645
  }
  // Add in substitutions from hook_views_form_substitutions().
646
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
647
  foreach ($substitutions as $placeholder => $substitution) {
648 649
    $search[] = Html::escape($placeholder);
    // Ensure that any replacements made are safe to make.
650
    if (!($substitution instanceof MarkupInterface)) {
651 652
      $substitution = Html::escape($substitution);
    }
653 654 655 656
    $replace[] = $substitution;
  }

  // Apply substitutions to the rendered output.
657
  $output = str_replace($search, $replace, \Drupal::service('renderer')->render($element['output']));
658
  $element['output'] = ['#markup' => ViewsRenderPipelineMarkup::create($output)];
659 660 661 662

  return $element;
}

663
/**
664
 * Implements hook_form_alter() for the exposed form.
665 666 667 668
 *
 * Since the exposed form is a GET form, we don't want it to send a wide
 * variety of information.
 */
669
function views_form_views_exposed_form_alter(&$form, FormStateInterface $form_state) {
670 671 672 673 674 675 676 677 678 679 680
  $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().
 */
681
function views_query_views_alter(AlterableInterface $query) {
682
  $substitutions = $query->getMetaData('views_substitutions');
683 684
  $tables = &$query->getTables();
  $where = &$query->conditions();
685

686
  // Replaces substitutions in tables.
687 688
  foreach ($tables as $table_name => $table_metadata) {
    foreach ($table_metadata['arguments'] as $replacement_key => $value) {
689 690 691 692 693 694 695 696 697 698 699
      if (!is_array($value)) {
        if (isset($substitutions[$value])) {
          $tables[$table_name]['arguments'][$replacement_key] = $substitutions[$value];
        }
      }
      else {
        foreach ($value as $sub_key => $sub_value) {
          if (isset($substitutions[$sub_value])) {
            $tables[$table_name]['arguments'][$replacement_key][$sub_key] = $substitutions[$sub_value];
          }
        }
700 701 702 703
      }
    }
  }

704
  // Replaces substitutions in filter criteria.
705 706 707 708 709 710
  _views_query_tag_alter_condition($query, $where, $substitutions);
}

/**
 * Replaces the substitutions recursive foreach condition.
 */
711
function _views_query_tag_alter_condition(AlterableInterface $query, &$conditions, $substitutions) {
712 713 714 715 716 717
  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'])) {
718
        $sub_conditions = &$condition['field']->conditions();
719 720 721
        _views_query_tag_alter_condition($query, $sub_conditions, $substitutions);
      }
      // $condition['value'] is a subquery so alter the subquery recursive.
722
      // Therefore make sure to get the metadata of the main query.
723 724 725 726 727 728
      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'])) {
729 730 731 732 733 734 735 736 737 738 739 740
        // 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']);
        }
741 742 743 744 745 746 747 748 749 750 751 752 753 754 755
      }
    }
  }
}

/**
 * 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
756
 * loading the view, getting the preview and then getting $view->getTitle().
757 758 759 760 761 762 763 764
 *
 * @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.
765 766 767 768
 *
 * @return array|null
 *   A renderable array containing the view output or NULL if the display ID
 *   of the view to be executed doesn't exist.
769 770 771
 */
function views_embed_view($name, $display_id = 'default') {
  $args = func_get_args();
772 773
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
774

775
  $view = Views::getView($name);
776 777 778 779
  if (!$view || !$view->access($display_id)) {
    return;
  }

780 781 782 783 784 785
  return [
    '#type' => 'view',
    '#name' => $name,
    '#display_id' => $display_id,
    '#arguments' => $args,
  ];
786 787 788 789 790 791 792 793 794 795 796
}

/**
 * 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
797
 *   display you want to use. A URL will appear in the status bar of your
798 799 800 801 802 803 804 805 806
 *   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();
807 808
  // Remove $name and $display_id from the arguments.
  unset($args[0], $args[1]);
809

810
  $view = Views::getView($name);
811 812
  if (is_object($view)) {
    if (is_array($args)) {
813
      $view->setArguments($args);
814 815
    }
    if (is_string($display_id)) {
816
      $view->setDisplay($display_id);
817 818
    }
    else {
819
      $view->initDisplay();
820
    }
821
    $view->preExecute();
822 823 824 825
    $view->execute();
    return $view->result;
  }
  else {
826
    return [];
827 828 829
  }
}

830 831 832
/**
 * Validation callback for query tags.
 */
833
function views_element_validate_tags($element, FormStateInterface $form_state) {
834 835 836
  $values = array_map('trim', explode(',', $element['#value']));
  foreach ($values as $value) {
    if (preg_match("/[^a-z_]/", $value)) {
837
      $form_state->setError($element, t('The query tags may only contain lower-case alphabetical characters and underscores.'));
838 839 840 841
      return;
    }
  }
}
842 843 844 845 846 847 848 849 850

/**
 * 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);
}
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865

/**
 * Implements hook_ENTITY_TYPE_delete().
 */
function views_view_delete(EntityInterface $entity) {
  // Rebuild the routes in case there is a routed display.
  $executable = Views::executableFactory()->get($entity);
  $executable->initDisplay();
  foreach ($executable->displayHandlers as $display) {
    if ($display->getRoutedDisplay()) {
      \Drupal::service('router.builder')->setRebuildNeeded();
      break;
    }
  }
}
866 867 868 869 870 871 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 898 899 900 901 902

/**
 * Implements hook_view_presave().
 *
 * Provides a BC layer for modules providing old configurations.
 */
function views_view_presave(ViewEntityInterface $view) {
  $displays = $view->get('display');
  $changed = FALSE;
  foreach ($displays as $display_name => &$display) {
    if (isset($display['display_options']['fields'])) {
      foreach ($display['display_options']['fields'] as $field_name => &$field) {
        if (isset($field['plugin_id']) && $field['plugin_id'] === 'entity_link') {
          // Add any missing settings for entity_link.
          if (!isset($field['output_url_as_text'])) {
            $field['output_url_as_text'] = FALSE;
            $changed = TRUE;
          }
          if (!isset($field['absolute'])) {
            $field['absolute'] = FALSE;
            $changed = TRUE;
          }
        }
        elseif (isset($field['plugin_id']) && $field['plugin_id'] === 'node_path') {
          // Convert the use of node_path to entity_link.
          $field['plugin_id'] = 'entity_link';
          $field['field'] = 'view_node';
          $field['output_url_as_text'] = TRUE;
          $changed = TRUE;
        }
      }
    }
  }
  if ($changed) {
    $view->set('display', $displays);
  }
}