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

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

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

merlinofchaos's avatar
merlinofchaos committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44
/**
 * Implements hook_forms().
 *
 * To provide distinct form IDs for Views forms, the View name and
 * specific display name are appended to the base ID,
 * views_form_views_form. When such a form is built or submitted, this
 * function will return the proper callback function to use for the given form.
 */
function views_forms($form_id, $args) {
  if (strpos($form_id, 'views_form_') === 0) {
    return array(
      $form_id => array(
        'callback' => 'views_form',
      ),
    );
  }
}

/**
 * Returns a form ID for a Views form using the name and display of the View.
 */
function views_form_id($view) {
  $parts = array(
    'views_form',
45
    $view->storage->id(),
merlinofchaos's avatar
merlinofchaos committed
46 47 48 49 50 51
    $view->current_display,
  );

  return implode('_', $parts);
}

52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
/**
 * Implements hook_element_info().
 */
function views_element_info() {
  $types['view'] = array(
    '#theme_wrappers' => array('container'),
    '#pre_render' => array('views_pre_render_view_element'),
    '#name' => NULL,
    '#display_id' => 'default',
    '#arguments' => array(),
  );
  return $types;
}

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

  $view = views_get_view($element['#name']);
  if ($view && $view->access($element['#display_id'])) {
74
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
75 76 77 78 79
  }

  return $element;
}

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

  // Some quasi clever array merging here.
  $base = array(
91
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
92 93 94 95 96
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
97
    'template' => 'views-mini-pager',
merlinofchaos's avatar
merlinofchaos committed
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  );

  $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),
120
    'template' => 'views-view-grouping',
merlinofchaos's avatar
merlinofchaos committed
121 122
  );

123
  $plugins = views_get_plugin_definitions();
124
  $module_handler = \Drupal::moduleHandler();
merlinofchaos's avatar
merlinofchaos committed
125

126 127 128 129
  // 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
130
  foreach ($plugins as $type => $info) {
131
    foreach ($info as $def) {
132 133 134 135 136
      // 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;
      }
137 138 139 140
      // 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?
141
      if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
142 143
        continue;
      }
merlinofchaos's avatar
merlinofchaos committed
144

145 146 147
      $hooks[$def['theme']] = array(
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
148

149 150
      // For the views module we ensure views.theme.inc is included.
      if ($def['provider'] == 'views') {
151 152
        $def['theme_file'] = 'views.theme.inc';
      }
153 154
      // We always use the module directory as base dir.
      $module_dir = drupal_get_path('module', $def['provider']);
merlinofchaos's avatar
merlinofchaos committed
155

156
      // The theme_file definition is always relative to the modules directory.
157
      if (isset($def['theme_file'])) {
158
        $hooks[$def['theme']]['path'] = $module_dir;
159 160
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
161 162 163 164
      // 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'];
165 166
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
167 168
        }
      }
169 170 171 172 173 174
     // 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.
175
      if (!function_exists('theme_' . $def['theme'])) {
176 177
        $hooks[$def['theme']]['path'] = $module_dir;
        $hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
178
      }
merlinofchaos's avatar
merlinofchaos committed
179 180 181 182 183 184 185 186 187 188 189 190 191 192
    }
  }

  $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),
193
    'template' => 'views-more',
merlinofchaos's avatar
merlinofchaos committed
194 195 196 197 198
  );

  return $hooks;
}

199 200 201 202 203 204 205 206 207 208 209 210 211
/**
 * 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.
 */
function views_plugin_list() {
212
  $plugin_data = views_get_plugin_definitions();
213 214
  $plugins = array();
  foreach (views_get_enabled_views() as $view) {
215
    foreach ($view->get('display') as $display) {
216
      foreach ($plugin_data as $type => $info) {
217 218
        if ($type == 'display' && isset($display['display_plugin'])) {
          $name = $display['display_plugin'];
219
        }
220 221
        elseif (isset($display['display_options']["{$type}_plugin"])) {
          $name = $display['display_options']["{$type}_plugin"];
222
        }
223 224
        elseif (isset($display['display_options'][$type]['type'])) {
          $name = $display['display_options'][$type]['type'];
225 226 227 228 229 230 231 232 233 234 235 236
        }
        else {
          continue;
        }

        // Key first by the plugin type, then the name.
        $key = $type . ':' . $name;
        // Add info for this plugin.
        if (!isset($plugins[$key])) {
          $plugins[$key] = array(
            'type' => $type,
            'title' => check_plain($info[$name]['title']),
237
            'provider' => check_plain($info[$name]['provider']),
238 239 240 241 242
            'views' => array(),
          );
        }

        // Add this view to the list for this plugin.
243
        $plugins[$key]['views'][$view->id()] = $view->id();
244 245 246 247 248 249
      }
    }
  }
  return $plugins;
}

