views.module 59.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\views\ViewExecutable;
15
use Drupal\Component\Plugin\Exception\PluginException;
16
use Drupal\views\Plugin\Core\Entity\View;
17
use Drupal\views\Views;
18

merlinofchaos's avatar
merlinofchaos committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
/**
 * Implements hook_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',
43
    $view->storage->id(),
merlinofchaos's avatar
merlinofchaos committed
44 45 46 47 48 49
    $view->current_display,
  );

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

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
/**
 * 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'])) {
72
    $element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
73 74 75 76 77
  }

  return $element;
}

merlinofchaos's avatar
merlinofchaos committed
78 79 80 81
/**
 * Implement hook_theme(). Register views theming functions.
 */
function views_theme($existing, $type, $theme, $path) {
82
  Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
merlinofchaos's avatar
merlinofchaos committed
83 84 85

  // Some quasi clever array merging here.
  $base = array(
86
    'file' => 'views.theme.inc',
merlinofchaos's avatar
merlinofchaos committed
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
  );

  // Our extra version of pager from pager.inc
  $hooks['views_mini_pager'] = $base + array(
    'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
    'pattern' => 'views_mini_pager__',
  );

  $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(
    'pattern' => 'views_view_field__',
    'variables' => array('view' => NULL, 'field' => NULL, 'row' => NULL),
  );
  $hooks['views_view_grouping'] = $base + array(
    'pattern' => 'views_view_grouping__',
    'variables' => array('view' => NULL, 'grouping' => NULL, 'grouping_level' => NULL, 'rows' => NULL, 'title' => NULL),
  );

119
  $plugins = views_get_plugin_definitions();
merlinofchaos's avatar
merlinofchaos committed
120 121 122 123

  // Register theme functions for all style plugins
  foreach ($plugins as $type => $info) {
    foreach ($info as $plugin => $def) {
124 125 126 127 128
      // 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;
      }
merlinofchaos's avatar
merlinofchaos committed
129

130 131 132 133
      $hooks[$def['theme']] = array(
        'pattern' => $def['theme'] . '__',
        'variables' => $variables[$type],
      );
merlinofchaos's avatar
merlinofchaos committed
134

135 136 137 138 139
      if ($def['module'] == 'views') {
        $def['theme_file'] = 'views.theme.inc';
      }
      elseif (isset($def['theme_file'])) {
        $def['theme_path'] = drupal_get_path('module', $def['module']);
merlinofchaos's avatar
merlinofchaos committed
140 141
      }

142 143 144 145 146 147 148 149 150 151
      if (isset($def['theme_path'])) {
        $hooks[$def['theme']]['path'] = $def['theme_path'];
      }
      if (isset($def['theme_file'])) {
        $hooks[$def['theme']]['file'] = $def['theme_file'];
      }
      if (isset($def['theme_path']) && isset($def['theme_file'])) {
        $include = DRUPAL_ROOT . '/' . $def['theme_path'] . '/' . $def['theme_file'];
        if (is_file($include)) {
          require_once $include;
merlinofchaos's avatar
merlinofchaos committed
152 153
        }
      }
154 155 156
      if (!function_exists('theme_' . $def['theme'])) {
        $hooks[$def['theme']]['template'] = drupal_clean_css_identifier($def['theme']);
      }
merlinofchaos's avatar
merlinofchaos committed
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    }
  }

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

  $hooks['views_exposed_form'] = $base + array(
    'template' => 'views-exposed-form',
    'pattern' => 'views_exposed_form__',
    'render element' => 'form',
  );

  $hooks['views_more'] = $base + array(
    'template' => 'views-more',
    'pattern' => 'views_more__',
    'variables' => array('more_url' => NULL, 'link_text' => 'more', 'view' => NULL),
  );

  return $hooks;
}

