You are here

Home » API reference » Commerce Core 8.2 » DeprecationSuppressionTrait.php

trait DeprecationSuppressionTrait in Commerce Core 8.2

Enables suppression of select deprecation messages during testing.

This trait creates a custom error handler able to suppress a specific set of deprecation errors, while allowing the rest to surface. It's useful to ignore certain errors temporarily, such as those from dependencies, or those whose fix has been intentionally postponed until a support is dropped for legacy drupal versions.

@package Drupal\Tests\commerce\Traits

Hierarchy

4 files declare their use of DeprecationSuppressionTrait
CommerceBrowserTestBase.php in tests/src/Functional/CommerceBrowserTestBase.php
CommerceKernelTestBase.php in tests/src/Kernel/CommerceKernelTestBase.php
CommerceWebDriverTestBase.php in tests/src/FunctionalJavascript/CommerceWebDriverTestBase.php
UninstallTest.php in tests/src/Functional/UninstallTest.php

File

tests/src/Traits/DeprecationSuppressionTrait.php, line 16

Namespace

Drupal\Tests\commerce\Traits
View source 
trait DeprecationSuppressionTrait {

  /**
   * Sets an error handler to suppress specified deprecation messages.
   */
  protected function setErrorHandler() {
    $previous_error_handler = set_error_handler(function ($severity, $message, $file, $line, $context = NULL) use (&$previous_error_handler) {
      $skipped_deprecations = [
        // @see https://www.drupal.org/project/address/issues/3089266
        'Theme functions are deprecated in drupal:8.0.0 and are removed from drupal:10.0.0. Use Twig templates instead of theme_inline_entity_form_entity_table(). See https://www.drupal.org/node/1831138',
      ];
      if (!in_array($message, $skipped_deprecations, TRUE)) {
        return $previous_error_handler($severity, $message, $file, $line, $context);
      }
    }, E_USER_DEPRECATED);
  }

  /**
   * Restores the original error handler.
   */
  protected function restoreErrorHandler() {
    restore_error_handler();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DeprecationSuppressionTrait::restoreErrorHandler protected function Restores the original error handler.
DeprecationSuppressionTrait::setErrorHandler protected function Sets an error handler to suppress specified deprecation messages.