merlinofchaos's avatar
merlinofchaos committed
250 251 252 253 254 255 256 257
/**
 * 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.
 */
258
function views_preprocess_node(&$variables) {
259
  \Drupal::moduleHandler()->loadInclude('node', 'views.inc');
260 261
  // The 'view' attribute of the node is added in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
262 263 264 265 266
  if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
    $variables['view'] = $variables['node']->view;
    $variables['theme_hook_suggestions'][] = 'node__view__' . $variables['node']->view->storage->id();
    if (!empty($variables['node']->view->current_display)) {
      $variables['theme_hook_suggestions'][] = 'node__view__' . $variables['node']->view->storage->id() . '__' . $variables['node']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
267 268 269

      // 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:
270 271
      if ($variables['page'] && $variables['view_mode'] == 'full' && !$variables['view']->display_handler->hasPath()) {
        $variables['page'] = FALSE;
merlinofchaos's avatar
merlinofchaos committed
272 273 274 275 276
      }
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
277 278
  if (!empty($variables['view']->rowPlugin) && $variables['view']->rowPlugin->getPluginId() == 'entity:node') {
    node_row_node_view_preprocess_node($variables);
merlinofchaos's avatar
merlinofchaos committed
279 280 281 282 283 284 285
  }
}

/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
286
function views_preprocess_comment(&$variables) {
287 288
  // The view data is added to the comment in
  // \Drupal\views\Plugin\views\row\EntityRow::preRender().
289 290 291 292 293
  if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
    $variables['view'] = &$variables['comment']->view;
    $variables['theme_hook_suggestions'][] = 'comment__view__' . $variables['comment']->view->storage->id();
    if (!empty($variables['node']->view->current_display)) {
      $variables['theme_hook_suggestions'][] = 'comment__view__' . $variables['comment']->view->storage->id() . '__' . $variables['comment']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
294 295 296 297 298
    }
  }
}

/**
299
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
300 301 302 303 304 305
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
306
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
307 308 309 310 311 312 313 314 315 316 317 318
    ),
  );
}

/**
 * Implement hook_menu().
 */