179 180 181 182 183 184 185 186 187 188 189 190 191
/**
 * 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() {
192
  $plugin_data = views_get_plugin_definitions();
193 194
  $plugins = array();
  foreach (views_get_enabled_views() as $view) {
195
    foreach ($view->get('display') as $display_id => $display) {
196
      foreach ($plugin_data as $type => $info) {
197 198
        if ($type == 'display' && isset($display['display_plugin'])) {
          $name = $display['display_plugin'];
199
        }
200 201
        elseif (isset($display['display_options']["{$type}_plugin"])) {
          $name = $display['display_options']["{$type}_plugin"];
202
        }
203 204
        elseif (isset($display['display_options'][$type]['type'])) {
          $name = $display['display_options'][$type]['type'];
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
        }
        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']),
            'module' => check_plain($info[$name]['module']),
            'views' => array(),
          );
        }

        // Add this view to the list for this plugin.
223
        $plugins[$key]['views'][$view->id()] = $view->id();
224 225 226 227 228 229
      }
    }
  }
  return $plugins;
}

merlinofchaos's avatar
merlinofchaos committed
230 231 232 233 234 235 236 237 238 239
/**
 * 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.
 */
function views_preprocess_node(&$vars) {
  // The 'view' attribute of the node is added in views_preprocess_node()
240
  if (!empty($vars['node']->view) && $vars['node']->view->storage->id()) {
merlinofchaos's avatar
merlinofchaos committed
241
    $vars['view'] = $vars['node']->view;
242
    $vars['theme_hook_suggestions'][] = 'node__view__' . $vars['node']->view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
243
    if (!empty($vars['node']->view->current_display)) {
244
      $vars['theme_hook_suggestions'][] = 'node__view__' . $vars['node']->view->storage->id() . '__' . $vars['node']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
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:
248
      if ($vars['page'] && $vars['view_mode'] == 'full' && !$vars['view']->display_handler->hasPath()) {
merlinofchaos's avatar
merlinofchaos committed
249 250 251 252 253 254
        $vars['page'] = FALSE;
      }
    }
  }

  // Allow to alter comments and links based on the settings in the row plugin.
255
  if (!empty($vars['view']->style_plugin->row_plugin) && get_class($vars['view']->style_plugin->row_plugin) == 'views_plugin_row_node_view') {
merlinofchaos's avatar
merlinofchaos committed
256 257 258 259 260 261 262 263 264 265
    node_row_node_view_preprocess_node($vars);
  }
}

/**
 * A theme preprocess function to automatically allow view-based node
 * templates if called from a view.
 */
function views_preprocess_comment(&$vars) {
  // The 'view' attribute of the node is added in template_preprocess_views_view_row_comment()
266
  if (!empty($vars['comment']->view) && $vars['comment']->view->storage->id()) {
267
    $vars['view'] = &$vars['comment']->view;
268
    $vars['theme_hook_suggestions'][] = 'comment__view__' . $vars['comment']->view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
269
    if (!empty($vars['node']->view->current_display)) {
270
      $vars['theme_hook_suggestions'][] = 'comment__view__' . $vars['comment']->view->storage->id() . '__' . $vars['comment']->view->current_display;
merlinofchaos's avatar
merlinofchaos committed
271 272 273 274 275
    }
  }
}

/**
276
 * Implements hook_permission().
merlinofchaos's avatar
merlinofchaos committed
277 278 279 280 281 282
 */
function views_permission() {
  return array(
    'access all views' => array(
      'title' => t('Bypass views access control'),
      'description' => t('Bypass access control when accessing views.'),
283
      'restrict access' => TRUE,
merlinofchaos's avatar
merlinofchaos committed
284 285 286 287 288 289 290 291
    ),
  );
}

/**
 * Implement hook_menu().
 */
function views_menu() {
292
  // Any event which causes a menu rebuild could potentially mean that the
merlinofchaos's avatar
merlinofchaos committed
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307
  // Views data is updated -- module changes, profile changes, etc.
  views_invalidate_cache();
  $items = array();
  $items['views/ajax'] = array(
    'title' => 'Views',
    'page callback' => 'views_ajax',
    'theme callback' => 'ajax_base_page_theme',
    'delivery callback' => 'ajax_deliver',
    'access callback' => TRUE,
    'description' => 'Ajax callback for view loading.',
    'type' => MENU_CALLBACK,
    'file' => 'includes/ajax.inc',
  );
  // Define another taxonomy autocomplete because the default one of drupal
  // does not support a vid a argument anymore
308
  $items['admin/views/ajax/autocomplete/taxonomy/%'] = array(
merlinofchaos's avatar
merlinofchaos committed
309 310 311 312 313 314 315 316 317 318 319 320 321 322 323
    'page callback' => 'views_ajax_autocomplete_taxonomy',
    'theme callback' => 'ajax_base_page_theme',
    'access callback' => 'user_access',
    'access arguments' => array('access content'),
    'type' => MENU_CALLBACK,
    'file' => 'includes/ajax.inc',
  );
  return $items;
}

