API Rename Deprecation::withNoReplacement (#11390)

silverstripe · Sep 18, 2024 · 6287b6e · 6287b6e
1 parent c7ba8d1
commit 6287b6e
Show file tree

Hide file tree

Showing 34 changed files with 89 additions and 79 deletions.
diff --git a/src/Control/Middleware/ConfirmationMiddleware/CliBypass.php b/src/Control/Middleware/ConfirmationMiddleware/CliBypass.php
@@ -16,7 +16,7 @@ class CliBypass implements Bypass
 {
     public function __construct()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be removed without equivalent functionality to replace it',

diff --git a/src/Core/CoreKernel.php b/src/Core/CoreKernel.php
@@ -71,7 +71,7 @@ protected function validateDatabase()
             $msg = 'Silverstripe Framework requires a "database" key in DB::getConfig(). ' .
                 'Did you forget to set SS_DATABASE_NAME or SS_DATABASE_CHOOSE_NAME in your environment?';
             $this->detectLegacyEnvironment();
-            Deprecation::withNoReplacement(fn() => $this->redirectToInstaller($msg));
+            Deprecation::withSuppressedNotice(fn() => $this->redirectToInstaller($msg));
         }
     }
 

diff --git a/src/Dev/BuildTask.php b/src/Dev/BuildTask.php
@@ -96,7 +96,7 @@ public function getTitle()
      */
     public function getDescription()
     {
-        Deprecation::withNoReplacement(
+        Deprecation::withSuppressedNotice(
             fn() => Deprecation::notice('5.4.0', 'Will be replaced with a static method with the same name')
         );
         return $this->description;

diff --git a/src/Dev/Deprecation.php b/src/Dev/Deprecation.php
@@ -53,7 +53,7 @@ class Deprecation
     /**
      * @internal
      */
-    private static bool $insideWithNoReplacement = false;
+    private static bool $insideNoticeSuppression = false;
 
     /**
      * @internal
@@ -103,22 +103,32 @@ public static function disable(): void
     }
 
     /**
-     * Used to wrap deprecated methods and deprecated config get()/set() that will be removed
-     * in the next major version with no replacement. This is done to surpress deprecation notices
-     * by for calls from the vendor dir to deprecated code that projects have no ability to change
+     * Used to wrap deprecated methods and deprecated config get()/set() called from the vendor
+     * dir that projects have no ability to change.
      *
      * @return mixed
+     * @deprecated 5.4.0 Use withSuppressedNotice() instead
      */
     public static function withNoReplacement(callable $func)
     {
-        if (Deprecation::$insideWithNoReplacement) {
+        Deprecation::notice('5.4.0', 'Use withSuppressedNotice() instead');
+        return Deprecation::withSuppressedNotice($func);
+    }
+
+    /**
+     * Used to wrap deprecated methods and deprecated config get()/set() called from the vendor
+     * dir that projects have no ability to change.
+     */
+    public static function withSuppressedNotice(callable $func): mixed
+    {
+        if (Deprecation::$insideNoticeSuppression) {
             return $func();
         }
-        Deprecation::$insideWithNoReplacement = true;
+        Deprecation::$insideNoticeSuppression = true;
         try {
             return $func();
         } finally {
-            Deprecation::$insideWithNoReplacement = false;
+            Deprecation::$insideNoticeSuppression = false;
         }
     }
 
@@ -137,8 +147,8 @@ protected static function get_called_method_from_trace($backtrace, $level = 1)
             $level = 1;
         }
         $newLevel = $level;
-        // handle closures inside withNoReplacement()
-        if (Deprecation::$insideWithNoReplacement
+        // handle closures inside withSuppressedNotice()
+        if (Deprecation::$insideNoticeSuppression
             && substr($backtrace[$newLevel]['function'], -strlen('{closure}')) === '{closure}'
         ) {
             $newLevel = $newLevel + 2;
@@ -247,8 +257,8 @@ public static function outputNotices(): void
             $count++;
             $arr = array_shift(Deprecation::$userErrorMessageBuffer);
             $message = $arr['message'];
-            $calledInsideWithNoReplacement = $arr['calledInsideWithNoReplacement'];
-            if ($calledInsideWithNoReplacement && !Deprecation::$showNoReplacementNotices) {
+            $calledWithNoticeSuppression = $arr['calledWithNoticeSuppression'];
+            if ($calledWithNoticeSuppression && !Deprecation::$showNoReplacementNotices) {
                 continue;
             }
             Deprecation::$isTriggeringError = true;
@@ -284,7 +294,7 @@ public static function notice($atVersion, $string = '', $scope = Deprecation::SC
                 $data = [
                     'key' => sha1($string),
                     'message' => $string,
-                    'calledInsideWithNoReplacement' => Deprecation::$insideWithNoReplacement
+                    'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
                 ];
             } else {
                 if (!Deprecation::isEnabled()) {
@@ -310,7 +320,7 @@ public static function notice($atVersion, $string = '', $scope = Deprecation::SC
                     $string .= ".";
                 }
 
-                $level = Deprecation::$insideWithNoReplacement ? 4 : 2;
+                $level = Deprecation::$insideNoticeSuppression ? 4 : 2;
                 $string .= " Called from " . Deprecation::get_called_method_from_trace($backtrace, $level) . '.';
 
                 if ($caller) {
@@ -319,7 +329,7 @@ public static function notice($atVersion, $string = '', $scope = Deprecation::SC
                 $data = [
                     'key' => sha1($string),
                     'message' => $string,
-                    'calledInsideWithNoReplacement' => Deprecation::$insideWithNoReplacement
+                    'calledWithNoticeSuppression' => Deprecation::$insideNoticeSuppression
                 ];
             }
             if ($data && !array_key_exists($data['key'], Deprecation::$userErrorMessageBuffer)) {

diff --git a/src/Dev/DevBuildController.php b/src/Dev/DevBuildController.php
@@ -34,7 +34,7 @@ class DevBuildController extends Controller implements PermissionProvider
     public function __construct()
     {
         parent::__construct();
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\DbBuild',

diff --git a/src/Dev/DevConfigController.php b/src/Dev/DevConfigController.php
@@ -47,7 +47,7 @@ class DevConfigController extends Controller implements PermissionProvider
     public function __construct()
     {
         parent::__construct();
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\ConfigDump',

diff --git a/src/Dev/DevelopmentAdmin.php b/src/Dev/DevelopmentAdmin.php
@@ -233,7 +233,7 @@ protected function getRegisteredController($baseUrlPart)
      */
     public function buildDefaults()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\DbDefaults'
@@ -266,7 +266,7 @@ public function buildDefaults()
      */
     public function generatesecuretoken()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\GenerateSecureToken'

diff --git a/src/Dev/SSListExporter.php b/src/Dev/SSListExporter.php
@@ -21,7 +21,7 @@ class SSListExporter extends Exporter implements TestOnly
 {
     public function __construct()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be removed without equivalent functionality to replace it',

diff --git a/src/Dev/Tasks/CleanupTestDatabasesTask.php b/src/Dev/Tasks/CleanupTestDatabasesTask.php
@@ -36,7 +36,7 @@ public function run($request)
 
     public function canView(): bool
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with canRunInBrowser()'

diff --git a/src/Forms/GridField/GridFieldConfig_Base.php b/src/Forms/GridField/GridFieldConfig_Base.php
@@ -25,7 +25,7 @@ public function __construct($itemsPerPage = null)
         $this->addComponent(GridFieldPageCount::create('toolbar-header-right'));
         $this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
 
-        Deprecation::withNoReplacement(function () use ($sort, $filter, $pagination) {
+        Deprecation::withSuppressedNotice(function () use ($sort, $filter, $pagination) {
             $sort->setThrowExceptionOnBadDataType(false);
             $filter->setThrowExceptionOnBadDataType(false);
             $pagination->setThrowExceptionOnBadDataType(false);

diff --git a/src/Forms/GridField/GridFieldConfig_RecordEditor.php b/src/Forms/GridField/GridFieldConfig_RecordEditor.php
@@ -32,7 +32,7 @@ public function __construct($itemsPerPage = null, $showPagination = null, $showA
         $this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
         $this->addComponent(GridFieldDetailForm::create(null, $showPagination, $showAdd));
 
-        Deprecation::withNoReplacement(function () use ($sort, $filter, $pagination) {
+        Deprecation::withSuppressedNotice(function () use ($sort, $filter, $pagination) {
             $sort->setThrowExceptionOnBadDataType(false);
             $filter->setThrowExceptionOnBadDataType(false);
             $pagination->setThrowExceptionOnBadDataType(false);

diff --git a/src/Forms/GridField/GridFieldConfig_RelationEditor.php b/src/Forms/GridField/GridFieldConfig_RelationEditor.php
@@ -45,7 +45,7 @@ public function __construct($itemsPerPage = null)
         $this->addComponent($pagination = GridFieldPaginator::create($itemsPerPage));
         $this->addComponent(GridFieldDetailForm::create());
 
-        Deprecation::withNoReplacement(function () use ($sort, $filter, $pagination) {
+        Deprecation::withSuppressedNotice(function () use ($sort, $filter, $pagination) {
             $sort->setThrowExceptionOnBadDataType(false);
             $filter->setThrowExceptionOnBadDataType(false);
             $pagination->setThrowExceptionOnBadDataType(false);

diff --git a/src/Logging/HTTPOutputHandler.php b/src/Logging/HTTPOutputHandler.php
@@ -37,7 +37,7 @@ class HTTPOutputHandler extends AbstractProcessingHandler
     public function __construct()
     {
         parent::__construct();
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be renamed to ErrorOutputHandler',

diff --git a/src/ORM/ArrayLib.php b/src/ORM/ArrayLib.php
@@ -14,7 +14,7 @@ class ArrayLib
 {
     public function __construct()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib', Deprecation::SCOPE_CLASS);
         });
     }
@@ -58,7 +58,7 @@ public function __construct()
      */
     public static function invert($arr)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::invert()');
         });
 
@@ -86,7 +86,7 @@ public static function invert($arr)
      */
     public static function valuekey($arr)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::valuekey()');
         });
 
@@ -102,7 +102,7 @@ public static function valuekey($arr)
      */
     public static function array_values_recursive($array)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::invearray_values_recursivert()');
         });
 
@@ -121,7 +121,7 @@ public static function array_values_recursive($array)
      */
     public static function filter_keys($arr, $keys)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::filter_keys()');
         });
 
@@ -147,7 +147,7 @@ public static function filter_keys($arr, $keys)
      */
     public static function is_associative($array)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::is_associative()');
         });
 
@@ -173,7 +173,7 @@ public static function is_associative($array)
      */
     public static function in_array_recursive($needle, $haystack, $strict = false)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::in_array_recursive()');
         });
 
@@ -206,7 +206,7 @@ public static function in_array_recursive($needle, $haystack, $strict = false)
      */
     public static function array_map_recursive($f, $array)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::array_map_recursive()');
         });
 
@@ -232,7 +232,7 @@ public static function array_map_recursive($f, $array)
      */
     public static function array_merge_recursive($array)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::array_merge_recursive()');
         });
 
@@ -282,7 +282,7 @@ public static function array_merge_recursive($array)
      */
     public static function flatten($array, $preserveKeys = true, &$out = [])
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::flatten()');
         });
 
@@ -314,7 +314,7 @@ function ($value, $key) use (&$out, $preserveKeys) {
      */
     public static function iterateVolatile(array &$list)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::iterateVolatile()');
         });
 
@@ -341,7 +341,7 @@ public static function iterateVolatile(array &$list)
      */
     public static function shuffleAssociative(array &$array): void
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Core\ArrayLib::shuffleAssociative()');
         });
 

diff --git a/src/ORM/ArrayList.php b/src/ORM/ArrayList.php
@@ -61,7 +61,7 @@ class ArrayList extends ViewableData implements SS_List, Filterable, Sortable, L
      */
     public function __construct(array $items = [])
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Model\List\ArrayList', Deprecation::SCOPE_CLASS);
         });
 
@@ -731,7 +731,7 @@ protected function filterOrExclude(array $filters, bool $inclusive = true, bool
 
             // Apply default case sensitivity for backwards compatability
             if (!str_contains($filterKey, ':case') && !str_contains($filterKey, ':nocase')) {
-                $caseSensitive = Deprecation::withNoReplacement(fn() => static::config()->get('default_case_sensitive'));
+                $caseSensitive = Deprecation::withSuppressedNotice(fn() => static::config()->get('default_case_sensitive'));
                 if ($caseSensitive && in_array('case', $searchFilter->getSupportedModifiers())) {
                     $searchFilter->setModifiers($searchFilter->getModifiers() + ['case']);
                 } elseif (!$caseSensitive && in_array('nocase', $searchFilter->getSupportedModifiers())) {

diff --git a/src/ORM/DataExtension.php b/src/ORM/DataExtension.php
@@ -22,10 +22,10 @@ abstract class DataExtension extends Extension
 {
     public function __construct()
     {
-        // Wrapping with Deprecation::withNoReplacement() to avoid triggering deprecation notices
+        // Wrapping with Deprecation::withSuppressedNotice() to avoid triggering deprecation notices
         // as we are unable to update existing subclasses of this class until a new major
         // unless we add in the pointless empty methods that are in this class
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             $class = Extension::class;
             Deprecation::notice('5.3.0', "Subclass $class instead", Deprecation::SCOPE_CLASS);
         });

diff --git a/src/ORM/DataObject.php b/src/ORM/DataObject.php
@@ -1986,7 +1986,7 @@ public function getComponents($componentName, $id = null)
         if ($details['polymorphic']) {
             $result = PolymorphicHasManyList::create($componentClass, $details['joinField'], static::class);
             if ($details['needsRelation']) {
-                Deprecation::withNoReplacement(fn () => $result->setForeignRelation($componentName));
+                Deprecation::withSuppressedNotice(fn () => $result->setForeignRelation($componentName));
             }
         } else {
             $result = HasManyList::create($componentClass, $details['joinField']);

diff --git a/src/ORM/DatabaseAdmin.php b/src/ORM/DatabaseAdmin.php
@@ -67,7 +67,7 @@ class DatabaseAdmin extends Controller
     public function __construct()
     {
         parent::__construct();
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\DbBuild',
@@ -213,7 +213,7 @@ public function buildDefaults()
      */
     public static function lastBuilt()
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice(
                 '5.4.0',
                 'Will be replaced with SilverStripe\Dev\Command\DbBuild::lastBuilt()'

diff --git a/src/ORM/GroupedList.php b/src/ORM/GroupedList.php
@@ -19,7 +19,7 @@ class GroupedList extends ListDecorator
 
     public function __construct(SS_List&Sortable&Filterable&Limitable $list)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Model\List\GroupedList', Deprecation::SCOPE_CLASS);
         });
         parent::__construct($list);

diff --git a/src/ORM/ListDecorator.php b/src/ORM/ListDecorator.php
@@ -32,7 +32,7 @@ abstract class ListDecorator extends ViewableData implements SS_List, Sortable,
      */
     public function __construct(SS_List&Sortable&Filterable&Limitable $list)
     {
-        Deprecation::withNoReplacement(function () {
+        Deprecation::withSuppressedNotice(function () {
             Deprecation::notice('5.4.0', 'Will be renamed to SilverStripe\Model\List\ListDecorator', Deprecation::SCOPE_CLASS);
         });