function views_menu() {
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'theme callback' => 'ajax_base_page_theme',
319
    'route_name' => 'views.ajax',
merlinofchaos's avatar
merlinofchaos committed
320 321 322 323 324 325 326 327 328 329
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
330
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
331 332
  foreach ($views as $data) {
    list($view, $display_id) = $data;
333
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
    if (is_array($result)) {
      // The menu system doesn't support having two otherwise
      // identical paths with different placeholders.  So we
      // want to remove the existing items from the menu whose
      // paths would conflict with ours.

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

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

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

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

  if ($view = views_get_view($name)) {
396 397
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
398 399 400 401

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

    $indexes = array();
402
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
403 404 405 406 407 408 409 410 411

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

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
412
        $arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
merlinofchaos's avatar
merlinofchaos committed
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
        $view->destroy();

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

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

  // Load the view and render it.
  if ($view = views_get_view($name)) {
443 444 445 446 447 448
    if ($output = $view->executeDisplay($display_id, $args)) {
      return $output;
    }
    else {
      return array();
    }
merlinofchaos's avatar
merlinofchaos committed
449 450
  }

451
  // Fallback if we get here no view was found.
merlinofchaos's avatar
merlinofchaos committed
452 453 454 455 456 457 458 459 460 461
  return MENU_NOT_FOUND;
}

/**
 * Implements hook_page_alter().
 */
function views_page_alter(&$page) {
  // If the main content of this page contains a view, attach its contextual
  // links to the overall page array. This allows them to be rendered directly
  // next to the page title.
462
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
463 464 465 466 467 468 469 470
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
471 472 473 474 475
  // Early-return to prevent adding unnecessary JavaScript.
  if (!user_access('access contextual links')) {
    return;
  }

merlinofchaos's avatar
merlinofchaos committed
476 477 478 479 480 481 482 483 484 485
  // 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
  // page.tpl.php, so we can only find it using JavaScript. We therefore remove
486
  // the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
487
  // JavaScript that will insert it back in the correct place.
488
  if (!empty($variables['page']['#views_contextual_links'])) {
489
    $key = array_search('contextual-region', $variables['attributes']['class']);
merlinofchaos's avatar
merlinofchaos committed
490
    if ($key !== FALSE) {
491
      unset($variables['attributes']['class'][$key]);
492
      $variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
493
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
    }
  }
}

/**
 * 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
509 510 511
 * '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
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546
 *
 * 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
547 548 549
 *   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
550 551 552 553 554
 * @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.
 *
555
 * @see \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
merlinofchaos's avatar
merlinofchaos committed
556 557 558
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
559
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
560 561
  // Do not do anything if the view is configured to hide its administrative
  // links.
562
  if ($view->getShowAdminLinks()) {
merlinofchaos's avatar
merlinofchaos committed
563 564 565
    // 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.
566
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
567
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
568
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
569
    // avoid displaying any contextual links at all, a display plugin can still
570
    // set 'contextual_links_locations' to, e.g., {""}.)
571 572 573

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
574
    }
575
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
576 577
      $plugin['contextual_links_locations'] = array();
    }
578 579 580 581
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
582
    // On exposed_forms blocks contextual links should always be visible.
583
    $plugin['contextual_links_locations'][] = 'exposed_filter';
584 585
    $has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
    if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
merlinofchaos's avatar
merlinofchaos committed
586 587 588 589 590 591
      foreach ($plugin['contextual links'] as $module => $link) {
        $args = array();
        $valid = TRUE;
        if (!empty($link['argument properties'])) {
          foreach ($link['argument properties'] as $property) {
            // If the plugin is trying to create an invalid contextual link
592 593 594 595
            // (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
596 597 598 599
              $valid = FALSE;
              break;
            }
            else {
600
              $args[] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
601 602 603 604 605 606
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
607 608 609 610 611 612 613 614 615
          $render_element['#views_contextual_links'] = TRUE;
          $render_element['#contextual_links'][$module] = array(
            $link['parent path'],
            $args,
            array(
              'location' => $location,
              'name' => $view->storage->id(),
              'display_id' => $display_id,
            )
merlinofchaos's avatar
merlinofchaos committed
616 617 618 619 620 621 622 623
          );
        }
      }
    }
  }
}

/**
624
 * Prepares a list of language names.
merlinofchaos's avatar
merlinofchaos committed
625
 *
626
 * This is a wrapper around language_list to return a plain key value array.
merlinofchaos's avatar
merlinofchaos committed
627
 *
628 629 630 631 632
 * @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.
633 634
 *   It can be: Language::STATE_CONFIGURABLE, Language::STATE_LOCKED,
 *   Language::STATE_ALL.
635 636 637
 *
 * @return array
 *   An array of language names (or $field) keyed by the langcode.
merlinofchaos's avatar
merlinofchaos committed
638 639 640
 *
 * @see locale_language_list()
 */
641
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
642
  $languages = language_list($flags);
merlinofchaos's avatar
merlinofchaos committed
643 644
  $list = array();
  foreach ($languages as $language) {
645
    $list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
merlinofchaos's avatar
merlinofchaos committed
646 647 648 649 650
  }
  return $list;
}

/**
651
 * Implements hook_ENTITY_TYPE_create() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
652
 */
653
function views_field_instance_create(FieldInstanceInterface $field_instance) {
654 655
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
656
}
657

merlinofchaos's avatar
merlinofchaos committed
658
/**
659
 * Implements hook_ENTITY_TYPE_update() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
660
 */
661
function views_field_instance_update(FieldInstanceInterface $field_instance) {
662 663
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
664 665 666
}

/**
667
 * Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
merlinofchaos's avatar
merlinofchaos committed
668
 */
669
function views_field_instance_delete(FieldInstanceInterface $field_instance) {
670 671
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
672 673 674 675 676 677
}

/**
 * Invalidate the views cache, forcing a rebuild on the next grab of table data.
 */
function views_invalidate_cache() {
678
  // Clear the views cache.
679
  cache('views_info')->deleteAll();
680 681

  // Clear the page and block cache.
682
  Cache::deleteTags(array('content' => TRUE));
683 684

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

687
  $module_handler = \Drupal::moduleHandler();
688

689 690 691 692
  // Set the router to be rebuild.
  // @todo Figure out why the cache rebuild is trigged but the route table
  //   does not exist yet.
  if (db_table_exists('router')) {
693
    \Drupal::service('router.builder')->rebuild();
694 695
  }

696
  // Invalidate the block cache to update views block derivatives.
697
  if ($module_handler->moduleExists('block')) {
698
    \Drupal::service('plugin.manager.block')->clearCachedDefinitions();
699 700
  }

701
  // Allow modules to respond to the Views cache being cleared.
702
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718
}

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

/**
719
 * Find out what, if any, page view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
720
 *
721 722 723 724
 * 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
725 726 727 728 729 730 731 732 733 734
 *   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
 *
735
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
736 737 738 739 740 741 742 743 744 745 746
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
747
 * Find out what, if any, current view is currently in use.
merlinofchaos's avatar
merlinofchaos committed
748
 *
749 750 751 752
 * 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
753
 *   The current view object.
merlinofchaos's avatar
merlinofchaos committed
754 755 756 757 758
 */
function &views_get_current_view() {
  return views_set_current_view();
}

759 760 761 762
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
763 764 765 766 767 768 769 770 771
  $hooks = array();

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

772 773 774 775 776 777 778
  // Register a views_plugins alter hook for all plugin types.
  foreach (ViewExecutable::getPluginTypes() as $type) {
    $hooks['views_plugins_' . $type . '_alter'] = array(
      'group' => 'views',
    );
  }

779 780 781 782 783 784 785 786 787 788 789 790
  $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'));
791 792

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
793 794 795
}

/**
796 797 798
 * Implements hook_library_info().
 */
function views_library_info() {
799 800 801
  $path = drupal_get_path('module', 'views');
  $libraries['views.module'] = array(
    'title' => 'Views base',
802
    'version' => \Drupal::VERSION,
803 804 805 806
    'css' => array(
      "$path/css/views.module.css"
    ),
  );
807 808
  $libraries['views.ajax'] = array(
    'title' => 'Views AJAX',
809
    'version' => \Drupal::VERSION,
810
    'js' => array(
811 812
      "$path/js/base.js" => array('group' => JS_DEFAULT),
      "$path/js/ajax_view.js" => array('group' => JS_DEFAULT),
813 814 815 816 817 818 819 820 821 822
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupalSettings'),
      array('system', 'jquery.once'),
      array('system', 'jquery.form'),
      array('system', 'drupal.ajax'),
    ),
  );
823 824
  $libraries['views.contextual-links'] = array(
    'title' => 'Views Contextual links',
825
    'version' => \Drupal::VERSION,
826
    'js' => array(
827
      // Set to -10 to move it before the contextual links javascript file.
828
      "$path/js/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
829 830 831 832 833 834
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );
835 836
  $libraries['views.exposed-form'] = array(
    'title' => 'Views exposed form',
837
    'version' => \Drupal::VERSION,
838 839 840 841
    'css' => array(
      "$path/css/views.exposed_form.css",
    ),
  );
merlinofchaos's avatar
merlinofchaos committed
842

843
  return $libraries;
merlinofchaos's avatar
merlinofchaos committed
844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
}

/**
 * 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'.
 */
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
861
  $definitions = Views::pluginManager($type)->getDefinitions();
862
  $plugins = array();
merlinofchaos's avatar
merlinofchaos committed
863

aspilicious's avatar
aspilicious committed
864
  foreach ($definitions as $id => $plugin) {
865 866
    // Skip plugins that don't conform to our key, if they have one.
    if ($key && isset($plugin['display_types']) && !in_array($key, $plugin['display_types'])) {
867 868
      continue;
    }
869

870
    if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
aspilicious's avatar
aspilicious committed
871
      $plugins[$id] = $plugin['title'];
merlinofchaos's avatar
merlinofchaos committed
872 873 874
    }
  }

875 876 877
  if (!empty($plugins)) {
    asort($plugins);
    return $plugins;
merlinofchaos's avatar
merlinofchaos committed
878
  }
879

880
  return $plugins;
merlinofchaos's avatar
merlinofchaos committed
881 882
}