/**
 * Implement hook_menu_alter().
 */
function views_menu_alter(&$callbacks) {
  $our_paths = array();
324
  $views = views_get_applicable_views('uses_hook_menu');
merlinofchaos's avatar
merlinofchaos committed
325 326
  foreach ($views as $data) {
    list($view, $display_id) = $data;
327
    $result = $view->executeHookMenu($display_id, $callbacks);
merlinofchaos's avatar
merlinofchaos committed
328 329 330 331 332 333 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 396 397 398 399
    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;
        }
        else {
          // This item already exists, so it must be one that we added.
          // We change the various callback arguments to pass an array
          // of possible display IDs instead of a single ID.
          $callbacks[$path]['page arguments'][1] = (array)$callbacks[$path]['page arguments'][1];
          $callbacks[$path]['page arguments'][1][] = $display_id;
          $callbacks[$path]['access arguments'][] = $item['access arguments'][0];
          $callbacks[$path]['load arguments'][1] = (array)$callbacks[$path]['load arguments'][1];
          $callbacks[$path]['load arguments'][1][] = $display_id;
        }
        $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)) {
400 401
    $view->setDisplay($display_id);
    $view->initHandlers();
merlinofchaos's avatar
merlinofchaos committed
402 403 404 405

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

    $indexes = array();
406
    $path = explode('/', $view->getPath());
merlinofchaos's avatar
merlinofchaos committed
407 408 409 410 411 412 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 443 444 445 446

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

    if (isset($indexes[$index])) {
      if (isset($view->argument[$indexes[$index]])) {
        $arg = $view->argument[$indexes[$index]]->validate_argument($value) ? $value : FALSE;
        $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)) {
447
    return $view->executeDisplay($display_id, $args);
merlinofchaos's avatar
merlinofchaos committed
448 449 450 451 452 453 454 455 456 457 458 459 460
  }

  // Fallback; if we get here no view was found or handler was not valid.
  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.
461
  if ($view = views_get_page_view()) {
merlinofchaos's avatar
merlinofchaos committed
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479
    views_add_contextual_links($page, 'page', $view, $view->current_display);
  }
}

/**
 * Implements MODULE_preprocess_HOOK().
 */
function views_preprocess_html(&$variables) {
  // 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
480
  // the "contextual-region" class from the <body> tag here and add
merlinofchaos's avatar
merlinofchaos committed
481 482
  // JavaScript that will insert it back in the correct place.
  if (!empty($variables['page']['#views_contextual_links_info'])) {
483
    $key = array_search('contextual-region', $variables['attributes']['class']->value());
merlinofchaos's avatar
merlinofchaos committed
484
    if ($key !== FALSE) {
485
      unset($variables['attributes']['class'][$key]);
merlinofchaos's avatar
merlinofchaos committed
486 487
      // Add the JavaScript, with a group and weight such that it will run
      // before modules/contextual/contextual.js.
488
      drupal_add_library('views', 'views.contextual-links');
merlinofchaos's avatar
merlinofchaos committed
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515
    }
  }
}

/**
 * Implements hook_contextual_links_view_alter().
 */
function views_contextual_links_view_alter(&$element, $items) {
  // If we are rendering views-related contextual links attached to the overall
  // page array, add a class to the list of contextual links. This will be used
  // by the JavaScript added in views_preprocess_html().
  if (!empty($element['#element']['#views_contextual_links_info']) && !empty($element['#element']['#type']) && $element['#element']['#type'] == 'page') {
    $element['#attributes']['class'][] = 'views-contextual-links-page';
  }
}

