trait DeprecatedServicePropertyTrait

Provides a standard way to announce deprecated properties.

Hierarchy

9 files declare their use of DeprecatedServicePropertyTrait
AdminNegotiator.php in core/modules/user/src/Theme/AdminNegotiator.php
CommentLinkBuilder.php in core/modules/comment/src/CommentLinkBuilder.php
ComponentNegotiator.php in core/lib/Drupal/Core/Theme/ComponentNegotiator.php
DirectoryWithMetadataDiscovery.php in core/lib/Drupal/Core/Plugin/Discovery/DirectoryWithMetadataDiscovery.php
ExtensionMimeTypeGuesser.php in core/lib/Drupal/Core/File/MimeType/ExtensionMimeTypeGuesser.php

... See full list

File

View on git.drupalcode.org

core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php, line 8

Namespace

Drupal\Core\DependencyInjection
View source 
trait DeprecatedServicePropertyTrait {
  
  /**
   * Allows to access deprecated/removed properties.
   *
   * This method must be public.
   */
  public function __get(string $name) : mixed {
    if (!isset($this->deprecatedProperties)) {
      throw new \LogicException('The deprecatedProperties property must be defined to use this trait.');
    }
    if (isset($this->deprecatedProperties[$name])) {
      $service_name = $this->deprecatedProperties[$name];
      $class_name = static::class;
      // phpcs:ignore Drupal.Semantics.FunctionTriggerError
      @trigger_error("The property {$name} ({$service_name} service) is deprecated in {$class_name} and will be removed before Drupal 11.0.0.", E_USER_DEPRECATED);
      return \Drupal::service($service_name);
    }
    return NULL;
  }

}

Members

Title Modifiers Object type Summary
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.