Drupal.php 24.3 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal.
6 7
 */

8
use Drupal\Core\DependencyInjection\ContainerNotInitializedException;
9
use Drupal\Core\Messenger\LegacyMessenger;
10
use Drupal\Core\Url;
11
use Symfony\Component\DependencyInjection\ContainerInterface;
12 13 14 15 16 17 18 19 20 21 22 23 24

/**
 * Static Service Container wrapper.
 *
 * Generally, code in Drupal should accept its dependencies via either
 * constructor injection or setter method injection. However, there are cases,
 * particularly in legacy procedural code, where that is infeasible. This
 * class acts as a unified global accessor to arbitrary services within the
 * system in order to ease the transition from procedural code to injected OO
 * code.
 *
 * The container is built by the kernel and passed in to this class which stores
 * it statically. The container always contains the services from
25 26
 * \Drupal\Core\CoreServiceProvider, the service providers of enabled modules and any other
 * service providers defined in $GLOBALS['conf']['container_service_providers'].
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
 *
 * This class exists only to support legacy code that cannot be dependency
 * injected. If your code needs it, consider refactoring it to be object
 * oriented, if possible. When this is not possible, for instance in the case of
 * hook implementations, and your code is more than a few non-reusable lines, it
 * is recommended to instantiate an object implementing the actual logic.
 *
 * @code
 *   // Legacy procedural code.
 *   function hook_do_stuff() {
 *     $lock = lock()->acquire('stuff_lock');
 *     // ...
 *   }
 *
 *   // Correct procedural code.
 *   function hook_do_stuff() {
43
 *     $lock = \Drupal::lock()->acquire('stuff_lock');
44 45 46 47 48 49
 *     // ...
 *   }
 *
 *   // The preferred way: dependency injected code.
 *   function hook_do_stuff() {
 *     // Move the actual implementation to a class and instantiate it.
50
 *     $instance = new StuffDoingClass(\Drupal::lock());
51 52 53 54 55 56
 *     $instance->doStuff();
 *
 *     // Or, even better, rely on the service container to avoid hard coding a
 *     // specific interface implementation, so that the actual logic can be
 *     // swapped. This might not always make sense, but in general it is a good
 *     // practice.
57
 *     \Drupal::service('stuff.doing')->doStuff();
58 59 60 61 62 63 64 65 66
 *   }
 *
 *   interface StuffDoingInterface {
 *     public function doStuff();
 *   }
 *
 *   class StuffDoingClass implements StuffDoingInterface {
 *     protected $lockBackend;
 *
67 68
 *     public function __construct(LockBackendInterface $lock_backend) {
 *       $this->lockBackend = $lock_backend;
69 70 71 72 73 74 75 76 77 78 79 80 81
 *     }
 *
 *     public function doStuff() {
 *       $lock = $this->lockBackend->acquire('stuff_lock');
 *       // ...
 *     }
 *   }
 * @endcode
 *
 * @see \Drupal\Core\DrupalKernel
 */
class Drupal {

82 83 84
  /**
   * The current system version.
   */
xjm's avatar
xjm committed
85
  const VERSION = '8.5.0-dev';
86 87 88 89 90 91