/**
 * 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
516 517 518
 * '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
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 547 548 549 550 551 552 553
 *
 * 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
554 555 556
 *   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
557 558 559 560 561 562 563 564 565
 * @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.
 *
 * @see views_block_view()
 * @see views_page_alter()
 * @see template_preprocess_views_view()
 */
566
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
merlinofchaos's avatar
merlinofchaos committed
567 568 569 570 571 572
  // Do not do anything if the view is configured to hide its administrative
  // links.
  if (empty($view->hide_admin_links)) {
    // 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.
573
    $plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
574
    $plugin = Views::pluginManager('display')->getDefinition($plugin_id);
575
    // If contextual_links_locations are not set, provide a sane default. (To
merlinofchaos's avatar
merlinofchaos committed
576
    // avoid displaying any contextual links at all, a display plugin can still
577
    // set 'contextual_links_locations' to, e.g., {""}.)
578 579 580

    if (!isset($plugin['contextual_links_locations'])) {
      $plugin['contextual_links_locations'] = array('view');
581
    }
582
    elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
583 584
      $plugin['contextual_links_locations'] = array();
    }
585 586 587 588
    else {
      $plugin += array('contextual_links_locations' => array('view'));
    }

merlinofchaos's avatar
merlinofchaos committed
589
    // On exposed_forms blocks contextual links should always be visible.
590
    $plugin['contextual_links_locations'][] = 'exposed_filter';
591 592
    $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
593 594 595 596 597 598
      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
599 600 601 602
            // (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
603 604 605 606
              $valid = FALSE;
              break;
            }
            else {
607
              $args[] = $view->storage->{$property};
merlinofchaos's avatar
merlinofchaos committed
608 609 610 611 612 613 614 615 616 617
            }
          }
        }
        // If the link was valid, attach information about it to the renderable
        // array.
        if ($valid) {
          $render_element['#contextual_links'][$module] = array($link['parent path'], $args);
          $render_element['#views_contextual_links_info'][$module] = array(
            'location' => $location,
            'view' => $view,
618
            'view_name' => $view->storage->id(),
merlinofchaos's avatar
merlinofchaos committed
619 620 621 622 623 624 625 626 627
            'view_display_id' => $display_id,
          );
        }
      }
    }
  }
}

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

/**
 * Implements hook_field_create_instance.
 */
function views_field_create_instance($instance) {
657 658
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
659 660 661 662 663 664
}

/**
 * Implements hook_field_update_instance.
 */
function views_field_update_instance($instance, $prior_instance) {
665 666
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
667 668 669 670 671 672
}

/**
 * Implements hook_field_delete_instance.
 */
function views_field_delete_instance($instance) {
673 674
  cache('views_info')->deleteAll();
  cache('views_results')->deleteAll();
merlinofchaos's avatar
merlinofchaos committed
675 676 677 678 679 680
}

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

  // Clear the page and block cache.
685
  Cache::deleteTags(array('content' => TRUE));
686 687

  // Set the menu as needed to be rebuilt.
688
  state()->set('menu_rebuild_needed', TRUE);
689

690 691
  $module_handler = Drupal::moduleHandler();

692
  // Invalidate the block cache to update views block derivatives.
693 694
  if ($module_handler->moduleExists('block')) {
    Drupal::service('plugin.manager.block')->clearCachedDefinitions();
695 696
  }

697
  // Allow modules to respond to the Views cache being cleared.
698
  $module_handler->invokeAll('views_invalidate_cache');
merlinofchaos's avatar
merlinofchaos committed
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
}

/**
 * Determine if the logged in user has access to a view.
 *
 * This function should only be called from a menu hook or some other
 * embedded source. Each argument is the result of a call to
 * views_plugin_access::get_access_callback() which is then used
 * to determine if that display is accessible. If *any* argument
 * is accessible, then the view is accessible.
 */
function views_access() {
  $args = func_get_args();
  foreach ($args as $arg) {
    if ($arg === TRUE) {
      return TRUE;
    }

    if (!is_array($arg)) {
      continue;
    }

    list($callback, $arguments) = $arg;
    $arguments = $arguments ? $arguments : array();
    // Bring dynamic arguments to the access callback.
    foreach ($arguments as $key => $value) {
      if (is_int($value) && isset($args[$value])) {
        $arguments[$key] = $args[$value];
      }
    }
    if (function_exists($callback) && call_user_func_array($callback, $arguments)) {
      return TRUE;
    }
  }

  return FALSE;
}