883
/**
884 885 886
 * Gets all the views plugin definitions.
 *
 * @return array
887
 *   An array of plugin definitions for all types.
888
 */
889 890 891
function views_get_plugin_definitions() {
  $plugins = array();
  foreach (ViewExecutable::getPluginTypes() as $plugin_type) {
892
    $plugins[$plugin_type] = Views::pluginManager($plugin_type)->getDefinitions();
893 894
  }

895
  return $plugins;
896 897
}

898 899 900 901
/**
 * Get enabled display extenders.
 */
function views_get_enabled_display_extenders() {
902
  $enabled = array_filter((array) \Drupal::config('views.settings')->get('display_extenders'));
903

904
  return drupal_map_assoc($enabled);
905 906
}

merlinofchaos's avatar
merlinofchaos committed
907 908 909 910
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
911 912 913 914 915
 * @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
916 917 918 919 920 921 922 923
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
 */
function views_get_applicable_views($type) {
924
  // Get all display plugins which provides the type.
925
  $display_plugins = Views::pluginManager('display')->getDefinitions();
926 927 928 929
  $ids = array();
  foreach ($display_plugins as $id => $definition) {
    if (!empty($definition[$type])) {
      $ids[$id] = $id;
merlinofchaos's avatar
merlinofchaos committed
930
    }
931
  }
merlinofchaos's avatar
merlinofchaos committed
932

933
  $entity_ids = \Drupal::service('entity.query')->get('view')
934
    ->condition('status', TRUE)
935 936
    ->condition("display.*.display_plugin", $ids, 'IN')
    ->execute();
merlinofchaos's avatar
merlinofchaos committed
937

938
  $result = array();
939
  foreach (\Drupal::entityManager()->getStorageController('view')->loadMultiple($entity_ids) as $view) {
940
    // Check each display to see if it meets the criteria and is enabled.
941
    $executable = $view->getExecutable();
942
    $executable->initDisplay();
943 944 945
    foreach ($executable->displayHandlers as $id => $handler) {
      if (!empty($handler->definition[$type]) && $handler->isEnabled()) {
        $result[] = array($executable, $id);
merlinofchaos's avatar
merlinofchaos committed
946 947 948
      }
    }
  }
949

merlinofchaos's avatar
merlinofchaos committed
950 951 952 953
  return $result;
}

