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

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

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

/**
 * 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
23 24
 * \Drupal\Core\CoreServiceProvider, the service providers of enabled modules and any other
 * service providers defined in $GLOBALS['conf']['container_service_providers'].
25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
 *
 * 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() {
41
 *     $lock = \Drupal::lock()->acquire('stuff_lock');
42 43 44 45 46 47
 *     // ...
 *   }
 *
 *   // The preferred way: dependency injected code.
 *   function hook_do_stuff() {
 *     // Move the actual implementation to a class and instantiate it.
48
 *     $instance = new StuffDoingClass(\Drupal::lock());
49 50 51 52 53 54
 *     $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.
55
 *     \Drupal::service('stuff.doing')->doStuff();
56 57 58 59 60 61 62 63 64
 *   }
 *
 *   interface StuffDoingInterface {
 *     public function doStuff();
 *   }
 *
 *   class StuffDoingClass implements StuffDoingInterface {
 *     protected $lockBackend;
 *
65 66
 *     public function __construct(LockBackendInterface $lock_backend) {
 *       $this->lockBackend = $lock_backend;
67 68 69 70 71 72 73 74 75 76 77 78 79
 *     }
 *
 *     public function doStuff() {
 *       $lock = $this->lockBackend->acquire('stuff_lock');
 *       // ...
 *     }
 *   }
 * @endcode
 *
 * @see \Drupal\Core\DrupalKernel
 */
class Drupal {

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

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

90 91 92 93 94
  /**
   * Core minimum schema version.
   */
  const CORE_MINIMUM_SCHEMA_VERSION = 8000;

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