/**
 * Access callback for the views_plugin_access_perm access plugin.
 *
 * Determine if the specified user has access to a view on the basis of
 * permissions. If the $account argument is omitted, the current user
 * is used.
 */
function views_check_perm($perm, $account = NULL) {
  return user_access($perm, $account) || user_access('access all views', $account);
}

/**
 * Access callback for the views_plugin_access_role access plugin.

 * Determine if the specified user has access to a view on the basis of any of
 * the requested roles. If the $account argument is omitted, the current user
 * is used.
 */
function views_check_roles($rids, $account = NULL) {
  global $user;
  $account = isset($account) ? $account : $user;
  $roles = array_keys($account->roles);
  $roles[] = $account->uid ? DRUPAL_AUTHENTICATED_RID : DRUPAL_ANONYMOUS_RID;
  return user_access('access all views', $account) || array_intersect(array_filter($rids), $roles);
}

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

/**
 * Find out what, if any, page view is currently in use. Please note that
 * this returns a reference, so be careful! You can unintentionally modify the
 * $view object.
 *
781
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
782 783 784 785 786 787 788 789 790 791
 *   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
 *
792
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807
 */
function &views_set_current_view($view = NULL) {
  static $cache = NULL;
  if (isset($view)) {
    $cache = $view;
  }

  return $cache;
}

/**
 * Find out what, if any, current view is currently in use. Please note that
 * this returns a reference, so be careful! You can unintentionally modify the
 * $view object.
 *
808
 * @return Drupal\views\ViewExecutable
merlinofchaos's avatar
merlinofchaos committed
809 810 811 812 813
 */
function &views_get_current_view() {
  return views_set_current_view();
}

814 815 816 817 818 819 820
/**
 * Implements hook_hook_info().
 */
function views_hook_info() {
  $hooks['views_data'] = array(
    'group' => 'views',
  );
821 822 823
  $hooks['views_data_alter'] = array(
    'group' => 'views',
  );
824 825 826
  $hooks['views_query_substitutions'] = array(
    'group' => 'views',
  );
827 828 829
  $hooks['views_form_substitutions'] = array(
    'group' => 'views',
  );
830 831 832
  $hooks['views_analyze'] = array(
    'group' => 'views',
  );
833 834 835
  $hooks['views_data_alter'] = array(
    'group' => 'views',
  );
836 837

  return $hooks;
merlinofchaos's avatar
merlinofchaos committed
838 839 840
}

/**
841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860
 * Implements hook_library_info().
 */
function views_library_info() {
  $path = drupal_get_path('module', 'views') . '/js';
  $libraries['views.ajax'] = array(
    'title' => 'Views AJAX',
    'version' => VERSION,
    'js' => array(
      "$path/base.js" => array('group' => JS_DEFAULT),
      "$path/ajax_view.js" => array('group' => JS_DEFAULT),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
      array('system', 'drupalSettings'),
      array('system', 'jquery.once'),
      array('system', 'jquery.form'),
      array('system', 'drupal.ajax'),
    ),
  );
861 862 863 864 865 866 867 868 869 870 871
  $libraries['views.contextual-links'] = array(
    'title' => 'Views Contextual links',
    'version' => VERSION,
    'js' => array(
      "$path/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
    ),
    'dependencies' => array(
      array('system', 'jquery'),
      array('system', 'drupal'),
    ),
  );
merlinofchaos's avatar
merlinofchaos committed
872

873
  return $libraries;
merlinofchaos's avatar
merlinofchaos committed
874 875 876 877 878 879 880 881 882
}

/**
 * Fetch a handler from the data cache.
 *
 * @param $table
 *   The name of the table this handler is from.
 * @param $field
 *   The name of the field this handler is from.
883
 * @param $type
merlinofchaos's avatar
merlinofchaos committed
884 885 886 887 888 889 890 891 892
 *   The type of handler. i.e, sort, field, argument, filter, relationship
 * @param $override
 *   Override the actual handler object with this class. Used for
 *   aggregation when the handler is redirected to the aggregation
 *   handler.
 *
 * @return views_handler
 *   An instance of a handler object. May be views_handler_broken.
 */
