Drupal.php 20.5 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Contains Drupal.
 */

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

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

81 82 83
  /**
   * The current system version.
   */
catch's avatar
catch committed
84
  const VERSION = '8.0.0-beta10';
85 86 87 88 89 90

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

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

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

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

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

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

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


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

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

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

183 184 185 186 187 188 189
  /**
   * 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() {
190 191
    // 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;
192 193
  }

194 195 196
  /**
   * Retrieves the currently active request object.
   *
197
   * Note: The use of this wrapper in particular is especially discouraged. Most
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
   * 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() {
217
    return static::getContainer()->get('request_stack')->getCurrentRequest();
218 219
  }

220 221 222 223 224 225 226
  /**
   * Retrives the request stack.
   *
   * @return \Symfony\Component\HttpFoundation\RequestStack
   *   The request stack
   */
  public static function requestStack() {
227
    return static::getContainer()->get('request_stack');
228 229
  }

230 231 232 233 234 235 236
  /**
   * Retrieves the currently active route match object.
   *
   * @return \Drupal\Core\Routing\RouteMatchInterface
   *   The currently active route match object.
   */
  public static function routeMatch() {
237
    return static::getContainer()->get('current_route_match');
238 239
  }

240 241 242
  /**
   * Gets the current active user.
   *
243
   * @return \Drupal\Core\Session\AccountProxyInterface
244 245
   */
  public static function currentUser() {
246
    return static::getContainer()->get('current_user');
247 248
  }

249 250 251
  /**
   * Retrieves the entity manager service.
   *
252
   * @return \Drupal\Core\Entity\EntityManagerInterface
253 254 255
   *   The entity manager service.
   */
  public static function entityManager() {
256
    return static::getContainer()->get('entity.manager');
257 258
  }

259 260 261 262 263 264 265
  /**
   * Returns the current primary database.
   *
   * @return \Drupal\Core\Database\Connection
   *   The current active database's master connection.
   */
  public static function database() {
266
    return static::getContainer()->get('database');
267 268
  }

269 270 271 272 273
  /**
   * Returns the requested cache bin.
   *
   * @param string $bin
   *   (optional) The cache bin for which the cache object should be returned,
274
   *   defaults to 'default'.
275
   *
276
   * @return \Drupal\Core\Cache\CacheBackendInterface
277
   *   The cache object associated with the specified bin.
278 279
   *
   * @ingroup cache
280
   */
281
  public static function cache($bin = 'default') {
282
    return static::getContainer()->get('cache.' . $bin);
283 284
  }

285 286 287 288 289 290 291 292 293 294
  /**
   * 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) {
295
    return static::getContainer()->get('keyvalue.expirable')->get($collection);
296 297
  }

298 299 300 301
  /**
   * Returns the locking layer instance.
   *
   * @return \Drupal\Core\Lock\LockBackendInterface
302 303
   *
   * @ingroup lock
304 305
   */
  public static function lock() {
306
    return static::getContainer()->get('lock');
307 308
  }

309 310 311 312
  /**
   * Retrieves a configuration object.
   *
   * This is the main entry point to the configuration API. Calling
313
   * @code \Drupal::config('book.admin') @endcode will return a configuration
314 315 316 317
   * 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
318
   *   a configuration file. For @code \Drupal::config('book.admin') @endcode, the config
319 320
   *   object returned will contain the contents of book.admin configuration file.
   *
321 322
   * @return \Drupal\Core\Config\ImmutableConfig
   *   An immutable configuration object.
323 324
   */
  public static function config($name) {
325
    return static::getContainer()->get('config.factory')->get($name);
326 327
  }

328 329 330 331 332 333 334
  /**
   * 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.
   *
335
   * @return \Drupal\Core\Config\ConfigFactoryInterface
336
   *   The configuration factory service.
337 338
   */
  public static function configFactory() {
339
    return static::getContainer()->get('config.factory');
340 341
  }

