DeprecatedServicePropertyTrait.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php
  2. 8.9.x core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php
  3. 10 core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php

Namespace

Drupal\Core\DependencyInjection

File

core/lib/Drupal/Core/DependencyInjection/DeprecatedServicePropertyTrait.php

View source
<?php

namespace Drupal\Core\DependencyInjection;


/**
 * Provides a standard way to announce deprecated properties.
 */
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;
  }

}

Traits

Title Deprecated Summary
DeprecatedServicePropertyTrait Provides a standard way to announce deprecated properties.

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