893
function views_get_handler($table, $field, $type, $override = NULL) {
894
  // Get the plugin manager for this type.
895 896
  $manager = Views::pluginManager($type);;
  $data = Views::viewsData()->get($table);
merlinofchaos's avatar
merlinofchaos committed
897

898
  if (isset($data[$field][$type])) {
899
    $definition = $data[$field][$type];
900
    foreach (array('group', 'title', 'title short', 'help', 'real field', 'real table') as $key) {
901 902 903 904 905 906 907 908 909 910 911 912 913
      if (!isset($definition[$key])) {
        // First check the field level
        if (!empty($data[$field][$key])) {
          $definition[$key] = $data[$field][$key];
        }
        // Then if that doesn't work, check the table level
        elseif (!empty($data['table'][$key])) {
          $definition[$key] = $data['table'][$key];
        }
      }
    }

    // @todo This is crazy. Find a way to remove the override functionality.
914
    $plugin_id = $override ?: $definition['id'];
915
    // Try to use the overridden handler.
916
    try {
917
      return $manager->createInstance($plugin_id, $definition);
918 919
    }
    catch (PluginException $e) {
920 921 922 923 924 925 926
      // If that fails, use the original handler.
      try {
        return $manager->createInstance($definition['id'], $definition);
      }
      catch (PluginException $e) {
        // Deliberately empty, this case is handled generically below.
      }
927
    }
merlinofchaos's avatar
merlinofchaos committed
928 929
  }

930 931
  // Finally, use the 'broken' handler.
  debug(t("Missing handler: @table @field @type", array('@table' => $table, '@field' => $field, '@type' => $type)));
932
  return $manager->createInstance('broken');
merlinofchaos's avatar
merlinofchaos committed
933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949
}

/**
 * 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()) {
950
  $definitions = Views::pluginManager($type)->getDefinitions();
951
  $plugins = array();
merlinofchaos's avatar
merlinofchaos committed
952

aspilicious's avatar
aspilicious committed
953
  foreach ($definitions as $id => $plugin) {
954 955 956 957
    // Skip plugins that don't conform to our key.
    if ($key && (empty($plugin['type']) || $plugin['type'] != $key)) {
      continue;
    }
958 959
    // @todo While Views is providing on behalf of core modules, check to see
    //   if they are enabled or not.
960
    if (isset($plugin['module']) && !\Drupal::moduleHandler()->moduleExists($plugin['module'])) {
961 962
      continue;
    }
963

964
    if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
aspilicious's avatar
aspilicious committed
965
      $plugins[$id] = $plugin['title'];
merlinofchaos's avatar
merlinofchaos committed
966 967 968
    }
  }

969 970 971
  if (!empty($plugins)) {
    asort($plugins);
    return $plugins;
merlinofchaos's avatar
merlinofchaos committed
972
  }
973

merlinofchaos's avatar
merlinofchaos committed
974 975 976 977
  // fall-through
  return array();
}

978
/**
979 980 981
 * Gets all the views plugin definitions.
 *
 * @return array
982
 *   An array of plugin definitions for all types.
983
 */
984 985 986
function views_get_plugin_definitions() {
  $plugins = array();
  foreach (ViewExecutable::getPluginTypes() as $plugin_type) {
987
    $plugins[$plugin_type] = Views::pluginManager($plugin_type)->getDefinitions();
988 989
  }

990
  return $plugins;
991 992
}

993 994 995 996
/**
 * Get enabled display extenders.
 */
function views_get_enabled_display_extenders() {
997
  $enabled = array_filter((array) config('views.settings')->get('display_extenders'));
998

999
  return drupal_map_assoc($enabled);
1000 1001
}

merlinofchaos's avatar
merlinofchaos committed
1002 1003 1004 1005
/**
 * Return a list of all views and display IDs that have a particular
 * setting in their display's plugin settings.
 *
1006 1007 1008 1009 1010
 * @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
1011 1012 1013 1014 1015 1016 1017 1018
 * @code
 * array(
 *   array($view, $display_id),
 *   array($view, $display_id),
 * );
 * @endcode
 */