  /**
   * Sets a new global container.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
106
   *   A new container instance to replace the current.
107
   */
108
  public static function setContainer(ContainerInterface $container) {
109 110 111
    static::$container = $container;
  }

112 113 114 115 116 117 118
  /**
   * Unsets the global container.
   */
  public static function unsetContainer() {
    static::$container = NULL;
  }

119 120 121
  /**
   * Returns the currently active global container.
   *
122
   * @return \Symfony\Component\DependencyInjection\ContainerInterface
123 124
   *
   * @throws \Drupal\Core\DependencyInjection\ContainerNotInitializedException
125 126
   */
  public static function getContainer() {
127 128 129
    if (static::$container === NULL) {
      throw new ContainerNotInitializedException('\Drupal::$container is not initialized yet. \Drupal::setContainer() must be called with a real container.');
    }
130 131 132
    return static::$container;
  }

133 134 135 136 137 138 139 140 141
  /**
   * Returns TRUE if the container has been initialized, FALSE otherwise.
   *
   * @return bool
   */
  public static function hasContainer() {
    return static::$container !== NULL;
  }

142 143 144 145 146 147 148 149 150
  /**
   * 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.
151
   *
152 153 154 155
   * @return mixed
   *   The specified service.
   */
  public static function service($id) {
156
    return static::getContainer()->get($id);
157 158
  }

159 160 161 162 163 164 165 166 167 168
  /**
   * 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) {
169 170
    // Check hasContainer() first in order to always return a Boolean.
    return static::hasContainer() && static::getContainer()->has($id);
171 172
  }

173 174 175 176 177 178
  /**
   * Gets the app root.
   *
   * @return string
   */
  public static function root() {
179
    return static::getContainer()->get('app.root');
180 181
  }

182 183 184 185 186 187 188 189 190 191
  /**
   * 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');
  }

192 193 194 195 196 197 198
  /**
   * 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() {
199 200
    // 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;
201 202
  }

203 204 205
  /**
   * Retrieves the currently active request object.
   *
206
   * Note: The use of this wrapper in particular is especially discouraged. Most
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225
   * 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() {
226
    return static::getContainer()->get('request_stack')->getCurrentRequest();
227 228
  }

229
  /**
230
   * Retrieves the request stack.
231 232 233 234 235
   *
   * @return \Symfony\Component\HttpFoundation\RequestStack
   *   The request stack
   */
  public static function requestStack() {
236
    return static::getContainer()->get('request_stack');
237 238
  }

239 240 241 242 243 244 245
  /**
   * Retrieves the currently active route match object.
   *
   * @return \Drupal\Core\Routing\RouteMatchInterface
   *   The currently active route match object.
   */
  public static function routeMatch() {
246
    return static::getContainer()->get('current_route_match');
247 248
  }

249 250 251
  /**
   * Gets the current active user.
   *
252 253 254 255 256 257 258
   * This method will return the \Drupal\Core\Session\AccountProxy object of the
   * current user. You can use the \Drupal\user\Entity\User::load() method to
   * load the full user entity object. For example:
   * @code
   *   $user = \Drupal\user\Entity\User::load(\Drupal::currentUser()->id());
   * @endcode
   *
259
   * @return \Drupal\Core\Session\AccountProxyInterface
260 261
   */
  public static function currentUser() {
262
    return static::getContainer()->get('current_user');
263 264
  }

265 266 267 268 269 270 271 272 273 274
  /**
   * 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');
  }

275 276 277 278 279 280 281
  /**
   * Returns the current primary database.
   *
   * @return \Drupal\Core\Database\Connection
   *   The current active database's master connection.
   */
  public static function database() {
282
    return static::getContainer()->get('database');
283 284
  }

285 286 287 288 289
  /**
   * Returns the requested cache bin.
   *
   * @param string $bin
   *   (optional) The cache bin for which the cache object should be returned,
290
   *   defaults to 'default'.
291
   *
292
   * @return \Drupal\Core\Cache\CacheBackendInterface
293
   *   The cache object associated with the specified bin.
294 295
   *
   * @ingroup cache
296
   */
297
  public static function cache($bin = 'default') {
298
    return static::getContainer()->get('cache.' . $bin);
299 300
  }

301 302 303 304 305 306 307 308 309 310
  /**
   * 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.
   *
311 312 313 314 315 316 317 318 319
   * @param string $class
   *   (optional) A class name to instantiate.
   *
   * @return \Drupal\Core\DependencyInjection\ClassResolverInterface|object
   *   The class resolver or if $class is provided, a class instance with a
   *   given class definition.
   *
   * @throws \InvalidArgumentException
   *   If $class does not exist.
320
   */
321 322 323 324
  public static function classResolver($class = NULL) {
    if ($class) {
      return static::getContainer()->get('class_resolver')->getInstanceFromDefinition($class);
    }
325 326 327
    return static::getContainer()->get('class_resolver');
  }

328 329 330 331 332 333 334 335 336 337
  /**
   * 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) {
338
    return static::getContainer()->get('keyvalue.expirable')->get($collection);
339 340
  }

341 342 343 344
  /**
   * Returns the locking layer instance.
   *
   * @return \Drupal\Core\Lock\LockBackendInterface
345 346
   *
   * @ingroup lock
347 348
   */
  public static function lock() {
349
    return static::getContainer()->get('lock');
350 351
  }

352 353 354 355
  /**
   * Retrieves a configuration object.
   *
   * This is the main entry point to the configuration API. Calling
356
   * @code \Drupal::config('book.admin') @endcode will return a configuration
357
   * object the Book module can use to read its administrative settings.
358 359
   *
   * @param string $name
360 361 362 363 364
   *   The name of the configuration object to retrieve, which typically
   *   corresponds to a configuration file. For
   *   @code \Drupal::config('book.admin') @endcode, the configuration
   *   object returned will contain the content of the book.admin
   *   configuration file.
365
   *
366 367
   * @return \Drupal\Core\Config\ImmutableConfig
   *   An immutable configuration object.
368 369
   */
  public static function config($name) {
370
    return static::getContainer()->get('config.factory')->get($name);
371 372
  }

373 374 375 376 377 378 379
  /**
   * 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.
   *
380
   * @return \Drupal\Core\Config\ConfigFactoryInterface
381
   *   The configuration factory service.
382 383
   */
  public static function configFactory() {
384
    return static::getContainer()->get('config.factory');
385 386
  }

387 388 389
  /**
   * Returns a queue for the given queue name.
   *
390 391 392 393 394 395 396 397
   * 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'.
398 399 400 401 402 403 404 405 406 407 408 409
   *
   * @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) {
410
    return static::getContainer()->get('queue')->get($name, $reliable);
411 412 413 414 415
  }

  /**
   * Returns a key/value storage collection.
   *
416
   * @param string $collection
417 418 419 420 421
   *   Name of the key/value collection to return.
   *
   * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  public static function keyValue($collection) {
422
    return static::getContainer()->get('keyvalue')->get($collection);
423 424 425 426 427 428 429 430 431
  }

  /**
   * 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
432
   * (for example, the system maintenance message) should use \Drupal::config() instead.
433
   *
434
   * @return \Drupal\Core\State\StateInterface
435 436
   */
  public static function state() {
437
    return static::getContainer()->get('state');
438 439 440 441 442
  }