  /**
   * Core API compatibility.
   */
  const CORE_COMPATIBILITY = '8.x';

92 93 94 95 96
  /**
   * Core minimum schema version.
   */
  const CORE_MINIMUM_SCHEMA_VERSION = 8000;

97
  /**
98
   * The currently active container object, or NULL if not initialized yet.
99
   *
100
   * @var \Symfony\Component\DependencyInjection\ContainerInterface|null
101 102 103
   */
  protected static $container;

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119
  /**
   * The LegacyMessenger instance.
   *
   * Note: this is merely used to ensure that the instance survives when
   * \Drupal::messenger() is invoked. It is required to ensure that messages
   * are properly transferred to the Messenger service once the container has
   * been initialized. Do not store the Messenger service here.
   *
   * @todo Remove once LegacyMessenger has been removed before 9.0.0.
   *
   * @see https://www.drupal.org/node/2928994
   *
   * @var \Drupal\Core\Messenger\LegacyMessenger|null
   */
  protected static $legacyMessenger;

120 121 122 123
  /**
   * Sets a new global container.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
124
   *   A new container instance to replace the current.
125
   */
126
  public static function setContainer(ContainerInterface $container) {
127 128 129
    static::$container = $container;
  }

130 131 132 133 134 135 136
  /**
   * Unsets the global container.
   */
  public static function unsetContainer() {
    static::$container = NULL;
  }

137 138 139
  /**
   * Returns the currently active global container.
   *
140
   * @return \Symfony\Component\DependencyInjection\ContainerInterface|null
141 142
   *
   * @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
143 144
   */
  public static function getContainer() {
145 146 147
    if (static::$container === NULL) {
      throw new ContainerNotInitializedException('\Drupal::$container is not initialized yet. \Drupal::setContainer() must be called with a real container.');
    }
148 149 150
    return static::$container;
  }

151 152 153 154 155 156 157 158 159 160
  /**
   * Returns TRUE if the container has been initialized, FALSE otherwise.
   *
   * @return bool
   */
  public static function hasContainer() {
    return static::$container !== NULL;
  }


161 162 163 164 165 166 167 168 169
  /**
   * Retrieves a service from the container.
   *
   * Use this method if the desired service is not one of those with a dedicated
   * accessor method below. If it is listed below, those methods are preferred
   * as they can return useful type hints.
   *
   * @param string $id
   *   The ID of the service to retrieve.
170
   *
171 172 173 174
   * @return mixed
   *   The specified service.
   */
  public static function service($id) {
175
    return static::getContainer()->get($id);
176 177
  }

178 179 180 181 182 183 184 185 186 187
  /**
   * Indicates if a service is defined in the container.
   *
   * @param string $id
   *   The ID of the service to check.
   *
   * @return bool
   *   TRUE if the specified service exists, FALSE otherwise.
   */
  public static function hasService($id) {
188 189
    // Check hasContainer() first in order to always return a Boolean.
    return static::hasContainer() && static::getContainer()->has($id);
190 191
  }

192 193 194 195 196 197
  /**
   * Gets the app root.
   *
   * @return string
   */
  public static function root() {
198
    return static::getContainer()->get('app.root');
199 200
  }

201 202 203 204 205 206 207 208 209 210
  /**
   * Gets the active install profile.
   *
   * @return string|null
   *   The name of the active install profile.
   */
  public static function installProfile() {
    return static::getContainer()->getParameter('install_profile');
  }

211 212 213 214 215 216 217
  /**
   * Indicates if there is a currently active request object.
   *
   * @return bool
   *   TRUE if there is a currently active request object, FALSE otherwise.
   */
  public static function hasRequest() {
218 219
    // Check hasContainer() first in order to always return a Boolean.
    return static::hasContainer() && static::getContainer()->has('request_stack') && static::getContainer()->get('request_stack')->getCurrentRequest() !== NULL;
220 221
  }

222 223 224
  /**
   * Retrieves the currently active request object.
   *
225
   * Note: The use of this wrapper in particular is especially discouraged. Most
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
   * code should not need to access the request directly.  Doing so means it
   * will only function when handling an HTTP request, and will require special
   * modification or wrapping when run from a command line tool, from certain
   * queue processors, or from automated tests.
   *
   * If code must access the request, it is considerably better to register
   * an object with the Service Container and give it a setRequest() method
   * that is configured to run when the service is created.  That way, the
   * correct request object can always be provided by the container and the
   * service can still be unit tested.
   *
   * If this method must be used, never save the request object that is
   * returned.  Doing so may lead to inconsistencies as the request object is
   * volatile and may change at various times, such as during a subrequest.
   *
   * @return \Symfony\Component\HttpFoundation\Request
   *   The currently active request object.
   */
  public static function request() {
245
    return static::getContainer()->get('request_stack')->getCurrentRequest();
246 247
  }

248 249 250 251 252 253 254
  /**
   * Retrives the request stack.
   *
   * @return \Symfony\Component\HttpFoundation\RequestStack
   *   The request stack
   */
  public static function requestStack() {
255
    return static::getContainer()->get('request_stack');
256 257
  }

258 259 260 261 262 263 264
  /**
   * Retrieves the currently active route match object.
   *
   * @return \Drupal\Core\Routing\RouteMatchInterface
   *   The currently active route match object.
   */
  public static function routeMatch() {
265
    return static::getContainer()->get('current_route_match');
266 267
  }

268 269 270
  /**
   * Gets the current active user.
   *
271
   * @return \Drupal\Core\Session\AccountProxyInterface
272 273
   */
  public static function currentUser() {
274
    return static::getContainer()->get('current_user');
275 276
  }

277 278 279
  /**
   * Retrieves the entity manager service.
   *
280
   * @return \Drupal\Core\Entity\EntityManagerInterface
281
   *   The entity manager service.
282 283 284 285 286 287
   *
   * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0.
   *   Use \Drupal::entityTypeManager() instead in most cases. If the needed
   *   method is not on \Drupal\Core\Entity\EntityTypeManagerInterface, see the
   *   deprecated \Drupal\Core\Entity\EntityManager to find the
   *   correct interface or service.
288 289
   */
  public static function entityManager() {
290
    return static::getContainer()->get('entity.manager');
291 292
  }

293 294 295 296 297 298 299 300 301 302
  /**
   * Retrieves the entity type manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity type manager.
   */
  public static function entityTypeManager() {
    return static::getContainer()->get('entity_type.manager');
  }

303 304 305 306 307 308 309
  /**
   * Returns the current primary database.
   *
   * @return \Drupal\Core\Database\Connection
   *   The current active database's master connection.
   */
  public static function database() {
310
    return static::getContainer()->get('database');
311 312
  }

313 314 315 316 317
  /**
   * Returns the requested cache bin.
   *
   * @param string $bin
   *   (optional) The cache bin for which the cache object should be returned,
318
   *   defaults to 'default'.
319
   *
320
   * @return \Drupal\Core\Cache\CacheBackendInterface
321
   *   The cache object associated with the specified bin.
322 323
   *
   * @ingroup cache
324
   */
325
  public static function cache($bin = 'default') {
326
    return static::getContainer()->get('cache.' . $bin);
327 328
  }

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345
  /**
   * Retrieves the class resolver.
   *
   * This is to be used in procedural code such as module files to instantiate
   * an object of a class that implements
   * \Drupal\Core\DependencyInjection\ContainerInjectionInterface.
   *
   * One common usecase is to provide a class which contains the actual code
   * of a hook implementation, without having to create a service.
   *
   * @return \Drupal\Core\DependencyInjection\ClassResolverInterface
   *   The class resolver.
   */
  public static function classResolver() {
    return static::getContainer()->get('class_resolver');
  }

346 347 348 349 350 351 352 353 354 355
  /**
   * Returns an expirable key value store collection.
   *
   * @param string $collection
   *   The name of the collection holding key and value pairs.
   *
   * @return \Drupal\Core\KeyValueStore\KeyValueStoreExpirableInterface
   *   An expirable key value store collection.
   */
  public static function keyValueExpirable($collection) {
356
    return static::getContainer()->get('keyvalue.expirable')->get($collection);
357 358
  }

359 360 361 362
  /**
   * Returns the locking layer instance.
   *
   * @return \Drupal\Core\Lock\LockBackendInterface
363 364
   *
   * @ingroup lock
365 366
   */
  public static function lock() {
367
    return static::getContainer()->get('lock');
368 369
  }

370 371 372 373
  /**
   * Retrieves a configuration object.
   *
   * This is the main entry point to the configuration API. Calling
374
   * @code \Drupal::config('book.admin') @endcode will return a configuration
375 376 377 378
   * object in which the book module can store its administrative settings.
   *
   * @param string $name
   *   The name of the configuration object to retrieve. The name corresponds to
379
   *   a configuration file. For @code \Drupal::config('book.admin') @endcode, the config
380 381
   *   object returned will contain the contents of book.admin configuration file.
   *
382 383
   * @return \Drupal\Core\Config\ImmutableConfig
   *   An immutable configuration object.
384 385
   */
  public static function config($name) {
386
    return static::getContainer()->get('config.factory')->get($name);
387 388
  }

389 390 391 392 393 394 395
  /**
   * Retrieves the configuration factory.
   *
   * This is mostly used to change the override settings on the configuration
   * factory. For example, changing the language, or turning all overrides on
   * or off.
   *
396
   * @return \Drupal\Core\Config\ConfigFactoryInterface
397
   *   The configuration factory service.
398 399
   */
  public static function configFactory() {
400
    return static::getContainer()->get('config.factory');
401 402
  }

403 404 405
  /**
   * Returns a queue for the given queue name.
   *
406 407 408 409 410 411 412 413
   * The following values can be set in your settings.php file's $settings
   * array to define which services are used for queues:
   * - queue_reliable_service_$name: The container service to use for the
   *   reliable queue $name.
   * - queue_service_$name: The container service to use for the
   *   queue $name.
   * - queue_default: The container service to use by default for queues
   *   without overrides. This defaults to 'queue.database'.
414 415 416 417 418 419 420 421 422 423 424 425
   *
   * @param string $name
   *   The name of the queue to work with.
   * @param bool $reliable
   *   (optional) TRUE if the ordering of items and guaranteeing every item
   *   executes at least once is important, FALSE if scalability is the main
   *   concern. Defaults to FALSE.
   *
   * @return \Drupal\Core\Queue\QueueInterface
   *   The queue object for a given name.
   */
  public static function queue($name, $reliable = FALSE) {
426
    return static::getContainer()->get('queue')->get($name, $reliable);
427 428 429 430 431
  }

