Deprecate form methods (#144)

Author: kunicmarko20

src/Form/Type/CKEditorType.php

@@ -143,20 +143,35 @@ public function __construct(
      */
     public function isEnable($enable = null)
     {
+        $this->triggerMethodDeprecation('isEnable');
+
         if (null !== $enable) {
             $this->enable = (bool) $enable;
         }
 
         return $this->enable;
     }
 
+    private function triggerMethodDeprecation($name)
+    {
+        @trigger_error(
+            sprintf(
+                'Method "%s" is deprecated since 1.x and will be removed with the 2.0 release. ',
+                $name
+            ),
+            E_USER_DEPRECATED
+        );
+    }
+
     /**
      * @param bool|null $async
      *
      * @return bool
      */
     public function isAsync($async = null)
     {
+        $this->triggerMethodDeprecation('isAsync');
+
         if (null !== $async) {
             $this->async = (bool) $async;
         }
@@ -171,6 +186,8 @@ public function isAsync($async = null)
      */
     public function isAutoload($autoload = null)
     {
+        $this->triggerMethodDeprecation('isAutoload');
+
         if (null !== $autoload) {
             $this->autoload = (bool) $autoload;
         }
@@ -185,6 +202,8 @@ public function isAutoload($autoload = null)
      */
     public function isAutoInline($autoInline = null)
     {
+        $this->triggerMethodDeprecation('isAutoInline');
+
         if (null !== $autoInline) {
             $this->autoInline = (bool) $autoInline;
         }
@@ -199,6 +218,8 @@ public function isAutoInline($autoInline = null)
      */
     public function isInline($inline = null)
     {
+        $this->triggerMethodDeprecation('isInline');
+
         if (null !== $inline) {
             $this->inline = (bool) $inline;
         }
@@ -213,6 +234,8 @@ public function isInline($inline = null)
      */
     public function useJquery($jquery = null)
     {
+        $this->triggerMethodDeprecation('useJquery');
+
         if (null !== $jquery) {
             $this->jquery = (bool) $jquery;
         }
@@ -227,6 +250,8 @@ public function useJquery($jquery = null)
      */
     public function useRequireJs($requireJs = null)
     {
+        $this->triggerMethodDeprecation('useRequireJs');
+
         if (null !== $requireJs) {
             $this->requireJs = (bool) $requireJs;
         }
@@ -241,6 +266,8 @@ public function useRequireJs($requireJs = null)
      */
     public function isInputSync($inputSync = null)
     {
+        $this->triggerMethodDeprecation('isInputSync');
+
         if (null !== $inputSync) {
             $this->inputSync = (bool) $inputSync;
         }
@@ -253,6 +280,8 @@ public function isInputSync($inputSync = null)
      */
     public function hasFilebrowsers()
     {
+        $this->triggerMethodDeprecation('hasFilebrowsers');
+
         return !empty($this->filebrowsers);
     }
 
@@ -261,6 +290,8 @@ public function hasFilebrowsers()
      */
     public function getFilebrowsers()
     {
+        $this->triggerMethodDeprecation('getFilebrowsers');
+
         return $this->filebrowsers;
     }
 
@@ -269,6 +300,8 @@ public function getFilebrowsers()
      */
     public function setFilebrowsers(array $filebrowsers)
     {
+        $this->triggerMethodDeprecation('setFilebrowsers');
+
         foreach ($filebrowsers as $filebrowser) {
             $this->addFilebrowser($filebrowser);
         }
@@ -281,6 +314,8 @@ public function setFilebrowsers(array $filebrowsers)
      */
     public function hasFilebrowser($filebrowser)
     {
+        $this->triggerMethodDeprecation('hasFilebrowser');
+
         return in_array($filebrowser, $this->filebrowsers, true);
     }
 
@@ -289,6 +324,8 @@ public function hasFilebrowser($filebrowser)
      */
     public function addFilebrowser($filebrowser)
     {
+        $this->triggerMethodDeprecation('addFilebrowser');
+
         if (!$this->hasFilebrowser($filebrowser)) {
             $this->filebrowsers[] = $filebrowser;
         }
@@ -299,6 +336,8 @@ public function addFilebrowser($filebrowser)
      */
     public function removeFilebrowser($filebrowser)
     {
+        $this->triggerMethodDeprecation('removeFilebrowser');
+
         unset($this->filebrowsers[array_search($filebrowser, $this->filebrowsers, true)]);
     }
 
@@ -307,6 +346,8 @@ public function removeFilebrowser($filebrowser)
      */
     public function getBasePath()
     {
+        $this->triggerMethodDeprecation('getBasePath');
+
         return $this->basePath;
     }
 
@@ -315,6 +356,8 @@ public function getBasePath()
      */
     public function setBasePath($basePath)
     {
+        $this->triggerMethodDeprecation('setBasePath');
+
         $this->basePath = $basePath;
     }
 
@@ -323,6 +366,8 @@ public function setBasePath($basePath)
      */
     public function getJsPath()
     {
+        $this->triggerMethodDeprecation('getJsPath');
+
         return $this->jsPath;
     }
 
@@ -331,6 +376,8 @@ public function getJsPath()
      */
     public function setJsPath($jsPath)
     {
+        $this->triggerMethodDeprecation('setJsPath');
+
         $this->jsPath = $jsPath;
     }
 
@@ -339,6 +386,8 @@ public function setJsPath($jsPath)
      */
     public function getJqueryPath()
     {
+        $this->triggerMethodDeprecation('getJqueryPath');
+
         return $this->jqueryPath;
     }
 
@@ -347,6 +396,8 @@ public function getJqueryPath()
      */
     public function setJqueryPath($jqueryPath)
     {
+        $this->triggerMethodDeprecation('setJqueryPath');
+
         $this->jqueryPath = $jqueryPath;
     }
 
@@ -355,6 +406,8 @@ public function setJqueryPath($jqueryPath)
      */
     public function getConfigManager()
     {
+        $this->triggerMethodDeprecation('getConfigManager');
+
         return $this->configManager;
     }
 
@@ -363,6 +416,8 @@ public function getConfigManager()
      */
     public function setConfigManager(ConfigManagerInterface $configManager)
     {
+        $this->triggerMethodDeprecation('setConfigManager');
+
         $this->configManager = $configManager;
     }
 
@@ -371,6 +426,8 @@ public function setConfigManager(ConfigManagerInterface $configManager)
      */
     public function getPluginManager()
     {
+        $this->triggerMethodDeprecation('getPluginManager');
+
         return $this->pluginManager;
     }
 
@@ -379,6 +436,8 @@ public function getPluginManager()
      */
     public function setPluginManager(PluginManagerInterface $pluginManager)
     {
+        $this->triggerMethodDeprecation('setPluginManager');
+
         $this->pluginManager = $pluginManager;
     }
 
@@ -387,6 +446,8 @@ public function setPluginManager(PluginManagerInterface $pluginManager)
      */
     public function getStylesSetManager()
     {
+        $this->triggerMethodDeprecation('getStylesSetManager');
+
         return $this->stylesSetManager;
     }
 
@@ -395,6 +456,8 @@ public function getStylesSetManager()
      */
     public function setStylesSetManager(StylesSetManagerInterface $stylesSetManager)
     {
+        $this->triggerMethodDeprecation('setStylesSetManager');
+
         $this->stylesSetManager = $stylesSetManager;
     }
 
@@ -403,6 +466,8 @@ public function setStylesSetManager(StylesSetManagerInterface $stylesSetManager)
      */
     public function getTemplateManager()
     {
+        $this->triggerMethodDeprecation('getTemplateManager');
+
         return $this->templateManager;
     }
 
@@ -411,6 +476,8 @@ public function getTemplateManager()
      */
     public function setTemplateManager(TemplateManagerInterface $templateManager)
     {
+        $this->triggerMethodDeprecation('setTemplateManager');
+
         $this->templateManager = $templateManager;
     }
 
@@ -419,6 +486,8 @@ public function setTemplateManager(TemplateManagerInterface $templateManager)
      */
     public function getToolbarManager()
     {
+        $this->triggerMethodDeprecation('getToolbarManager');
+
         return $this->toolbarManager;
     }
 
@@ -427,6 +496,8 @@ public function getToolbarManager()
      */
     public function setToolbarManager(ToolbarManagerInterface $toolbarManager)
     {
+        $this->triggerMethodDeprecation('setToolbarManager');
+
         $this->toolbarManager = $toolbarManager;
     }
 

tests/DependencyInjection/AbstractFOSCKEditorExtensionTest.php

@@ -65,7 +65,7 @@ abstract class AbstractFOSCKEditorExtensionTest extends AbstractTestCase
     private $templating;
 
     /**
-     * {@inheritdoc}
+     * @group legacy
      */
     protected function setUp()
     {

tests/Form/Type/CKEditorTypeTest.php

@@ -24,6 +24,8 @@
 use Symfony\Component\Form\Forms;
 
 /**
+ * @group legacy
+ *
  * @author GeLo <[email protected]>
  */
 class CKEditorTypeTest extends AbstractTestCase
@@ -69,7 +71,7 @@ class CKEditorTypeTest extends AbstractTestCase
     private $toolbarManager;
 
     /**
-     * {@inheritdooc}.
+     * @group legacy
      */
     protected function setUp()
     {
@@ -94,6 +96,9 @@ protected function setUp()
         $this->formType = method_exists(AbstractType::class, 'getBlockPrefix') ? CKEditorType::class : 'ckeditor';
     }
 
+    /**
+     * @group legacy
+     */
     public function testInitialState()
     {
         $this->assertTrue($this->ckEditorType->isEnable());