342 343 344
  /**
   * Returns a queue for the given queue name.
   *
345 346 347 348 349 350 351 352
   * 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'.
353 354 355 356 357 358 359 360 361 362 363 364
   *
   * @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) {
365
    return static::getContainer()->get('queue')->get($name, $reliable);
366 367 368 369 370
  }

  /**
   * Returns a key/value storage collection.
   *
371
   * @param string $collection
372 373 374 375 376
   *   Name of the key/value collection to return.
   *
   * @return \Drupal\Core\KeyValueStore\KeyValueStoreInterface
   */
  public static function keyValue($collection) {
377
    return static::getContainer()->get('keyvalue')->get($collection);
378 379 380 381 382 383 384 385 386
  }

  /**
   * 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
387
   * (for example, the system maintenance message) should use \Drupal::config() instead.
388
   *
389
   * @return \Drupal\Core\State\StateInterface
390 391
   */
  public static function state() {
392
    return static::getContainer()->get('state');
393 394 395 396 397
  }

  /**
   * Returns the default http client.
   *
398
   * @return \GuzzleHttp\ClientInterface
399 400 401
   *   A guzzle http client instance.
   */
  public static function httpClient() {
402
    return static::getContainer()->get('http_client');
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418
  }

  /**
   * Returns the entity query object for this entity type.
   *
   * @param string $entity_type
   *   The entity type, e.g. node, for which the query object should be
   *   returned.
   * @param string $conjunction
   *   AND if all conditions in the query need to apply, OR if any of them is
   *   enough. Optional, defaults to AND.
   *
   * @return \Drupal\Core\Entity\Query\QueryInterface
   *   The query object that can query the given entity type.
   */
  public static function entityQuery($entity_type, $conjunction = 'AND') {
419
    return static::getContainer()->get('entity.query')->get($entity_type, $conjunction);
420 421
  }

422 423 424
  /**
   * Returns the entity query aggregate object for this entity type.
   *
425
   * @param string $entity_type
426 427
   *   The entity type, e.g. node, for which the query object should be
   *   returned.
428
   * @param string $conjunction
429 430 431
   *   AND if all conditions in the query need to apply, OR if any of them is
   *   enough. Optional, defaults to AND.
   *
432
   * @return \Drupal\Core\Entity\Query\QueryAggregateInterface
433 434 435
   *   The query object that can query the given entity type.
   */
  public static function entityQueryAggregate($entity_type, $conjunction = 'AND') {
436
    return static::getContainer()->get('entity.query')->getAggregate($entity_type, $conjunction);
437 438
  }

439 440 441 442 443 444
  /**
   * Returns the flood instance.
   *
   * @return \Drupal\Core\Flood\FloodInterface
   */
  public static function flood() {
445
    return static::getContainer()->get('flood');
446 447 448 449 450
  }

  /**
   * Returns the module handler.
   *
451
   * @return \Drupal\Core\Extension\ModuleHandlerInterface
452 453
   */
  public static function moduleHandler() {
454
    return static::getContainer()->get('module_handler');
455 456 457 458 459 460 461 462 463 464 465 466
  }

  /**
   * Returns the typed data manager service.
   *
   * Use the typed data manager service for creating typed data objects.
   *
   * @return \Drupal\Core\TypedData\TypedDataManager
   *   The typed data manager.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
467
  public static function typedDataManager() {
468
    return static::getContainer()->get('typed_data_manager');
469 470
  }

471 472 473 474 475 476 477
  /**
   * Returns the token service.
   *
   * @return \Drupal\Core\Utility\Token
   *   The token service.
   */
  public static function token() {
478
    return static::getContainer()->get('token');
479 480
  }

481 482 483
  /**
   * Returns the url generator service.
   *
484
   * @return \Drupal\Core\Routing\UrlGeneratorInterface
485 486 487
   *   The url generator service.
   */
  public static function urlGenerator() {
488
    return static::getContainer()->get('url_generator');
489 490
  }

491
  /**
492 493 494 495 496 497 498
   * 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
499
   * base: scheme.
500
   *
501 502 503 504 505 506 507 508 509 510 511
   * @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.
   *
   * @return string
   *   The generated URL for the given route.
   *
   * @see \Drupal\Core\Routing\UrlGeneratorInterface::generateFromRoute()
512 513 514
   * @see \Drupal\Core\Url
   * @see \Drupal\Core\Url::fromRoute()
   * @see \Drupal\Core\Url::fromUri()
515
   */
516
  public static function url($route_name, $route_parameters = array(), $options = array()) {
517
    return static::getContainer()->get('url_generator')->generateFromRoute($route_name, $route_parameters, $options);
518 519
  }