  /**
   * Returns a key/value storage collection.
   *
432
   * @param string $collection
433 434 435 436 437
   *   Name of the key/value collection to return.
   *
   * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  public static function keyValue($collection) {
438
    return static::getContainer()->get('keyvalue')->get($collection);
439 440 441 442 443 444 445 446 447
  }

  /**
   * Returns the state storage service.
   *
   * Use this to store machine-generated data, local to a specific environment
   * that does not need deploying and does not need human editing; for example,
   * the last time cron was run. Data which needs to be edited by humans and
   * needs to be the same across development, production, etc. environments
448
   * (for example, the system maintenance message) should use \Drupal::config() instead.
449
   *
450
   * @return \Drupal\Core\State\StateInterface
451 452
   */
  public static function state() {
453
    return static::getContainer()->get('state');
454 455 456 457 458
  }

  /**
   * Returns the default http client.
   *
459
   * @return \GuzzleHttp\Client
460 461 462
   *   A guzzle http client instance.
   */
  public static function httpClient() {
463
    return static::getContainer()->get('http_client');
464 465 466 467 468 469
  }

  /**
   * Returns the entity query object for this entity type.
   *
   * @param string $entity_type
470
   *   The entity type (for example, node) for which the query object should be
471 472
   *   returned.
   * @param string $conjunction
473 474
   *   (optional) Either 'AND' if all conditions in the query need to apply, or
   *   'OR' if any of them is sufficient. Defaults to 'AND'.
475 476 477 478 479
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The query object that can query the given entity type.
   */
  public static function entityQuery($entity_type, $conjunction = 'AND') {
480
    return static::entityTypeManager()->getStorage($entity_type)->getQuery($conjunction);
481 482
  }

483 484 485
  /**
   * Returns the entity query aggregate object for this entity type.
   *
486
   * @param string $entity_type
487
   *   The entity type (for example, node) for which the query object should be
488
   *   returned.
489
   * @param string $conjunction
490 491
   *   (optional) Either 'AND' if all conditions in the query need to apply, or
   *   'OR' if any of them is sufficient. Defaults to 'AND'.
492
   *
493
   * @return \Drupal\Core\Entity\Query\QueryAggregateInterface
494 495 496
   *   The query object that can query the given entity type.
   */
  public static function entityQueryAggregate($entity_type, $conjunction = 'AND') {
497
    return static::entityTypeManager()->getStorage($entity_type)->getAggregateQuery($conjunction);
498 499
  }

500 501 502 503 504 505
  /**
   * Returns the flood instance.
   *
   * @return \Drupal\Core\Flood\FloodInterface
   */
  public static function flood() {
506
    return static::getContainer()->get('flood');
507 508 509 510 511
  }