/**
954
 * Returns an array of all views as fully loaded $view objects.
merlinofchaos's avatar
merlinofchaos committed
955
 */
956
function views_get_all_views() {
957
  return \Drupal::entityManager()->getStorageController('view')->loadMultiple();
958 959
}

merlinofchaos's avatar
merlinofchaos committed
960 961 962 963
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
 */
function views_get_enabled_views() {
964
  $query = \Drupal::entityQuery('view')
965 966 967 968
    ->condition('status', TRUE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
969 970 971 972 973 974
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
 */
function views_get_disabled_views() {
975
  $query = \Drupal::entityQuery('view')
976 977 978 979
    ->condition('status', FALSE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
980 981 982 983 984 985 986 987 988 989 990 991 992 993
}

/**
 * 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
994
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
995 996 997 998 999
 *  - 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
1000 1001
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
1002 1003 1004 1005 1006
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
 */
1007
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026

  // Filter the big views array.
  switch ($filter) {
    case 'all':
    case 'disabled':
    case 'enabled':
      $func = "views_get_{$filter}_views";
      $views = $func();
      break;
    default:
      return array();
  }

  // Prepare exclude view strings for comparison.
  if (empty($exclude_view)) {
    $exclude_view_name = '';
    $exclude_view_display = '';
  }
  elseif (is_object($exclude_view)) {
1027
    $exclude_view_name = $exclude_view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
1028 1029 1030
    $exclude_view_display = $exclude_view->current_display;
  }
  else {
1031 1032 1033
    // Append a ':' to the $exclude_view string so we always have more than one
    // item to explode.
    list($exclude_view_name, $exclude_view_display) = explode(':', "$exclude_view:");
merlinofchaos's avatar
merlinofchaos committed
1034 1035 1036 1037
  }

  $options = array();
  foreach ($views as $view) {
1038
    $id = $view->id();
merlinofchaos's avatar
merlinofchaos committed
1039
    // Return only views.
1040
    if ($views_only && $id != $exclude_view_name) {
1041
      $options[$id] = $view->label();
merlinofchaos's avatar
merlinofchaos committed
1042 1043 1044
    }
    // Return views with display ids.
    else {
1045
      foreach ($view->get('display') as $display_id => $display) {
1046
        if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
merlinofchaos's avatar
merlinofchaos committed
1047
          if ($optgroup) {
1048
            $options[$id][$id . ':' . $display['id']] = t('@view : @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1049 1050
          }
          else {
1051
            $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1052 1053 1054 1055 1056
          }
        }
      }
    }
  }
1057 1058 1059
  if ($sort) {
    ksort($options);
  }
merlinofchaos's avatar
merlinofchaos committed
1060 1061 1062 1063
  return $options;
}

/**
dawehner's avatar
dawehner committed
1064 1065
 * Returns whether the view is enabled.
 *
1066
 * @param Drupal\views\Entity\View $view
xjm's avatar
xjm committed
1067
 *   The view object to check.
dawehner's avatar
dawehner committed
1068 1069 1070
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1071
 */
1072
function views_view_is_enabled(View $view) {
1073
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
1074 1075 1076
}

/**
dawehner's avatar
dawehner committed
1077 1078
 * Returns whether the view is disabled.
 *
1079
 * @param Drupal\views\Entity\View $view
xjm's avatar
xjm committed
1080
 *   The view object to check.
dawehner's avatar
dawehner committed
1081 1082 1083
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1084
 */
1085
function views_view_is_disabled(View $view) {
1086
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
1087 1088
}

1089
/**
1090
 * Enables and saves a view.
1091
 *
1092
 * @param Drupal\views\Entity\View $view
1093
 *   The View object to disable.
1094
 */
1095
function views_enable_view(View $view) {
1096
  $view->enable()->save();
1097 1098 1099
}

/**
1100
 * Disables and saves a view.
1101
 *
1102
 * @param Drupal\views\Entity\View $view
1103
 *   The View object to disable.
1104
 */
1105
function views_disable_view(View $view) {
1106
  $view->disable()->save();
1107 1108
}

merlinofchaos's avatar
merlinofchaos committed
1109
/**
xjm's avatar
xjm committed
1110
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
1111
 *
xjm's avatar
xjm committed
1112
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
1113
 *   The name of the view.
xjm's avatar
xjm committed
1114
 *
1115
 * @return Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
1116
 *   A reference to the $view object.
1117 1118 1119
 *
 * @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getView().
 *
merlinofchaos's avatar
merlinofchaos committed
1120
 */
1121
function views_get_view($name) {
1122
  return Views::getView($name);
merlinofchaos's avatar
merlinofchaos committed
1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150
}

/**
 * Returns TRUE if the passed-in view contains handlers with views form
 * implementations, FALSE otherwise.
 */
function views_view_has_form_elements($view) {
  foreach ($view->field as $field) {
    if (property_exists($field, 'views_form_callback') || method_exists($field, 'views_form')) {
      return TRUE;
    }
  }
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
    if (method_exists($area, 'views_form') && !$area->views_form_empty($empty)) {
      return TRUE;
    }
  }
  return FALSE;
}

/**
 * This is the entry function. Just gets the form for the current step.
 * The form is always assumed to be multistep, even if it has only one
 * step (the default 'views_form_views_form' step). That way it is actually
 * possible for modules to have a multistep form if they need to.
 */
1151
function views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1152 1153 1154 1155 1156 1157 1158 1159
  $form_state['step'] = isset($form_state['step']) ? $form_state['step'] : 'views_form_views_form';
  // Cache the built form to prevent it from being rebuilt prior to validation
  // and submission, which could lead to data being processed incorrectly,
  // because the views rows (and thus, the form elements as well) have changed
  // in the meantime.
  $form_state['cache'] = TRUE;

  $form = array();
1160
  $query = drupal_get_query_parameters();
1161
  $form['#action'] = url($view->getUrl(), array('query' => $query));
merlinofchaos's avatar
merlinofchaos committed
1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
  // Tell the preprocessor whether it should hide the header, footer, pager...
  $form['show_view_elements'] = array(
    '#type' => 'value',
    '#value' => ($form_state['step'] == 'views_form_views_form') ? TRUE : FALSE,
  );

  $form = $form_state['step']($form, $form_state, $view, $output);
  return $form;
}

