Newer
Older
<?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.
*/
use Drupal\Core\Cache\Cache;
Tim Plunkett
committed
use Drupal\Core\Database\Query\AlterableInterface;
use Drupal\Core\Language\Language;
Daniel Wehner
committed
use Drupal\views\ViewExecutable;
Tim Plunkett
committed
use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\views\Entity\View;
Dries Buytaert
committed
use Drupal\views\Views;
use Drupal\field\FieldInstanceInterface;
Tim Plunkett
committed
/**
* 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'])) {
Angie Byron
committed
$element['view'] = $view->preview($element['#display_id'], $element['#arguments']);
}
return $element;
}
* Implements hook_theme().
*
* Register views theming functions and those that are defined via views plugin
* definitions.
*/
function views_theme($existing, $type, $theme, $path) {
\Drupal::moduleHandler()->loadInclude('views', 'inc', 'views.theme');
// Some quasi clever array merging here.
$base = array(
webchick
committed
'file' => 'views.theme.inc',
);
// Our extra version of pager from pager.inc
$hooks['views_mini_pager'] = $base + array(
'variables' => array('tags' => array(), 'quantity' => 10, 'element' => 0, 'parameters' => array()),
Alex Pott
committed
'template' => '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(
'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),
'template' => 'views-view-grouping',
Bram Goffings
committed
$plugins = views_get_plugin_definitions();
$module_handler = \Drupal::moduleHandler();
// 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.
Angie Byron
committed
foreach ($info as $def) {
webchick
committed
// 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;
}
// 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?
if (!isset($def['provider']) || !$module_handler->moduleExists($def['provider'])) {
continue;
}
webchick
committed
$hooks[$def['theme']] = array(
'variables' => $variables[$type],
);
// For the views module we ensure views.theme.inc is included.
if ($def['provider'] == 'views') {
webchick
committed
$def['theme_file'] = 'views.theme.inc';
}
// We always use the module directory as base dir.
$module_dir = drupal_get_path('module', $def['provider']);
// The theme_file definition is always relative to the modules directory.
webchick
committed
if (isset($def['theme_file'])) {
$hooks[$def['theme']]['path'] = $module_dir;
webchick
committed
$hooks[$def['theme']]['file'] = $def['theme_file'];
}
// 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'];
webchick
committed
if (is_file($include)) {
require_once $include;
// 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.
webchick
committed
if (!function_exists('theme_' . $def['theme'])) {
$hooks[$def['theme']]['path'] = $module_dir;
$hooks[$def['theme']]['template'] = 'templates/' . drupal_clean_css_identifier($def['theme']);
webchick
committed
}
}
}
$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),
'template' => 'views-more',
);
return $hooks;
}
/**
* A theme preprocess function to automatically allow view-based node
* templates if called from a view.
*
* The 'modules/node.views.inc' file is a better place for this, but
* we haven't got a chance to load that file before Drupal builds the
* node portion of the theme registry.
*/
catch
committed
function views_preprocess_node(&$variables) {
\Drupal::moduleHandler()->loadInclude('node', 'views.inc');
Jennifer Hodgdon
committed
// The 'view' attribute of the node is added in
// \Drupal\views\Plugin\views\row\EntityRow::preRender().
catch
committed
if (!empty($variables['node']->view) && $variables['node']->view->storage->id()) {
$variables['view'] = $variables['node']->view;
// If a node is being rendered in a view, and the view does not have a path,
// prevent drupal from accidentally setting the $page variable:
if (!empty($variables['view']->current_display)
&& $variables['page']
&& $variables['view_mode'] == 'full'
&& !$variables['view']->display_handler->hasPath()) {
$variables['page'] = FALSE;
}
}
// Allow to alter comments and links based on the settings in the row plugin.
catch
committed
if (!empty($variables['view']->rowPlugin) && $variables['view']->rowPlugin->getPluginId() == 'entity:node') {
node_row_node_view_preprocess_node($variables);
/**
* Implements hook_theme_suggestions_HOOK_alter().
*/
function views_theme_suggestions_node_alter(array &$suggestions, array $variables) {
$node = $variables['elements']['#node'];
if (!empty($node->view) && $node->view->storage->id()) {
$suggestions[] = 'node__view__' . $node->view->storage->id();
if (!empty($node->view->current_display)) {
$suggestions[] = 'node__view__' . $node->view->storage->id() . '__' . $node->view->current_display;
}
}
}
/**
* A theme preprocess function to automatically allow view-based node
* templates if called from a view.
*/
catch
committed
function views_preprocess_comment(&$variables) {
Jennifer Hodgdon
committed
// The view data is added to the comment in
// \Drupal\views\Plugin\views\row\EntityRow::preRender().
catch
committed
if (!empty($variables['comment']->view) && $variables['comment']->view->storage->id()) {
$variables['view'] = $variables['comment']->view;
}
}
/**
* Implements hook_theme_suggestions_HOOK_alter().
*/
function views_theme_suggestions_comment_alter(array &$suggestions, array $variables) {
$comment = $variables['elements']['#comment'];
if (!empty($comment->view) && $comment->view->storage->id()) {
$suggestions[] = 'comment__view__' . $comment->view->storage->id();
if (!empty($comment->view->current_display)) {
$suggestions[] = 'comment__view__' . $comment->view->storage->id() . '__' . $comment->view->current_display;
* Implements hook_permission().
*/
function views_permission() {
return array(
'access all views' => array(
'title' => t('Bypass views access control'),
'description' => t('Bypass access control when accessing views.'),
'restrict access' => TRUE,
/**
* Implement hook_menu().
*/
function views_menu() {
$items = array();
$items['views/ajax'] = array(
'title' => 'Views',
'theme callback' => 'ajax_base_page_theme',
'route_name' => 'views.ajax',
'type' => MENU_CALLBACK,
);
return $items;
}
/**
* Implement hook_menu_alter().
*/
function views_menu_alter(&$callbacks) {
$our_paths = array();
$views = views_get_applicable_views('uses_hook_menu');
foreach ($views as $data) {
list($view, $display_id) = $data;
Damian Lee
committed
$result = $view->executeHookMenu($display_id, $callbacks);
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
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)) {
Damian Lee
committed
$view->setDisplay($display_id);
$view->initHandlers();
$ids = array_keys($view->argument);
$indexes = array();
Damian Lee
committed
$path = explode('/', $view->getPath());
foreach ($path as $id => $piece) {
if ($piece == '%' && !empty($ids)) {
$indexes[$id] = array_shift($ids);
}
}
if (isset($indexes[$index])) {
if (isset($view->argument[$indexes[$index]])) {
Alex Pott
committed
$arg = $view->argument[$indexes[$index]]->validateMenuArgument($value) ? $value : FALSE;
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
$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)) {
Dries Buytaert
committed
if ($output = $view->executeDisplay($display_id, $args)) {
return $output;
}
else {
return array();
}
Dries Buytaert
committed
// Fallback if we get here no view was found.
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.
Angie Byron
committed
if ($view = views_get_page_view()) {
views_add_contextual_links($page, 'page', $view, $view->current_display);
}
}
/**
* Implements MODULE_preprocess_HOOK().
*/
function views_preprocess_html(&$variables) {
// Early-return to prevent adding unnecessary JavaScript.
if (!user_access('access contextual links')) {
return;
}
// 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
Angie Byron
committed
// page.html.twig, so we can only find it using JavaScript. We therefore
// remove the "contextual-region" class from the <body> tag here and add
// JavaScript that will insert it back in the correct place.
if (!empty($variables['page']['#views_contextual_links'])) {
$key = array_search('contextual-region', $variables['attributes']['class']);
Tim Plunkett
committed
unset($variables['attributes']['class'][$key]);
$variables['attributes']['data-views-page-contextual-id'] = $variables['title_suffix']['contextual_links']['#id'];
drupal_add_library('views', 'views.contextual-links');
}
}
}
/**
* 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
* '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.
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
*
* 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
* 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.
* @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 \Drupal\views\Plugin\block\block\ViewsBlock::addContextualLinks()
* @see views_page_alter()
* @see template_preprocess_views_view()
*/
Tim Plunkett
committed
function views_add_contextual_links(&$render_element, $location, ViewExecutable $view, $display_id) {
// Do not do anything if the view is configured to hide its administrative
// links.
Angie Byron
committed
if ($view->getShowAdminLinks()) {
// 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.
$plugin_id = $view->displayHandlers->get($display_id)->getPluginId();
Dries Buytaert
committed
$plugin = Views::pluginManager('display')->getDefinition($plugin_id);
// If contextual_links_locations are not set, provide a sane default. (To
// avoid displaying any contextual links at all, a display plugin can still
// set 'contextual_links_locations' to, e.g., {""}.)
if (!isset($plugin['contextual_links_locations'])) {
$plugin['contextual_links_locations'] = array('view');
elseif ($plugin['contextual_links_locations'] == array() || $plugin['contextual_links_locations'] == array('')) {
$plugin['contextual_links_locations'] = array();
}
else {
$plugin += array('contextual_links_locations' => array('view'));
}
// On exposed_forms blocks contextual links should always be visible.
$plugin['contextual_links_locations'][] = 'exposed_filter';
$has_links = !empty($plugin['contextual links']) && !empty($plugin['contextual_links_locations']);
if ($has_links && in_array($location, $plugin['contextual_links_locations'])) {
foreach ($plugin['contextual links'] as $group => $link) {
if (!empty($link['route_parameters_names'])) {
foreach ($link['route_parameters_names'] as $parameter_name => $property) {
// If the plugin is trying to create an invalid contextual link
// (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)) {
$args[$parameter_name] = $view->storage->{$property};
}
}
}
// If the link was valid, attach information about it to the renderable
// array.
if ($valid) {
$render_element['#views_contextual_links'] = TRUE;
$render_element['#contextual_links'][$group] = array(
'route_parameters' => $args,
'metadata' => array(
'location' => $location,
'name' => $view->storage->id(),
'display_id' => $display_id,
),
catch
committed
* Prepares a list of language names.
catch
committed
* This is a wrapper around language_list to return a plain key value array.
catch
committed
* @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::STATE_CONFIGURABLE, Language::STATE_LOCKED,
* Language::STATE_ALL.
catch
committed
*
* @return array
* An array of language names (or $field) keyed by the langcode.
function views_language_list($field = 'name', $flags = Language::STATE_ALL) {
catch
committed
$languages = language_list($flags);
$list = array();
foreach ($languages as $language) {
$list[$language->id] = ($field == 'name') ? t($language->name) : $language->$field;
* Implements hook_ENTITY_TYPE_create() for 'field_instance'.
function views_field_instance_create(FieldInstanceInterface $field_instance) {
cache('views_info')->deleteAll();
cache('views_results')->deleteAll();
* Implements hook_ENTITY_TYPE_update() for 'field_instance'.
function views_field_instance_update(FieldInstanceInterface $field_instance) {
cache('views_info')->deleteAll();
cache('views_results')->deleteAll();
* Implements hook_ENTITY_TYPE_delete() for 'field_instance'.
function views_field_instance_delete(FieldInstanceInterface $field_instance) {
cache('views_info')->deleteAll();
cache('views_results')->deleteAll();
}
/**
* Invalidate the views cache, forcing a rebuild on the next grab of table data.
*/
function views_invalidate_cache() {
Tim Plunkett
committed
// Clear the views cache.
cache('views_info')->deleteAll();
Tim Plunkett
committed
// Clear the page and block cache.
Cache::deleteTags(array('content' => TRUE));
Tim Plunkett
committed
// Set the menu as needed to be rebuilt.
\Drupal::state()->set('menu_rebuild_needed', TRUE);
Tim Plunkett
committed
$module_handler = \Drupal::moduleHandler();
Alex Pott
committed
Angie Byron
committed
// Reset the RouteSubscriber from views.
\Drupal::getContainer()->get('views.route_subscriber')->reset();
Alex Pott
committed
// 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')) {
\Drupal::service('router.builder')->rebuild();
Alex Pott
committed
}
Dries Buytaert
committed
// Invalidate the block cache to update views block derivatives.
Alex Pott
committed
if ($module_handler->moduleExists('block')) {
\Drupal::service('plugin.manager.block')->clearCachedDefinitions();
Dries Buytaert
committed
}
Tim Plunkett
committed
// Allow modules to respond to the Views cache being cleared.
Alex Pott
committed
$module_handler->invokeAll('views_invalidate_cache');
}
/**
* 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;
}
/**
Alex Pott
committed
* Find out what, if any, page view is currently in use.
Alex Pott
committed
* Note that this returns a reference, so be careful! You can unintentionally
* modify the $view object.
*
* @return \Drupal\views\ViewExecutable
* 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
*
Alex Pott
committed
* @return \Drupal\views\ViewExecutable
*/
function &views_set_current_view($view = NULL) {
static $cache = NULL;
if (isset($view)) {
$cache = $view;
}
return $cache;
}
/**
Alex Pott
committed
* Find out what, if any, current view is currently in use.
Alex Pott
committed
* Note that this returns a reference, so be careful! You can unintentionally
* modify the $view object.
*
* @return \Drupal\views\ViewExecutable
*/
function &views_get_current_view() {
return views_set_current_view();
}
Daniel Wehner
committed
/**
* Implements hook_hook_info().
*/
function views_hook_info() {
Angie Byron
committed
$hooks = array();
$hooks += array_fill_keys(array(
'views_data',
'views_data_alter',
'views_analyze',
'views_invalidate_cache',
), array('group' => 'views'));
Alex Pott
committed
// Register a views_plugins alter hook for all plugin types.
foreach (ViewExecutable::getPluginTypes() as $type) {
$hooks['views_plugins_' . $type . '_alter'] = array(
'group' => 'views',
);
}
Angie Byron
committed
$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'));
Daniel Wehner
committed
return $hooks;
catch
committed
* Implements hook_library_info().
*/
function views_library_info() {
$path = drupal_get_path('module', 'views');
$libraries['views.module'] = array(
'title' => 'Views base',
'version' => \Drupal::VERSION,
'css' => array(
"$path/css/views.module.css"
),
);
catch
committed
$libraries['views.ajax'] = array(
'title' => 'Views AJAX',
'version' => \Drupal::VERSION,
catch
committed
'js' => array(
"$path/js/base.js" => array('group' => JS_DEFAULT),
"$path/js/ajax_view.js" => array('group' => JS_DEFAULT),
catch
committed
),
'dependencies' => array(
array('system', 'jquery'),
array('system', 'drupal'),
array('system', 'drupalSettings'),
array('system', 'jquery.once'),
array('system', 'jquery.form'),
array('system', 'drupal.ajax'),
),
);
$libraries['views.contextual-links'] = array(
'title' => 'Views Contextual links',
'version' => \Drupal::VERSION,
'js' => array(
Angie Byron
committed
// Set to -10 to move it before the contextual links javascript file.
"$path/js/views-contextual.js" => array('group' => JS_LIBRARY, 'weight' => -10),
),
'dependencies' => array(
array('system', 'jquery'),
array('system', 'drupal'),
),
);
$libraries['views.exposed-form'] = array(
'title' => 'Views exposed form',
'version' => \Drupal::VERSION,
'css' => array(
"$path/css/views.exposed_form.css",
),
);
catch
committed
return $libraries;
}
/**
* 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'.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::fetchPluginNames().
*/
function views_fetch_plugin_names($type, $key = NULL, $base = array()) {
Alex Pott
committed
return Views::fetchPluginNames($type, $key, $base);
Bram Goffings
committed
/**
Tim Plunkett
committed
* Gets all the views plugin definitions.
*
* @return array
Angie Byron
committed
* An array of plugin definitions for all types.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getPluginDefinitions().
Bram Goffings
committed
*/
Angie Byron
committed
function views_get_plugin_definitions() {
Alex Pott
committed
return Views::getPluginDefinitions();
}
Bram Goffings
committed
Alex Pott
committed
/**
* 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.
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::pluginList().
*/
function views_plugin_list() {
return Views::pluginList();
}
/**
* Get enabled display extenders.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getEnabledDisplayExtenders().
*/
function views_get_enabled_display_extenders() {
Alex Pott
committed
return Views::getEnabledDisplayExtenders();
/**
* Return a list of all views and display IDs that have a particular
* setting in their display's plugin settings.
*
Angie Byron
committed
* @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.
* @code
* array(
* array($view, $display_id),
* array($view, $display_id),
* );
* @endcode
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getApplicableViews().
*/
function views_get_applicable_views($type) {
Alex Pott
committed
return Views::getApplicableViews($type);
Tim Plunkett
committed
* Returns an array of all views as fully loaded $view objects.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getAllViews().
Tim Plunkett
committed
function views_get_all_views() {
Alex Pott
committed
return Views::getAllViews();
}
/**
* Returns an array of all enabled views, as fully loaded $view objects.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getEnabledViews().
Alex Pott
committed
return Views::getEnabledViews();
}
/**
* Returns an array of all disabled views, as fully loaded $view objects.
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getDisabledViews().
Alex Pott
committed
return Views::getDisabledViews();
}
/**
* 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
Tim Plunkett
committed
* - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
* - 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
* @param bool $sort
* If TRUE, the list of views is sorted ascending.
*
* @return array
* an associative array for use in select.
* - key: view name and display id separated by ':', or the view name only
Alex Pott
committed
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getViewsAsOptions().
function views_get_views_as_options($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
Alex Pott
committed
return Views::getViewsAsOptions($views_only, $filter, $exclude_view, $optgroup, $sort);
* Returns whether the view is enabled.
*
Alex Pott
committed
* @param \Drupal\views\Entity\View $view
*
* @return bool
* Returns TRUE if a view is enabled, FALSE otherwise.
Angie Byron
committed
function views_view_is_enabled(View $view) {
return $view->status();
* Returns whether the view is disabled.
*
Alex Pott
committed
* @param \Drupal\views\Entity\View $view
*
* @return bool
* Returns TRUE if a view is disabled, FALSE otherwise.
Angie Byron
committed
function views_view_is_disabled(View $view) {
return !$view->status();
/**
* Enables and saves a view.
*
Alex Pott
committed
* @param \Drupal\views\Entity\View $view
Angie Byron
committed
* The View object to disable.
*/
Angie Byron
committed
function views_enable_view(View $view) {
$view->enable()->save();
}
/**
* Disables and saves a view.
*
Alex Pott
committed
* @param \Drupal\views\Entity\View $view
Angie Byron
committed
* The View object to disable.
*/
Angie Byron
committed
function views_disable_view(View $view) {
$view->disable()->save();
}
Alex Pott
committed
* @return \Drupal\views\ViewExecutable
*
* @deprecated as of Drupal 8.0. Use \Drupal\views\Views::getView().
*
Daniel Wehner
committed
function views_get_view($name) {
return Views::getView($name);
}
/**
* 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)) {