  /**
   * Returns the module handler.
   *
512
   * @return \Drupal\Core\Extension\ModuleHandlerInterface
513 514
   */
  public static function moduleHandler() {
515
    return static::getContainer()->get('module_handler');
516 517 518 519 520 521 522
  }

  /**
   * Returns the typed data manager service.
   *
   * Use the typed data manager service for creating typed data objects.
   *
523
   * @return \Drupal\Core\TypedData\TypedDataManagerInterface
524 525 526 527
   *   The typed data manager.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
528
  public static function typedDataManager() {
529
    return static::getContainer()->get('typed_data_manager');
530 531
  }

532 533 534 535 536 537 538
  /**
   * Returns the token service.
   *
   * @return \Drupal\Core\Utility\Token
   *   The token service.
   */
  public static function token() {
539
    return static::getContainer()->get('token');
540 541
  }

542 543 544
  /**
   * Returns the url generator service.
   *
545
   * @return \Drupal\Core\Routing\UrlGeneratorInterface
546 547 548
   *   The url generator service.
   */
  public static function urlGenerator() {
549
    return static::getContainer()->get('url_generator');
550 551
  }

552
  /**
553 554 555 556 557 558 559
   * Generates a URL string for a specific route based on the given parameters.
   *
   * This method is a convenience wrapper for generating URL strings for URLs
   * that have Drupal routes (that is, most pages generated by Drupal) using
   * the \Drupal\Core\Url object. See \Drupal\Core\Url::fromRoute() for
   * detailed documentation. For non-routed local URIs relative to
   * the base path (like robots.txt) use Url::fromUri()->toString() with the
560
   * base: scheme.
561
   *
562 563 564 565 566 567
   * @param string $route_name
   *   The name of the route.
   * @param array $route_parameters
   *   (optional) An associative array of parameter names and values.
   * @param array $options
   *   (optional) An associative array of additional options.
568
   * @param bool $collect_bubbleable_metadata
569
   *   (optional) Defaults to FALSE. When TRUE, both the generated URL and its
570
   *   associated bubbleable metadata are returned.
571
   *
572 573
   * @return string|\Drupal\Core\GeneratedUrl
   *   A string containing a URL to the given path.
574 575
   *   When $collect_bubbleable_metadata is TRUE, a GeneratedUrl object is
   *   returned, containing the generated URL plus bubbleable metadata.
576 577
   *
   * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()
578 579 580
   * @see \Drupal\Core\Url
   * @see \Drupal\Core\Url::fromRoute()
   * @see \Drupal\Core\Url::fromUri()
581 582 583 584
   *
   * @deprecated as of Drupal 8.0.x, will be removed before Drupal 9.0.0.
   *   Instead create a \Drupal\Core\Url object directly, for example using
   *   Url::fromRoute().
585
   */
586
  public static function url($route_name, $route_parameters = [], $options = [], $collect_bubbleable_metadata = FALSE) {
587
    return static::getContainer()->get('url_generator')->generateFromRoute($route_name, $route_parameters, $options, $collect_bubbleable_metadata);
588 589
  }

590 591 592 593 594 595
  /**
   * Returns the link generator service.
   *
   * @return \Drupal\Core\Utility\LinkGeneratorInterface
   */
  public static function linkGenerator() {
596
    return static::getContainer()->get('link_generator');
597 598 599
  }