/**
 * Callback for the main step of a Views form.
 * Invoked by views_form().
 */
1176
function views_form_views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1177 1178
  $form['#prefix'] = '<div class="views-form">';
  $form['#suffix'] = '</div>';
1179 1180
  $form['#theme'] = 'form';
  $form['#pre_render'][] = 'views_pre_render_views_form_views_form';
merlinofchaos's avatar
merlinofchaos committed
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192
  $form['#validate'][] = 'views_form_views_form_validate';
  $form['#submit'][] = 'views_form_views_form_submit';

  // Add the output markup to the form array so that it's included when the form
  // array is passed to the theme function.
  $form['output'] = array(
    '#markup' => $output,
    // This way any additional form elements will go before the view
    // (below the exposed widgets).
    '#weight' => 50,
  );

1193 1194 1195 1196 1197 1198 1199 1200
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );

merlinofchaos's avatar
merlinofchaos committed
1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268
  $substitutions = array();
  foreach ($view->field as $field_name => $field) {
    $form_element_name = $field_name;
    if (method_exists($field, 'form_element_name')) {
      $form_element_name = $field->form_element_name();
    }
    $method_form_element_row_id_exists = FALSE;
    if (method_exists($field, 'form_element_row_id')) {
      $method_form_element_row_id_exists = TRUE;
    }

    // If the field provides a views form, allow it to modify the $form array.
    $has_form = FALSE;
    if (property_exists($field, 'views_form_callback')) {
      $callback = $field->views_form_callback;
      $callback($view, $field, $form, $form_state);
      $has_form = TRUE;
    }
    elseif (method_exists($field, 'views_form')) {
      $field->views_form($form, $form_state);
      $has_form = TRUE;
    }

    // Build the substitutions array for use in the theme function.
    if ($has_form) {
      foreach ($view->result as $row_id => $row) {
        if ($method_form_element_row_id_exists) {
          $form_element_row_id = $field->form_element_row_id($row_id);
        }
        else {
          $form_element_row_id = $row_id;
        }

        $substitutions[] = array(
          'placeholder' => '<!--form-item-' . $form_element_name . '--' . $form_element_row_id . '-->',
          'field_name' => $form_element_name,
          'row_id' => $form_element_row_id,
        );
      }
    }
  }

  // Give the area handlers a chance to extend the form.
  $area_handlers = array_merge(array_values($view->header), array_values($view->footer));
  $empty = empty($view->result);
  foreach ($area_handlers as $area) {
    if (method_exists($area, 'views_form') && !$area->views_form_empty($empty)) {
      $area->views_form($form, $form_state);
    }
  }

  $form['#substitutions'] = array(
    '#type' => 'value',
    '#value' => $substitutions,
  );

  return $form;
}