520 521 522 523 524 525
  /**
   * Returns the link generator service.
   *
   * @return \Drupal\Core\Utility\LinkGeneratorInterface
   */
  public static function linkGenerator() {
526
    return static::getContainer()->get('link_generator');
527 528 529
  }

  /**
530 531 532 533 534 535
   * Renders a link with a given link text and Url object.
   *
   * This method is a convenience wrapper for the link generator service's
   * generate() method. For detailed documentation, see
   * \Drupal\Core\Routing\LinkGeneratorInterface::generate().
   *
536 537 538 539 540 541 542 543
   * @param string $text
   *   The link text for the anchor tag.
   * @param \Drupal\Core\Url $url
   *   The URL object used for the link.
   *
   * @return string
   *   An HTML string containing a link to the given route and parameters.
   *
544
   * @see \Drupal\Core\Utility\LinkGeneratorInterface::generate()
545
   * @see \Drupal\Core\Url
546
   */
547
  public static function l($text, Url $url) {
548
    return static::getContainer()->get('link_generator')->generate($text, $url);
549 550
  }

551 552 553
  /**
   * Returns the string translation service.
   *
554
   * @return \Drupal\Core\StringTranslation\TranslationManager
555 556 557
   *   The string translation manager.
   */
  public static function translation() {
558
    return static::getContainer()->get('string_translation');
559 560
  }

561 562 563
  /**
   * Returns the language manager service.
   *
564
   * @return \Drupal\Core\Language\LanguageManagerInterface
565 566 567
   *   The language manager.
   */
  public static function languageManager() {
568
    return static::getContainer()->get('language_manager');
569 570
  }

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

588 589 590
  /**
   * Returns the transliteration service.
   *
591
   * @return \Drupal\Core\Transliteration\PhpTransliteration
592 593 594
   *   The transliteration manager.
   */
  public static function transliteration() {
595
    return static::getContainer()->get('transliteration');
596 597
  }

598 599 600 601 602 603 604
  /**
   * Returns the form builder service.
   *
   * @return \Drupal\Core\Form\FormBuilderInterface
   *   The form builder.
   */
  public static function formBuilder() {
605
    return static::getContainer()->get('form_builder');
606 607
  }

608 609 610 611 612 613
  /**
   * Gets the theme service.
   *
   * @return \Drupal\Core\Theme\ThemeManagerInterface
   */
  public static function theme() {
614
    return static::getContainer()->get('theme.manager');
615 616
  }

617 618 619 620 621 622
  /**
   * Gets the syncing state.
   *
   * @return bool
   *   Returns TRUE is syncing flag set.
   */
623
  public static function isConfigSyncing() {
624
    return static::getContainer()->get('config.installer')->isSyncing();
625 626
  }

627 628 629 630 631 632 633
  /**
   * 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.
   *
634
   * @return \Psr\Log\LoggerInterface
635 636 637
   *   The logger for this channel.
   */
  public static function logger($channel) {
638
    return static::getContainer()->get('logger.factory')->get($channel);
639 640
  }

641 642 643 644 645 646 647
  /**
   * Returns the menu tree.
   *
   * @return \Drupal\Core\Menu\MenuLinkTreeInterface
   *   The menu tree.
   */
  public static function menuTree() {
648
    return static::getContainer()->get('menu.link_tree');
649 650
  }

651 652 653 654 655 656
  /**
   * Returns the path validator.
   *
   * @return \Drupal\Core\Path\PathValidatorInterface
   */
  public static function pathValidator() {
657
    return static::getContainer()->get('path.validator');
658 659
  }

660 661 662 663 664 665 666
  /**
   * Returns the access manager service.
   *
   * @return \Drupal\Core\Access\AccessManagerInterface
   *   The access manager service.
   */
  public static function accessManager() {
667
    return static::getContainer()->get('access_manager');
668 669
  }

670 671 672 673 674 675 676 677 678 679
  /**
   * Returns the redirect destination helper.
   *
   * @return \Drupal\Core\Routing\RedirectDestinationInterface
   *   The redirect destination helper.
   */
  public static function destination() {
    return static::getContainer()->get('redirect.destination');
  }

680
}