  /**
   * Returns the default http client.
   *
443
   * @return \GuzzleHttp\Client
444 445 446
   *   A guzzle http client instance.
   */
  public static function httpClient() {
447
    return static::getContainer()->get('http_client');
448 449 450 451 452 453
  }

  /**
   * Returns the entity query object for this entity type.
   *
   * @param string $entity_type
454
   *   The entity type (for example, node) for which the query object should be
455 456
   *   returned.
   * @param string $conjunction
457 458
   *   (optional) Either 'AND' if all conditions in the query need to apply, or
   *   'OR' if any of them is sufficient. Defaults to 'AND'.
459 460 461 462 463
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The query object that can query the given entity type.
   */
  public static function entityQuery($entity_type, $conjunction = 'AND') {
464
    return static::entityTypeManager()->getStorage($entity_type)->getQuery($conjunction);
465 466
  }

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

484 485 486 487 488 489
  /**
   * Returns the flood instance.
   *
   * @return \Drupal\Core\Flood\FloodInterface
   */
  public static function flood() {
490
    return static::getContainer()->get('flood');
491 492 493 494 495
  }

  /**
   * Returns the module handler.
   *
496
   * @return \Drupal\Core\Extension\ModuleHandlerInterface
497 498
   */
  public static function moduleHandler() {
499
    return static::getContainer()->get('module_handler');
500 501 502 503 504 505 506
  }

  /**
   * Returns the typed data manager service.
   *
   * Use the typed data manager service for creating typed data objects.
   *
507
   * @return \Drupal\Core\TypedData\TypedDataManagerInterface
508 509 510 511
   *   The typed data manager.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
512
  public static function typedDataManager() {
513
    return static::getContainer()->get('typed_data_manager');
514 515
  }

516 517 518 519 520 521 522
  /**
   * Returns the token service.
   *
   * @return \Drupal\Core\Utility\Token
   *   The token service.
   */
  public static function token() {
523
    return static::getContainer()->get('token');
524 525
  }

526 527 528
  /**
   * Returns the url generator service.
   *
529
   * @return \Drupal\Core\Routing\UrlGeneratorInterface
530 531 532
   *   The url generator service.
   */
  public static function urlGenerator() {
533
    return static::getContainer()->get('url_generator');
534 535 536 537 538 539 540 541
  }

