annotate core/modules/views/src/Views.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 4c8ae668cc8c
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\views;
Chris@0 4
Chris@0 5 /**
Chris@0 6 * Static service container wrapper for views.
Chris@0 7 */
Chris@0 8 class Views {
Chris@0 9
Chris@0 10 /**
Chris@0 11 * The translation manager.
Chris@0 12 *
Chris@0 13 * @var \Drupal\Core\StringTranslation\TranslationInterface
Chris@0 14 */
Chris@0 15 protected static $translationManager;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * A static cache for handler types data.
Chris@0 19 *
Chris@0 20 * @var array
Chris@0 21 */
Chris@0 22 protected static $handlerTypes;
Chris@0 23
Chris@0 24 /**
Chris@0 25 * A list of all available views plugin types.
Chris@0 26 *
Chris@0 27 * @var array
Chris@0 28 */
Chris@0 29 protected static $plugins = [
Chris@0 30 'access' => 'plugin',
Chris@0 31 'area' => 'handler',
Chris@0 32 'argument' => 'handler',
Chris@0 33 'argument_default' => 'plugin',
Chris@0 34 'argument_validator' => 'plugin',
Chris@0 35 'cache' => 'plugin',
Chris@0 36 'display_extender' => 'plugin',
Chris@0 37 'display' => 'plugin',
Chris@0 38 'exposed_form' => 'plugin',
Chris@0 39 'field' => 'handler',
Chris@0 40 'filter' => 'handler',
Chris@0 41 'join' => 'plugin',
Chris@0 42 'pager' => 'plugin',
Chris@0 43 'query' => 'plugin',
Chris@0 44 'relationship' => 'handler',
Chris@0 45 'row' => 'plugin',
Chris@0 46 'sort' => 'handler',
Chris@0 47 'style' => 'plugin',
Chris@0 48 'wizard' => 'plugin',
Chris@0 49 ];
Chris@0 50
Chris@0 51 /**
Chris@0 52 * Returns the views data service.
Chris@0 53 *
Chris@0 54 * @return \Drupal\views\ViewsData
Chris@0 55 * Returns a views data cache object.
Chris@0 56 */
Chris@0 57 public static function viewsData() {
Chris@0 58 return \Drupal::service('views.views_data');
Chris@0 59 }
Chris@0 60
Chris@0 61 /**
Chris@0 62 * Returns the views data helper service.
Chris@0 63 *
Chris@0 64 * @return \Drupal\views\ViewsDataHelper
Chris@0 65 * Returns a views data helper object.
Chris@0 66 */
Chris@0 67 public static function viewsDataHelper() {
Chris@0 68 return \Drupal::service('views.views_data_helper');
Chris@0 69 }
Chris@0 70
Chris@0 71 /**
Chris@0 72 * Returns the view executable factory service.
Chris@0 73 *
Chris@0 74 * @return \Drupal\views\ViewExecutableFactory
Chris@0 75 * Returns a views executable factory.
Chris@0 76 */
Chris@0 77 public static function executableFactory() {
Chris@0 78 return \Drupal::service('views.executable');
Chris@0 79 }
Chris@0 80
Chris@0 81 /**
Chris@0 82 * Returns the view analyzer.
Chris@0 83 *
Chris@0 84 * @return \Drupal\views\Analyzer
Chris@0 85 * Returns a view analyzer object.
Chris@0 86 */
Chris@0 87 public static function analyzer() {
Chris@0 88 return \Drupal::service('views.analyzer');
Chris@0 89 }
Chris@0 90
Chris@0 91 /**
Chris@0 92 * Returns the plugin manager for a certain views plugin type.
Chris@0 93 *
Chris@0 94 * @param string $type
Chris@0 95 * The plugin type, for example filter.
Chris@0 96 *
Chris@0 97 * @return \Drupal\views\Plugin\ViewsPluginManager
Chris@0 98 */
Chris@0 99 public static function pluginManager($type) {
Chris@0 100 return \Drupal::service('plugin.manager.views.' . $type);
Chris@0 101 }
Chris@0 102
Chris@0 103 /**
Chris@0 104 * Returns the plugin manager for a certain views handler type.
Chris@0 105 *
Chris@0 106 * @return \Drupal\views\Plugin\ViewsHandlerManager
Chris@0 107 */
Chris@0 108 public static function handlerManager($type) {
Chris@0 109 return \Drupal::service('plugin.manager.views.' . $type);
Chris@0 110 }
Chris@0 111
Chris@0 112 /**
Chris@0 113 * Loads a view from configuration and returns its executable object.
Chris@0 114 *
Chris@0 115 * @param string $id
Chris@0 116 * The view ID to load.
Chris@0 117 *
Chris@0 118 * @return \Drupal\views\ViewExecutable
Chris@0 119 * A view executable instance, from the loaded entity.
Chris@0 120 */
Chris@0 121 public static function getView($id) {
Chris@0 122 $view = \Drupal::service('entity.manager')->getStorage('view')->load($id);
Chris@0 123 if ($view) {
Chris@0 124 return static::executableFactory()->get($view);
Chris@0 125 }
Chris@0 126 }
Chris@0 127
Chris@0 128 /**
Chris@0 129 * Fetches a list of all base tables available
Chris@0 130 *
Chris@0 131 * @param string $type
Chris@0 132 * Either 'display', 'style' or 'row'.
Chris@0 133 * @param string $key
Chris@0 134 * For style plugins, this is an optional type to restrict to. May be
Chris@0 135 * 'normal', 'summary', 'feed' or others based on the needs of the display.
Chris@0 136 * @param array $base
Chris@0 137 * An array of possible base tables.
Chris@0 138 *
Chris@0 139 * @return
Chris@0 140 * A keyed array of in the form of 'base_table' => 'Description'.
Chris@0 141 */
Chris@0 142 public static function fetchPluginNames($type, $key = NULL, array $base = []) {
Chris@0 143 $definitions = static::pluginManager($type)->getDefinitions();
Chris@0 144 $plugins = [];
Chris@0 145
Chris@0 146 foreach ($definitions as $id => $plugin) {
Chris@0 147 // Skip plugins that don't conform to our key, if they have one.
Chris@0 148 if ($key && isset($plugin['display_types']) && !in_array($key, $plugin['display_types'])) {
Chris@0 149 continue;
Chris@0 150 }
Chris@0 151
Chris@0 152 if (empty($plugin['no_ui']) && (empty($base) || empty($plugin['base']) || array_intersect($base, $plugin['base']))) {
Chris@0 153 $plugins[$id] = $plugin['title'];
Chris@0 154 }
Chris@0 155 }
Chris@0 156
Chris@0 157 if (!empty($plugins)) {
Chris@0 158 asort($plugins);
Chris@0 159 return $plugins;
Chris@0 160 }
Chris@0 161
Chris@0 162 return $plugins;
Chris@0 163 }
Chris@0 164
Chris@0 165 /**
Chris@0 166 * Gets all the views plugin definitions.
Chris@0 167 *
Chris@0 168 * @return array
Chris@0 169 * An array of plugin definitions for all types.
Chris@0 170 */
Chris@0 171 public static function getPluginDefinitions() {
Chris@0 172 $plugins = [];
Chris@0 173 foreach (ViewExecutable::getPluginTypes() as $plugin_type) {
Chris@0 174 $plugins[$plugin_type] = static::pluginManager($plugin_type)->getDefinitions();
Chris@0 175 }
Chris@0 176
Chris@0 177 return $plugins;
Chris@0 178 }
Chris@0 179
Chris@0 180 /**
Chris@0 181 * Gets enabled display extenders.
Chris@0 182 */
Chris@0 183 public static function getEnabledDisplayExtenders() {
Chris@0 184 $enabled = array_filter((array) \Drupal::config('views.settings')->get('display_extenders'));
Chris@0 185
Chris@0 186 return array_combine($enabled, $enabled);
Chris@0 187 }
Chris@0 188
Chris@0 189 /**
Chris@0 190 * Return a list of all view IDs and display IDs that have a particular
Chris@0 191 * setting in their display's plugin settings.
Chris@0 192 *
Chris@0 193 * @param string $type
Chris@0 194 * A flag from the display plugin definitions (e.g, 'uses_menu_links').
Chris@0 195 *
Chris@0 196 * @return array
Chris@0 197 * A list of arrays containing the $view_id and $display_id.
Chris@0 198 * @code
Chris@0 199 * array(
Chris@0 200 * array($view_id, $display_id),
Chris@0 201 * array($view_id, $display_id),
Chris@0 202 * );
Chris@0 203 * @endcode
Chris@0 204 */
Chris@0 205 public static function getApplicableViews($type) {
Chris@0 206 // Get all display plugins which provides the type.
Chris@0 207 $display_plugins = static::pluginManager('display')->getDefinitions();
Chris@0 208
Chris@0 209 $plugin_ids = [];
Chris@0 210 foreach ($display_plugins as $id => $definition) {
Chris@0 211 if (!empty($definition[$type])) {
Chris@0 212 $plugin_ids[$id] = $id;
Chris@0 213 }
Chris@0 214 }
Chris@0 215
Chris@0 216 $entity_ids = \Drupal::entityQuery('view')
Chris@0 217 ->condition('status', TRUE)
Chris@0 218 ->condition("display.*.display_plugin", $plugin_ids, 'IN')
Chris@0 219 ->execute();
Chris@0 220
Chris@0 221 $result = [];
Chris@0 222 foreach (\Drupal::entityTypeManager()->getStorage('view')->loadMultiple($entity_ids) as $view) {
Chris@0 223 // Check each display to see if it meets the criteria and is enabled.
Chris@0 224
Chris@0 225 foreach ($view->get('display') as $id => $display) {
Chris@0 226 // If the key doesn't exist, enabled is assumed.
Chris@0 227 $enabled = !empty($display['display_options']['enabled']) || !array_key_exists('enabled', $display['display_options']);
Chris@0 228
Chris@0 229 if ($enabled && in_array($display['display_plugin'], $plugin_ids)) {
Chris@0 230 $result[] = [$view->id(), $id];
Chris@0 231 }
Chris@0 232 }
Chris@0 233 }
Chris@0 234
Chris@0 235 return $result;
Chris@0 236 }
Chris@0 237
Chris@0 238 /**
Chris@0 239 * Returns an array of all views as fully loaded $view objects.
Chris@0 240 *
Chris@0 241 * @return \Drupal\views\Entity\View[]
Chris@0 242 * An array of loaded view entities.
Chris@0 243 */
Chris@0 244 public static function getAllViews() {
Chris@0 245 return \Drupal::entityManager()->getStorage('view')->loadMultiple();
Chris@0 246 }
Chris@0 247
Chris@0 248 /**
Chris@0 249 * Returns an array of all enabled views.
Chris@0 250 *
Chris@0 251 * @return \Drupal\views\Entity\View[]
Chris@0 252 * An array of loaded enabled view entities.
Chris@0 253 */
Chris@0 254 public static function getEnabledViews() {
Chris@0 255 $query = \Drupal::entityQuery('view')
Chris@0 256 ->condition('status', TRUE)
Chris@0 257 ->execute();
Chris@0 258
Chris@0 259 return \Drupal::entityManager()->getStorage('view')->loadMultiple($query);
Chris@0 260 }
Chris@0 261
Chris@0 262 /**
Chris@0 263 * Returns an array of all disabled views.
Chris@0 264 *
Chris@0 265 * @return \Drupal\views\Entity\View[]
Chris@0 266 * An array of loaded disabled view entities.
Chris@0 267 */
Chris@0 268 public static function getDisabledViews() {
Chris@0 269 $query = \Drupal::entityQuery('view')
Chris@0 270 ->condition('status', FALSE)
Chris@0 271 ->execute();
Chris@0 272
Chris@0 273 return \Drupal::entityManager()->getStorage('view')->loadMultiple($query);
Chris@0 274 }
Chris@0 275
Chris@0 276 /**
Chris@0 277 * Returns an array of view as options array, that can be used by select,
Chris@0 278 * checkboxes and radios as #options.
Chris@0 279 *
Chris@0 280 * @param bool $views_only
Chris@0 281 * If TRUE, only return views, not displays.
Chris@0 282 * @param string $filter
Chris@0 283 * Filters the views on status. Can either be 'all' (default), 'enabled' or
Chris@0 284 * 'disabled'
Chris@0 285 * @param mixed $exclude_view
Chris@0 286 * View or current display to exclude.
Chris@0 287 * Either a:
Chris@0 288 * - views object (containing $exclude_view->storage->name and $exclude_view->current_display)
Chris@0 289 * - views name as string: e.g. my_view
Chris@0 290 * - views name and display id (separated by ':'): e.g. my_view:default
Chris@0 291 * @param bool $optgroup
Chris@0 292 * If TRUE, returns an array with optgroups for each view (will be ignored for
Chris@0 293 * $views_only = TRUE). Can be used by select
Chris@0 294 * @param bool $sort
Chris@0 295 * If TRUE, the list of views is sorted ascending.
Chris@0 296 *
Chris@0 297 * @return array
Chris@0 298 * An associative array for use in select.
Chris@0 299 * - key: view name and display id separated by ':', or the view name only.
Chris@0 300 */
Chris@0 301 public static function getViewsAsOptions($views_only = FALSE, $filter = 'all', $exclude_view = NULL, $optgroup = FALSE, $sort = FALSE) {
Chris@0 302
Chris@0 303 // Filter the big views array.
Chris@0 304 switch ($filter) {
Chris@0 305 case 'all':
Chris@0 306 case 'disabled':
Chris@0 307 case 'enabled':
Chris@0 308 $filter = ucfirst($filter);
Chris@0 309 $views = call_user_func("static::get{$filter}Views");
Chris@0 310 break;
Chris@0 311 default:
Chris@0 312 return [];
Chris@0 313 }
Chris@0 314
Chris@0 315 // Prepare exclude view strings for comparison.
Chris@0 316 if (empty($exclude_view)) {
Chris@0 317 $exclude_view_name = '';
Chris@0 318 $exclude_view_display = '';
Chris@0 319 }
Chris@0 320 elseif (is_object($exclude_view)) {
Chris@0 321 $exclude_view_name = $exclude_view->storage->id();
Chris@0 322 $exclude_view_display = $exclude_view->current_display;
Chris@0 323 }
Chris@0 324 else {
Chris@0 325 // Append a ':' to the $exclude_view string so we always have more than one
Chris@0 326 // item to explode.
Chris@0 327 list($exclude_view_name, $exclude_view_display) = explode(':', "$exclude_view:");
Chris@0 328 }
Chris@0 329
Chris@0 330 $options = [];
Chris@0 331 foreach ($views as $view) {
Chris@0 332 $id = $view->id();
Chris@0 333 // Return only views.
Chris@0 334 if ($views_only && $id != $exclude_view_name) {
Chris@0 335 $options[$id] = $view->label();
Chris@0 336 }
Chris@0 337 // Return views with display ids.
Chris@0 338 else {
Chris@0 339 foreach ($view->get('display') as $display_id => $display) {
Chris@0 340 if (!($id == $exclude_view_name && $display_id == $exclude_view_display)) {
Chris@0 341 if ($optgroup) {
Chris@0 342 $options[$id][$id . ':' . $display['id']] = t('@view : @display', ['@view' => $id, '@display' => $display['id']]);
Chris@0 343 }
Chris@0 344 else {
Chris@0 345 $options[$id . ':' . $display['id']] = t('View: @view - Display: @display', ['@view' => $id, '@display' => $display['id']]);
Chris@0 346 }
Chris@0 347 }
Chris@0 348 }
Chris@0 349 }
Chris@0 350 }
Chris@0 351 if ($sort) {
Chris@0 352 ksort($options);
Chris@0 353 }
Chris@0 354 return $options;
Chris@0 355 }
Chris@0 356
Chris@0 357 /**
Chris@0 358 * Returns a list of plugins and metadata about them.
Chris@0 359 *
Chris@0 360 * @return array
Chris@0 361 * An array keyed by PLUGIN_TYPE:PLUGIN_NAME, like 'display:page' or
Chris@0 362 * 'pager:full', containing an array with the following keys:
Chris@0 363 * - title: The plugin's title.
Chris@0 364 * - type: The plugin type.
Chris@0 365 * - module: The module providing the plugin.
Chris@0 366 * - views: An array of enabled Views that are currently using this plugin,
Chris@0 367 * keyed by machine name.
Chris@0 368 */
Chris@0 369 public static function pluginList() {
Chris@0 370 $plugin_data = static::getPluginDefinitions();
Chris@0 371 $plugins = [];
Chris@0 372 foreach (static::getEnabledViews() as $view) {
Chris@0 373 foreach ($view->get('display') as $display) {
Chris@0 374 foreach ($plugin_data as $type => $info) {
Chris@0 375 if ($type == 'display' && isset($display['display_plugin'])) {
Chris@0 376 $name = $display['display_plugin'];
Chris@0 377 }
Chris@0 378 elseif (isset($display['display_options']["{$type}_plugin"])) {
Chris@0 379 $name = $display['display_options']["{$type}_plugin"];
Chris@0 380 }
Chris@0 381 elseif (isset($display['display_options'][$type]['type'])) {
Chris@0 382 $name = $display['display_options'][$type]['type'];
Chris@0 383 }
Chris@0 384 else {
Chris@0 385 continue;
Chris@0 386 }
Chris@0 387
Chris@0 388 // Key first by the plugin type, then the name.
Chris@0 389 $key = $type . ':' . $name;
Chris@0 390 // Add info for this plugin.
Chris@0 391 if (!isset($plugins[$key])) {
Chris@0 392 $plugins[$key] = [
Chris@0 393 'type' => $type,
Chris@0 394 'title' => $info[$name]['title'],
Chris@0 395 'provider' => $info[$name]['provider'],
Chris@0 396 'views' => [],
Chris@0 397 ];
Chris@0 398 }
Chris@0 399
Chris@0 400 // Add this view to the list for this plugin.
Chris@0 401 $plugins[$key]['views'][$view->id()] = $view->id();
Chris@0 402 }
Chris@0 403 }
Chris@0 404 }
Chris@0 405 return $plugins;
Chris@0 406 }
Chris@0 407
Chris@0 408 /**
Chris@0 409 * Provide a list of views handler types used in a view, with some information
Chris@0 410 * about them.
Chris@0 411 *
Chris@0 412 * @return array
Chris@0 413 * An array of associative arrays containing:
Chris@0 414 * - title: The title of the handler type.
Chris@0 415 * - ltitle: The lowercase title of the handler type.
Chris@0 416 * - stitle: A singular title of the handler type.
Chris@0 417 * - lstitle: A singular lowercase title of the handler type.
Chris@0 418 * - plural: Plural version of the handler type.
Chris@0 419 * - (optional) type: The actual internal used handler type. This key is
Chris@0 420 * just used for header,footer,empty to link to the internal type: area.
Chris@0 421 */
Chris@0 422 public static function getHandlerTypes() {
Chris@0 423 // Statically cache this so translation only occurs once per request for all
Chris@0 424 // of these values.
Chris@0 425 if (!isset(static::$handlerTypes)) {
Chris@0 426 static::$handlerTypes = [
Chris@0 427 'field' => [
Chris@0 428 // title
Chris@0 429 'title' => static::t('Fields'),
Chris@0 430 // Lowercase title for mid-sentence.
Chris@0 431 'ltitle' => static::t('fields'),
Chris@0 432 // Singular title.
Chris@0 433 'stitle' => static::t('Field'),
Chris@0 434 // Singular lowercase title for mid sentence
Chris@0 435 'lstitle' => static::t('field'),
Chris@0 436 'plural' => 'fields',
Chris@0 437 ],
Chris@0 438 'argument' => [
Chris@0 439 'title' => static::t('Contextual filters'),
Chris@0 440 'ltitle' => static::t('contextual filters'),
Chris@0 441 'stitle' => static::t('Contextual filter'),
Chris@0 442 'lstitle' => static::t('contextual filter'),
Chris@0 443 'plural' => 'arguments',
Chris@0 444 ],
Chris@0 445 'sort' => [
Chris@0 446 'title' => static::t('Sort criteria'),
Chris@0 447 'ltitle' => static::t('sort criteria'),
Chris@0 448 'stitle' => static::t('Sort criterion'),
Chris@0 449 'lstitle' => static::t('sort criterion'),
Chris@0 450 'plural' => 'sorts',
Chris@0 451 ],
Chris@0 452 'filter' => [
Chris@0 453 'title' => static::t('Filter criteria'),
Chris@0 454 'ltitle' => static::t('filter criteria'),
Chris@0 455 'stitle' => static::t('Filter criterion'),
Chris@0 456 'lstitle' => static::t('filter criterion'),
Chris@0 457 'plural' => 'filters',
Chris@0 458 ],
Chris@0 459 'relationship' => [
Chris@0 460 'title' => static::t('Relationships'),
Chris@0 461 'ltitle' => static::t('relationships'),
Chris@0 462 'stitle' => static::t('Relationship'),
Chris@0 463 'lstitle' => static::t('Relationship'),
Chris@0 464 'plural' => 'relationships',
Chris@0 465 ],
Chris@0 466 'header' => [
Chris@0 467 'title' => static::t('Header'),
Chris@0 468 'ltitle' => static::t('header'),
Chris@0 469 'stitle' => static::t('Header'),
Chris@0 470 'lstitle' => static::t('Header'),
Chris@0 471 'plural' => 'header',
Chris@0 472 'type' => 'area',
Chris@0 473 ],
Chris@0 474 'footer' => [
Chris@0 475 'title' => static::t('Footer'),
Chris@0 476 'ltitle' => static::t('footer'),
Chris@0 477 'stitle' => static::t('Footer'),
Chris@0 478 'lstitle' => static::t('Footer'),
Chris@0 479 'plural' => 'footer',
Chris@0 480 'type' => 'area',
Chris@0 481 ],
Chris@0 482 'empty' => [
Chris@0 483 'title' => static::t('No results behavior'),
Chris@0 484 'ltitle' => static::t('no results behavior'),
Chris@0 485 'stitle' => static::t('No results behavior'),
Chris@0 486 'lstitle' => static::t('No results behavior'),
Chris@0 487 'plural' => 'empty',
Chris@0 488 'type' => 'area',
Chris@0 489 ],
Chris@0 490 ];
Chris@0 491 }
Chris@0 492
Chris@0 493 return static::$handlerTypes;
Chris@0 494 }
Chris@0 495
Chris@0 496 /**
Chris@0 497 * Returns a list of plugin types.
Chris@0 498 *
Chris@0 499 * @param string $type
Chris@0 500 * (optional) filter the list of plugins by type. Available options are
Chris@0 501 * 'plugin' or 'handler'.
Chris@0 502 *
Chris@0 503 * @return array
Chris@0 504 * An array of plugin types.
Chris@0 505 */
Chris@0 506 public static function getPluginTypes($type = NULL) {
Chris@0 507 if ($type === NULL) {
Chris@0 508 return array_keys(static::$plugins);
Chris@0 509 }
Chris@0 510
Chris@0 511 if (!in_array($type, ['plugin', 'handler'])) {
Chris@0 512 throw new \Exception('Invalid plugin type used. Valid types are "plugin" or "handler".');
Chris@0 513 }
Chris@0 514
Chris@0 515 return array_keys(array_filter(static::$plugins, function ($plugin_type) use ($type) {
Chris@0 516 return $plugin_type == $type;
Chris@0 517 }));
Chris@0 518 }
Chris@0 519
Chris@0 520 /**
Chris@0 521 * Translates a string to the current language or to a given language.
Chris@0 522 *
Chris@0 523 * See the t() documentation for details.
Chris@0 524 */
Chris@0 525 protected static function t($string, array $args = [], array $options = []) {
Chris@0 526 if (empty(static::$translationManager)) {
Chris@0 527 static::$translationManager = \Drupal::service('string_translation');
Chris@0 528 }
Chris@0 529
Chris@0 530 return static::$translationManager->translate($string, $args, $options);
Chris@0 531 }
Chris@0 532
Chris@0 533 }