Deprecate Plugin::unload()

I missed this earlier when working on new Plugins. This method should go away along with `Plugin::load()`. Refs #12682
cakephp · Oct 29, 2018 · 835a255 · 835a255
1 parent 3f46964
commit 835a255
Show file tree

Hide file tree

Showing 59 changed files with 104 additions and 89 deletions.
diff --git a/src/Core/Plugin.php b/src/Core/Plugin.php
@@ -381,12 +381,14 @@ public static function loaded($plugin = null)
      * Forgets a loaded plugin or all of them if first parameter is null
      *
      * @param string|null $plugin name of the plugin to forget
+     * @deprecated 3.7 This method will be removed in 4.0.0. Use PluginCollection::remove() or clear() instead.
      * @return void
      */
     public static function unload($plugin = null)
     {
+        deprecationWarning('Plugin::unload() will be removed in 4.0. Use PluginCollection::remove() or clear()');
         if ($plugin === null) {
-            static::$plugins = null;
+            static::getCollection()->clear();
         } else {
             static::getCollection()->remove($plugin);
         }

diff --git a/src/Core/PluginCollection.php b/src/Core/PluginCollection.php
@@ -158,6 +158,18 @@ public function remove($name)
         return $this;
     }
 
+    /**
+     * Remove all plugins from the collection
+     *
+     * @return $this
+     */
+    public function clear()
+    {
+        $this->plugins = [];
+
+        return $this;
+    }
+
     /**
      * Check whether the named plugin exists in the collection.
      *

diff --git a/tests/TestCase/Auth/FormAuthenticateTest.php b/tests/TestCase/Auth/FormAuthenticateTest.php
@@ -298,7 +298,6 @@ public function testPluginModel()
             'updated' => new Time('2007-03-17 01:18:31')
         ];
         $this->assertEquals($expected, $result);
-        Plugin::unload();
     }
 
     /**

diff --git a/tests/TestCase/Auth/PasswordHasherFactoryTest.php b/tests/TestCase/Auth/PasswordHasherFactoryTest.php
@@ -44,7 +44,7 @@ public function testBuild()
         $this->loadPlugins(['TestPlugin']);
         $hasher = PasswordHasherFactory::build('TestPlugin.Legacy');
         $this->assertInstanceof('TestPlugin\Auth\LegacyPasswordHasher', $hasher);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Cache/CacheTest.php b/tests/TestCase/Cache/CacheTest.php
@@ -315,7 +315,7 @@ public function testConfigWithLibAndPluginEngines()
         Cache::drop('libEngine');
         Cache::drop('pluginLibEngine');
 
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Command/HelpCommandTest.php b/tests/TestCase/Command/HelpCommandTest.php
@@ -34,7 +34,7 @@ public function setUp()
         parent::setUp();
         $this->setAppNamespace();
         $this->useCommandRunner(true);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         $app = $this->getMockForAbstractClass(
             BaseApplication::class,
             ['']
@@ -50,7 +50,7 @@ public function setUp()
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -63,7 +63,7 @@ public function testMainNoCommandsFallback()
         $this->exec('help');
         $this->assertExitCode(Shell::CODE_SUCCESS);
         $this->assertCommandList();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Console/CommandCollectionTest.php b/tests/TestCase/Console/CommandCollectionTest.php
@@ -296,6 +296,6 @@ public function testDiscoverPlugin()
             'Long names are stored as well'
         );
         $this->assertSame($result['company'], $result['company/test_plugin_three.company']);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 }
diff --git a/tests/TestCase/Console/HelperRegistryTest.php b/tests/TestCase/Console/HelperRegistryTest.php
@@ -127,6 +127,6 @@ public function testLoadWithAlias()
 
         $result = $this->helpers->loaded();
         $this->assertEquals(['SimpleAliased', 'SomeHelper'], $result, 'loaded() results are wrong.');
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 }
diff --git a/tests/TestCase/Console/ShellDispatcherTest.php b/tests/TestCase/Console/ShellDispatcherTest.php
@@ -49,7 +49,7 @@ public function tearDown()
     {
         parent::tearDown();
         ShellDispatcher::resetAliases();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Console/ShellTest.php b/tests/TestCase/Console/ShellTest.php
@@ -141,7 +141,7 @@ public function testInitialize()
             'TestPlugin\Model\Table\TestPluginCommentsTable',
             $this->Shell->TestPluginComments
         );
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -170,7 +170,7 @@ public function testLoadModel()
             'TestPlugin\Model\Table\TestPluginCommentsTable',
             $this->Shell->TestPluginComments
         );
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Console/TaskRegistryTest.php b/tests/TestCase/Console/TaskRegistryTest.php
@@ -94,7 +94,7 @@ public function testLoadPluginTask()
         $result = $this->Tasks->load('TestPlugin.OtherTask');
         $this->assertInstanceOf('TestPlugin\Shell\Task\OtherTaskTask', $result, 'Task class is wrong.');
         $this->assertInstanceOf('TestPlugin\Shell\Task\OtherTaskTask', $this->Tasks->OtherTask, 'Class is wrong');
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -119,6 +119,6 @@ public function testLoadWithAlias()
 
         $result = $this->Tasks->loaded();
         $this->assertEquals(['CommandAliased', 'SomeTask'], $result, 'loaded() results are wrong.');
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 }
diff --git a/tests/TestCase/Controller/ComponentRegistryTest.php b/tests/TestCase/Controller/ComponentRegistryTest.php
@@ -54,7 +54,7 @@ public function tearDown()
     {
         parent::tearDown();
         unset($this->Components);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Controller/ControllerTest.php b/tests/TestCase/Controller/ControllerTest.php
@@ -257,7 +257,7 @@ public function setUp()
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/AppTest.php b/tests/TestCase/Core/AppTest.php
@@ -32,7 +32,7 @@ class AppTest extends TestCase
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/BasePluginTest.php b/tests/TestCase/Core/BasePluginTest.php
@@ -39,7 +39,7 @@ class BasePluginTest extends TestCase
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/Configure/Engine/IniConfigTest.php b/tests/TestCase/Core/Configure/Engine/IniConfigTest.php
@@ -221,7 +221,7 @@ public function testReadPluginValue()
 
         $result = $engine->read('TestPlugin.nested');
         $this->assertEquals('foo', $result['database']['db']['password']);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/Configure/Engine/JsonConfigTest.php b/tests/TestCase/Core/Configure/Engine/JsonConfigTest.php
@@ -142,7 +142,7 @@ public function testReadPluginValue()
         $result = $engine->read('TestPlugin.load');
         $this->assertArrayHasKey('plugin_load', $result);
 
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/Configure/Engine/PhpConfigTest.php b/tests/TestCase/Core/Configure/Engine/PhpConfigTest.php
@@ -128,7 +128,7 @@ public function testReadPluginValue()
         $result = $engine->read('TestPlugin.load');
         $this->assertArrayHasKey('plugin_load', $result);
 
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/ConfigureTest.php b/tests/TestCase/Core/ConfigureTest.php
@@ -406,7 +406,7 @@ public function testLoadPlugin()
         $expected = '/test_app/Plugin/TestPlugin/Config/more.load.php';
         $config = Configure::read('plugin_more_load');
         $this->assertEquals($expected, $config);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Core/PluginTest.php b/tests/TestCase/Core/PluginTest.php
@@ -32,7 +32,7 @@ class PluginTest extends TestCase
     public function setUp()
     {
         parent::setUp();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -43,7 +43,7 @@ public function setUp()
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -91,26 +91,29 @@ public function testLoadDynamicClass()
     /**
      * Tests unloading plugins
      *
+     * @deprecated
      * @return void
      */
     public function testUnload()
     {
-        $this->loadPlugins(['TestPlugin' => ['bootstrap' => false, 'routes' => false]]);
-        $expected = ['TestPlugin'];
-        $this->assertEquals($expected, Plugin::loaded());
-        $this->assertTrue(Plugin::isLoaded('TestPlugin'));
-
-        Plugin::unload('TestPlugin');
-        $this->assertEquals([], Plugin::loaded());
-        $this->assertFalse(Plugin::isLoaded('TestPlugin'));
-
-        $this->loadPlugins(['TestPlugin' => ['bootstrap' => false, 'routes' => false]]);
-        $expected = ['TestPlugin'];
-        $this->assertEquals($expected, Plugin::loaded());
-
-        Plugin::unload('TestFakePlugin');
-        $this->assertEquals($expected, Plugin::loaded());
-        $this->assertFalse(Plugin::isLoaded('TestFakePlugin'));
+        $this->deprecated(function () {
+            $this->loadPlugins(['TestPlugin' => ['bootstrap' => false, 'routes' => false]]);
+            $expected = ['TestPlugin'];
+            $this->assertEquals($expected, Plugin::loaded());
+            $this->assertTrue(Plugin::isLoaded('TestPlugin'));
+
+            Plugin::unload('TestPlugin');
+            $this->assertEquals([], Plugin::loaded());
+            $this->assertFalse(Plugin::isLoaded('TestPlugin'));
+
+            $this->loadPlugins(['TestPlugin' => ['bootstrap' => false, 'routes' => false]]);
+            $expected = ['TestPlugin'];
+            $this->assertEquals($expected, Plugin::loaded());
+
+            Plugin::unload('TestFakePlugin');
+            $this->assertEquals($expected, Plugin::loaded());
+            $this->assertFalse(Plugin::isLoaded('TestFakePlugin'));
+        });
     }
 
     /**

diff --git a/tests/TestCase/Datasource/ConnectionManagerTest.php b/tests/TestCase/Datasource/ConnectionManagerTest.php
@@ -68,7 +68,7 @@ class ConnectionManagerTest extends TestCase
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         ConnectionManager::drop('test_variant');
         ConnectionManager::dropAlias('other_name');
     }

diff --git a/tests/TestCase/Error/ErrorHandlerTest.php b/tests/TestCase/Error/ErrorHandlerTest.php
@@ -112,7 +112,7 @@ public function tearDown()
     {
         parent::tearDown();
         Log::reset();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         if ($this->_restoreError) {
             restore_error_handler();
             restore_exception_handler();

diff --git a/tests/TestCase/Error/ExceptionRendererTest.php b/tests/TestCase/Error/ExceptionRendererTest.php
@@ -183,7 +183,7 @@ public function setUp()
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         if ($this->_restoreError) {
             restore_error_handler();
         }
@@ -884,7 +884,6 @@ public function testMissingPluginRenderSafeWithPlugin()
         $body = (string)$response->getBody();
         $this->assertContains('test plugin error500', $body);
         $this->assertContains('Not Found', $body);
-        Plugin::unload();
     }
 
     /**

diff --git a/tests/TestCase/Http/BaseApplicationTest.php b/tests/TestCase/Http/BaseApplicationTest.php
@@ -49,7 +49,7 @@ public function setUp()
     public function tearDown()
     {
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Http/SessionTest.php b/tests/TestCase/Http/SessionTest.php
@@ -88,7 +88,7 @@ public function tearDown()
     {
         unset($_SESSION);
         parent::tearDown();
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/I18n/I18nTest.php b/tests/TestCase/I18n/I18nTest.php
@@ -56,7 +56,7 @@ public function tearDown()
         I18n::clear();
         I18n::setDefaultFormatter('default');
         I18n::setLocale($this->locale);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         Cache::clear(false, '_cake_core_');
     }
 

diff --git a/tests/TestCase/Log/LogTest.php b/tests/TestCase/Log/LogTest.php
@@ -64,7 +64,7 @@ public function testImportingLoggers()
 
         Log::write(LOG_INFO, 'TestPluginLog is not a BaseLog descendant');
 
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/Mailer/EmailTest.php b/tests/TestCase/Mailer/EmailTest.php
@@ -1792,7 +1792,7 @@ public function testSendRenderThemed()
         $this->assertContains('Message-ID: ', $result['headers']);
         $this->assertContains('To: ', $result['headers']);
         $this->assertContains('/test_theme/img/test.jpg', $result['message']);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**
@@ -1975,7 +1975,7 @@ public function testSendRenderPlugin()
         $result = $this->Email->send();
         $this->assertContains('Here is your value: 12345', $result['message']);
         $this->assertContains('This email was sent using the TestPlugin.', $result['message']);
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/ORM/AssociationTest.php b/tests/TestCase/ORM/AssociationTest.php
@@ -540,7 +540,7 @@ public function testTargetPlugin()
         $this->assertSame('TestPlugin.ThisAssociationName', $table->getRegistryAlias());
         $this->assertSame('comments', $table->getTable());
         $this->assertSame('ThisAssociationName', $table->getAlias());
-        Plugin::unload();
+        Plugin::getCollection()->clear();
     }
 
     /**

diff --git a/tests/TestCase/ORM/BehaviorRegistryTest.php b/tests/TestCase/ORM/BehaviorRegistryTest.php
@@ -46,7 +46,7 @@ public function setUp()
      */
     public function tearDown()
     {
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         unset($this->Table, $this->EventManager, $this->Behaviors);
         parent::tearDown();
     }

diff --git a/tests/TestCase/ORM/Locator/TableLocatorTest.php b/tests/TestCase/ORM/Locator/TableLocatorTest.php
@@ -68,7 +68,7 @@ public function setUp()
      */
     public function tearDown()
     {
-        Plugin::unload();
+        Plugin::getCollection()->clear();
         parent::tearDown();
     }