  /**
   * Returns the link generator service.
   *
   * @return \Drupal\Core\Utility\LinkGeneratorInterface
   */
  public static function linkGenerator() {
542
    return static::getContainer()->get('link_generator');
543 544
  }

545 546 547
  /**
   * Returns the string translation service.
   *
548
   * @return \Drupal\Core\StringTranslation\TranslationManager
549 550 551
   *   The string translation manager.
   */
  public static function translation() {
552
    return static::getContainer()->get('string_translation');
553 554
  }

555 556 557
  /**
   * Returns the language manager service.
   *
558
   * @return \Drupal\Core\Language\LanguageManagerInterface
559 560 561
   *   The language manager.
   */
  public static function languageManager() {
562
    return static::getContainer()->get('language_manager');
563 564
  }

565 566 567
  /**
   * Returns the CSRF token manager service.
   *
568 569 570 571 572
   * 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.
   *
573 574
   * @return \Drupal\Core\Access\CsrfTokenGenerator
   *   The CSRF token manager.
575
   *
576
   * @see \Drupal\Core\Session\SessionManager::start()
577 578
   */
  public static function csrfToken() {
579
    return static::getContainer()->get('csrf_token');
580 581
  }

582 583 584
  /**
   * Returns the transliteration service.
   *
585
   * @return \Drupal\Core\Transliteration\PhpTransliteration
586 587 588
   *   The transliteration manager.
   */
  public static function transliteration() {
589
    return static::getContainer()->get('transliteration');
590 591
  }

592 593 594 595 596 597 598
  /**
   * Returns the form builder service.
   *
   * @return \Drupal\Core\Form\FormBuilderInterface
   *   The form builder.
   */
  public static function formBuilder() {
599
    return static::getContainer()->get('form_builder');
600 601
  }

602 603 604 605 606 607
  /**
   * Gets the theme service.
   *
   * @return \Drupal\Core\Theme\ThemeManagerInterface
   */
  public static function theme() {
608
    return static::getContainer()->get('theme.manager');
609 610
  }

611 612 613 614 615 616
  /**
   * Gets the syncing state.
   *
   * @return bool
   *   Returns TRUE is syncing flag set.
   */
617
  public static function isConfigSyncing() {
618
    return static::getContainer()->get('config.installer')->isSyncing();
619 620
  }

621 622 623 624 625 626 627
  /**
   * 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.
   *
628
   * @return \Psr\Log\LoggerInterface
629 630 631
   *   The logger for this channel.
   */
  public static function logger($channel) {
632
    return static::getContainer()->get('logger.factory')->get($channel);
633 634
  }

635 636 637 638 639 640 641
  /**
   * Returns the menu tree.
   *
   * @return \Drupal\Core\Menu\MenuLinkTreeInterface
   *   The menu tree.
   */
  public static function menuTree() {
642
    return static::getContainer()->get('menu.link_tree');
643 644
  }

645 646 647 648 649 650
  /**
   * Returns the path validator.
   *
   * @return \Drupal\Core\Path\PathValidatorInterface
   */
  public static function pathValidator() {
651
    return static::getContainer()->get('path.validator');
652 653
  }

654 655 656 657 658 659 660
  /**
   * Returns the access manager service.
   *
   * @return \Drupal\Core\Access\AccessManagerInterface
   *   The access manager service.
   */
  public static function accessManager() {
661
    return static::getContainer()->get('access_manager');
662 663
  }

664 665 666 667 668 669 670 671 672 673
  /**
   * Returns the redirect destination helper.
   *
   * @return \Drupal\Core\Routing\RedirectDestinationInterface
   *   The redirect destination helper.
   */
  public static function destination() {
    return static::getContainer()->get('redirect.destination');
  }

674 675 676 677 678 679 680 681 682 683
  /**
   * 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');
  }

684 685 686 687 688 689 690 691 692 693
  /**
   * Returns the time service.
   *
   * @return \Drupal\Component\Datetime\TimeInterface
   *   The time service.
   */
  public static function time() {
    return static::getContainer()->get('datetime.time');
  }

694 695 696 697 698 699 700
  /**
   * Returns the messenger.
   *
   * @return \Drupal\Core\Messenger\MessengerInterface
   *   The messenger.
   */
  public static function messenger() {
701
    return static::getContainer()->get('messenger');
702 703
  }

704
}