function views_get_applicable_views($type) {
1019
  // Get all display plugins which provides the type.
1020
  $display_plugins = Views::pluginManager('display')->getDefinitions();
1021 1022 1023 1024
  $ids = array();
  foreach ($display_plugins as $id => $definition) {
    if (!empty($definition[$type])) {
      $ids[$id] = $id;
merlinofchaos's avatar
merlinofchaos committed
1025
    }
1026
  }
merlinofchaos's avatar
merlinofchaos committed
1027

1028
  $entity_ids = Drupal::service('entity.query')->get('view')
1029
    ->condition('status', TRUE)
1030 1031
    ->condition("display.*.display_plugin", $ids, 'IN')
    ->execute();
merlinofchaos's avatar
merlinofchaos committed
1032

1033
  $result = array();
1034
  foreach (Drupal::service('plugin.manager.entity')->getStorageController('view')->load($entity_ids) as $view) {
1035 1036
    // Check each display to see if it meets the criteria and is enabled.
    $executable = $view->get('executable');
1037
    $executable->initDisplay();
1038 1039 1040
    foreach ($executable->displayHandlers as $id => $handler) {
      if (!empty($handler->definition[$type]) && $handler->isEnabled()) {
        $result[] = array($executable, $id);
merlinofchaos's avatar
merlinofchaos committed
1041 1042 1043
      }
    }
  }
1044

merlinofchaos's avatar
merlinofchaos committed
1045 1046 1047 1048
  return $result;
}

/**
1049
 * Returns an array of all views as fully loaded $view objects.
merlinofchaos's avatar
merlinofchaos committed
1050
 */
1051
function views_get_all_views() {
1052
  return drupal_container()->get('plugin.manager.entity')->getStorageController('view')->load();
1053 1054
}

merlinofchaos's avatar
merlinofchaos committed
1055 1056 1057 1058
/**
 * Returns an array of all enabled views, as fully loaded $view objects.
 */
function views_get_enabled_views() {
1059 1060 1061 1062 1063
  $query = drupal_container()->get('entity.query')->get('view')
    ->condition('status', TRUE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
1064 1065 1066 1067 1068 1069
}

/**
 * Returns an array of all disabled views, as fully loaded $view objects.
 */
function views_get_disabled_views() {
1070 1071 1072 1073 1074
  $query = drupal_container()->get('entity.query')->get('view')
    ->condition('status', FALSE)
    ->execute();

  return entity_load_multiple('view', $query);
merlinofchaos's avatar
merlinofchaos committed
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
}

/**
 * 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
1089
 *  - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
merlinofchaos's avatar
merlinofchaos committed
1090 1091 1092 1093 1094
 *  - 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
1095 1096
 * @param bool $sort
 *  If TRUE, the list of views is sorted ascending.
merlinofchaos's avatar
merlinofchaos committed
1097 1098 1099 1100 1101
 *
 * @return array
 *  an associative array for use in select.
 *  - key: view name and display id separated by ':', or the view name only
 */
1102
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
merlinofchaos's avatar
merlinofchaos committed
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121

  // 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)) {
1122
    $exclude_view_name = $exclude_view->storage->id();
merlinofchaos's avatar
merlinofchaos committed
1123 1124 1125
    $exclude_view_display = $exclude_view->current_display;
  }
  else {
1126 1127 1128
    // 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
1129 1130 1131 1132
  }

  $options = array();
  foreach ($views as $view) {
1133
    $id = $view->id();
merlinofchaos's avatar
merlinofchaos committed
1134
    // Return only views.
1135
    if ($views_only && $id != $exclude_view_name) {
1136
      $options[$id] = $view->label();
merlinofchaos's avatar
merlinofchaos committed
1137 1138 1139
    }
    // Return views with display ids.
    else {
1140
      foreach ($view->get('display') as $display_id => $display) {
1141
        if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
merlinofchaos's avatar
merlinofchaos committed
1142
          if ($optgroup) {
1143
            $options[$id][$id . ':' . $display['id']] = t('@view : @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1144 1145
          }
          else {
1146
            $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', array('@view' => $id, '@display' => $display['id']));
merlinofchaos's avatar
merlinofchaos committed
1147 1148 1149 1150 1151
          }
        }
      }
    }
  }