/**
 * Validate handler for the first step of the views form.
 * Calls any existing views_form_validate functions located
 * on the views fields.
 */
function views_form_views_form_validate($form, &$form_state) {
  $view = $form_state['build_info']['args'][0];

  // Call the validation method on every field handler that has it.
1269
  foreach ($view->field as $field) {
merlinofchaos's avatar
merlinofchaos committed
1270 1271 1272 1273 1274 1275 1276
    if (method_exists($field, 'views_form_validate')) {
      $field->views_form_validate($form, $form_state);
    }
  }

  // Call the validate method on every area handler that has it.
  foreach (array('header', 'footer') as $area) {
1277
    foreach ($view->{$area} as $area_handler) {
merlinofchaos's avatar
merlinofchaos committed
1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293
      if (method_exists($area_handler, 'views_form_validate')) {
        $area_handler->views_form_validate($form, $form_state);
      }
    }
  }
}

/**
 * Submit handler for the first step of the views form.
 * Calls any existing views_form_submit functions located
 * on the views fields.
 */
function views_form_views_form_submit($form, &$form_state) {
  $view = $form_state['build_info']['args'][0];

  // Call the submit method on every field handler that has it.
1294
  foreach ($view->field as $field) {
merlinofchaos's avatar
merlinofchaos committed
1295 1296 1297 1298 1299 1300 1301
    if (method_exists($field, 'views_form_submit')) {
      $field->views_form_submit($form, $form_state);
    }
  }

  // Call the submit method on every area handler that has it.
  foreach (array('header', 'footer') as $area) {
1302
    foreach ($view->{$area} as $area_handler) {
merlinofchaos's avatar
merlinofchaos committed
1303 1304 1305 1306 1307 1308 1309
      if (method_exists($area_handler, 'views_form_submit')) {
        $area_handler->views_form_submit($form, $form_state);
      }
    }
  }
}