  /**
600 601 602
   * Renders a link with a given link text and Url object.
   *
   * This method is a convenience wrapper for the link generator service's
603
   * generate() method.
604
   *
605 606 607 608 609
   * @param string $text
   *   The link text for the anchor tag.
   * @param \Drupal\Core\Url $url
   *   The URL object used for the link.
   *
610 611 612
   * @return \Drupal\Core\GeneratedLink
   *   A GeneratedLink object containing a link to the given route and
   *   parameters and bubbleable metadata.
613
   *
614
   * @see \Drupal\Core\Utility\LinkGeneratorInterface::generate()
615
   * @see \Drupal\Core\Url
616 617 618 619 620 621 622
   *
   * @deprecated in Drupal 8.0.0 and will be removed before Drupal 9.0.0.
   *   Use \Drupal\Core\Link instead.
   *   Example:
   *   @code
   *     $link = Link::fromTextAndUrl($text, $url);
   *   @endcode
623
   */
624 625
  public static function l($text, Url $url) {
    return static::getContainer()->get('link_generator')->generate($text, $url);
626 627
  }

628 629 630
  /**
   * Returns the string translation service.
   *
631
   * @return \Drupal\Core\StringTranslation\TranslationManager
632 633 634
   *   The string translation manager.
   */
  public static function translation() {
635
    return static::getContainer()->get('string_translation');
636 637
  }

638 639 640
  /**
   * Returns the language manager service.
   *
641
   * @return \Drupal\Core\Language\LanguageManagerInterface
642 643 644
   *   The language manager.
   */
  public static function languageManager() {
645
    return static::getContainer()->get('language_manager');
646 647
  }

648 649 650
  /**
   * Returns the CSRF token manager service.
   *
651 652 653 654 655
   * The generated token is based on the session ID of the current user. Normally,
   * anonymous users do not have a session, so the generated token will be
   * different on every page request. To generate a token for users without a
   * session, manually start a session prior to calling this function.
   *
656 657
   * @return \Drupal\Core\Access\CsrfTokenGenerator
   *   The CSRF token manager.
658
   *
659
   * @see \Drupal\Core\Session\SessionManager::start()
660 661
   */
  public static function csrfToken() {
662
    return static::getContainer()->get('csrf_token');
663 664
  }

665 666 667
  /**
   * Returns the transliteration service.
   *
668
   * @return \Drupal\Core\Transliteration\PhpTransliteration
669 670 671
   *   The transliteration manager.
   */
  public static function transliteration() {
672
    return static::getContainer()->get('transliteration');
673 674
  }

675 676 677 678 679 680 681
  /**
   * Returns the form builder service.
   *
   * @return \Drupal\Core\Form\FormBuilderInterface
   *   The form builder.
   */
  public static function formBuilder() {
682
    return static::getContainer()->get('form_builder');
683 684
  }

685 686 687 688 689 690
  /**
   * Gets the theme service.
   *
   * @return \Drupal\Core\Theme\ThemeManagerInterface
   */
  public static function theme() {
691
    return static::getContainer()->get('theme.manager');
692 693
  }

694 695 696 697 698 699
  /**
   * Gets the syncing state.
   *
   * @return bool
   *   Returns TRUE is syncing flag set.
   */
700
  public static function isConfigSyncing() {
701
    return static::getContainer()->get('config.installer')->isSyncing();
702 703
  }

704 705 706 707 708 709 710
  /**
   * Returns a channel logger object.
   *
   * @param string $channel
   *   The name of the channel. Can be any string, but the general practice is
   *   to use the name of the subsystem calling this.
   *
711
   * @return \Psr\Log\LoggerInterface
712 713 714
   *   The logger for this channel.
   */
  public static function logger($channel) {
715
    return static::getContainer()->get('logger.factory')->get($channel);
716 717
  }

718 719 720 721 722 723 724
  /**
   * Returns the menu tree.
   *
   * @return \Drupal\Core\Menu\MenuLinkTreeInterface
   *   The menu tree.
   */
  public static function menuTree() {
725
    return static::getContainer()->get('menu.link_tree');
726 727
  }

728 729 730 731 732 733
  /**
   * Returns the path validator.
   *
   * @return \Drupal\Core\Path\PathValidatorInterface
   */
  public static function pathValidator() {
734
    return static::getContainer()->get('path.validator');
735 736
  }

737 738 739 740 741 742 743
  /**
   * Returns the access manager service.
   *
   * @return \Drupal\Core\Access\AccessManagerInterface
   *   The access manager service.
   */
  public static function accessManager() {
744
    return static::getContainer()->get('access_manager');
745 746
  }

747 748 749 750 751 752 753 754 755 756
  /**
   * Returns the redirect destination helper.
   *
   * @return \Drupal\Core\Routing\RedirectDestinationInterface
   *   The redirect destination helper.
   */
  public static function destination() {
    return static::getContainer()->get('redirect.destination');
  }

757 758 759 760 761 762 763 764 765 766
  /**
   * Returns the entity definition update manager.
   *
   * @return \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
   *   The entity definition update manager.
   */
  public static function entityDefinitionUpdateManager() {
    return static::getContainer()->get('entity.definition_update_manager');
  }

767 768 769 770 771 772 773 774 775 776
  /**
   * Returns the time service.
   *
   * @return \Drupal\Component\Datetime\TimeInterface
   *   The time service.
   */
  public static function time() {
    return static::getContainer()->get('datetime.time');
  }

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791
  /**
   * Returns the messenger.
   *
   * @return \Drupal\Core\Messenger\MessengerInterface
   *   The messenger.
   */
  public static function messenger() {
    // @todo Replace with service once LegacyMessenger is removed in 9.0.0.
    // @see https://www.drupal.org/node/2928994
    if (!isset(static::$legacyMessenger)) {
      static::$legacyMessenger = new LegacyMessenger();
    }
    return static::$legacyMessenger;
  }

792
}