1152 1153 1154
  if ($sort) {
    ksort($options);
  }
merlinofchaos's avatar
merlinofchaos committed
1155 1156 1157 1158
  return $options;
}

/**
dawehner's avatar
dawehner committed
1159 1160
 * Returns whether the view is enabled.
 *
1161
 * @param Drupal\views\Plugin\Core\Entity\View $view
xjm's avatar
xjm committed
1162
 *   The view object to check.
dawehner's avatar
dawehner committed
1163 1164 1165
 *
 * @return bool
 *   Returns TRUE if a view is enabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1166
 */
1167
function views_view_is_enabled(View $view) {
1168
  return $view->status();
merlinofchaos's avatar
merlinofchaos committed
1169 1170 1171
}

/**
dawehner's avatar
dawehner committed
1172 1173
 * Returns whether the view is disabled.
 *
1174
 * @param Drupal\views\Plugin\Core\Entity\View $view
xjm's avatar
xjm committed
1175
 *   The view object to check.
dawehner's avatar
dawehner committed
1176 1177 1178
 *
 * @return bool
 *   Returns TRUE if a view is disabled, FALSE otherwise.
merlinofchaos's avatar
merlinofchaos committed
1179
 */
1180
function views_view_is_disabled(View $view) {
1181
  return !$view->status();
merlinofchaos's avatar
merlinofchaos committed
1182 1183
}

1184
/**
1185
 * Enables and saves a view.
1186
 *
1187 1188
 * @param Drupal\views\Plugin\Core\Entity\View $view
 *   The View object to disable.
1189
 */
1190
function views_enable_view(View $view) {
1191
  $view->enable()->save();
1192 1193 1194
}

/**
1195
 * Disables and saves a view.
1196
 *
1197 1198
 * @param Drupal\views\Plugin\Core\Entity\View $view
 *   The View object to disable.
1199
 */
1200
function views_disable_view(View $view) {
1201
  $view->disable()->save();
1202 1203
}

merlinofchaos's avatar
merlinofchaos committed
1204
/**
xjm's avatar
xjm committed
1205
 * Loads a view from configuration.
merlinofchaos's avatar
merlinofchaos committed
1206
 *
xjm's avatar
xjm committed
1207
 * @param string $name
merlinofchaos's avatar
merlinofchaos committed
1208
 *   The name of the view.
xjm's avatar
xjm committed
1209
 *
1210
 * @return Drupal\views\ViewExecutable
dawehner's avatar
dawehner committed
1211
 *   A reference to the $view object.
merlinofchaos's avatar
merlinofchaos committed
1212
 */
1213 1214
function views_get_view($name) {
  $view = entity_load('view', $name);
merlinofchaos's avatar
merlinofchaos committed
1215
  if ($view) {
1216
    return $view->get('executable');
merlinofchaos's avatar
merlinofchaos committed
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
  }
}

/**
 * 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.
 */
1246
function views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1247 1248 1249 1250 1251 1252 1253 1254
  $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();
1255
  $query = drupal_get_query_parameters();
1256
  $form['#action'] = url($view->getUrl(), array('query' => $query));
merlinofchaos's avatar
merlinofchaos committed
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270
  // 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().
 */
1271
function views_form_views_form($form, &$form_state, ViewExecutable $view, $output) {
merlinofchaos's avatar
merlinofchaos committed
1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287
  $form['#prefix'] = '<div class="views-form">';
  $form['#suffix'] = '</div>';
  $form['#theme'] = 'views_form_views_form';
  $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(
    '#type' => 'markup',
    '#markup' => $output,
    // This way any additional form elements will go before the view
    // (below the exposed widgets).
    '#weight' => 50,
  );

1288 1289 1290 1291 1292 1293 1294 1295
  $form['actions'] = array(
    '#type' => 'actions',
  );
  $form['actions']['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );

merlinofchaos's avatar
merlinofchaos committed
1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
  $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];