1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
/**
 * 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().
1334
  $substitutions = \Drupal::moduleHandler()->invokeAll('views_form_substitutions');
1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347
  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']);

  // Render and add remaining form fields.
  $element['#children'] = drupal_render_children($element);
  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367
/**
 * Form builder for the exposed widgets form.
 *
 * Be sure that $view and $display are references.
 */
function views_exposed_form($form, &$form_state) {
  // Don't show the form when batch operations are in progress.
  if ($batch = batch_get() && isset($batch['current_set'])) {
    return array(
      // Set the theme callback to be nothing to avoid errors in template_preprocess_views_exposed_form().
      '#theme' => '',
    );
  }

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

1368
  $form_state['input'] = $view->getExposedInput();
merlinofchaos's avatar
merlinofchaos committed
1369 1370 1371 1372

  // Let form plugins know this is for exposed widgets.
  $form_state['exposed'] = TRUE;
  // Check if the form was already created
1373
  if ($cache = views_exposed_form_cache($view->storage->id(), $view->current_display)) {
merlinofchaos's avatar
merlinofchaos committed
1374 1375 1376 1377 1378 1379 1380 1381
    return $cache;
  }

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

  // Go through each handler and let it generate its exposed widget.
  foreach ($view->display_handler->handlers as $type => $value) {
    foreach ($view->$type as $id => $handler) {
1382
      if ($handler->canExpose() && $handler->isExposed()) {
1383 1384 1385 1386 1387
        // Grouped exposed filters have their own forms.
        // Instead of render the standard exposed form, a new Select or
        // Radio form field is rendered with the available groups.
        // When an user choose an option the selected value is split
        // into the operator and value that the item represents.
1388
        if ($handler->isAGroup()) {
1389
          $handler->groupForm($form, $form_state);
1390 1391 1392
          $id = $handler->options['group_info']['identifier'];
        }
        else {
1393
          $handler->buildExposedForm($form, $form_state);
1394
        }
1395
        if ($info = $handler->exposedInfo()) {
merlinofchaos's avatar
merlinofchaos committed
1396 1397 1398 1399 1400 1401
          $form['#info']["$type-$id"] = $info;
        }
      }
    }
  }

1402 1403
  $form['actions'] = array('#type' => 'actions');
  $form['actions']['submit'] = array(
1404 1405
    // Prevent from showing up in $_GET.
    '#name' => '',
merlinofchaos's avatar
merlinofchaos committed
1406 1407
    '#type' => 'submit',
    '#value' => t('Apply'),
1408
    '#id' => drupal_html_id('edit-submit-' . $view->storage->id()),
merlinofchaos's avatar
merlinofchaos committed
1409 1410
  );

1411
  $form['#action'] = url($view->display_handler->getUrl());
1412
  $form['#theme'] = $view->buildThemeFunctions('views_exposed_form');
1413
  $form['#id'] = drupal_clean_css_identifier('views_exposed_form-' . check_plain($view->storage->id()) . '-' . check_plain($display['id']));
merlinofchaos's avatar
merlinofchaos committed
1414 1415 1416
//  $form['#attributes']['class'] = array('views-exposed-form');

  $exposed_form_plugin = $form_state['exposed_form_plugin'];
1417
  $exposed_form_plugin->exposedFormAlter($form, $form_state);
merlinofchaos's avatar
merlinofchaos committed
1418 1419

  // Save the form
1420
  views_exposed_form_cache($view->storage->id(), $view->current_display, $form);
merlinofchaos's avatar
merlinofchaos committed
1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440