Add option to prevent ckeditor.js from being automatically included (#…

…120)
trsteel88 · Aug 17, 2023 · 1e48f59 · 1e48f59
1 parent 003b707
commit 1e48f59
Show file tree

Hide file tree

Showing 9 changed files with 39 additions and 3 deletions.
diff --git a/.php-cs-fixer.dist.php b/.php-cs-fixer.dist.php
@@ -1,7 +1,7 @@
 <?php
 
 $finder = PhpCsFixer\Finder::create()
-    //->exclude('tests/Fixtures')
+    ->exclude('var/cache')
     ->in(__DIR__);
 
 return (new PhpCsFixer\Config())

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -21,6 +21,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         $rootNode
             ->children()
                 ->scalarNode('class')->defaultValue(CkeditorType::class)->end()
+                ->booleanNode('autoload_ckeditor_js')->defaultTrue()->end()
                 ->arrayNode('html_purifier')
                     ->addDefaultsIfNotSet()
                     ->children()

diff --git a/DependencyInjection/TrsteelCkeditorExtension.php b/DependencyInjection/TrsteelCkeditorExtension.php
@@ -39,6 +39,7 @@ public function load(array $configs, ContainerBuilder $container): void
         $config['html_purifier']['config'] = array_merge(['Cache.SerializerPath' => '%kernel.cache_dir%'], $config['html_purifier']['config']);
 
         $container->setParameter('trsteel_ckeditor.form.type.class', $config['class']);
+        $container->setParameter('trsteel_ckeditor.autoload_ckeditor_js', $config['autoload_ckeditor_js']);
         $container->setParameter('trsteel_ckeditor.html_purifier.config', $config['html_purifier']['config']);
         $container->setParameter('trsteel_ckeditor.ckeditor.transformers', $config['transformers']);
         $container->setParameter('trsteel_ckeditor.ckeditor.toolbar', $config['toolbar']);

diff --git a/Form/Type/CkeditorType.php b/Form/Type/CkeditorType.php
@@ -99,6 +99,7 @@ public function buildView(FormView $view, FormInterface $form, array $options):
             }
         }
 
+        $view->vars['autoload_ckeditor_js'] = $options['autoload_ckeditor_js'];
         $view->vars['toolbar'] = $toolbar;
         $view->vars['startup_outline_blocks'] = $options['startup_outline_blocks'];
         $view->vars['ui_color'] = $options['ui_color'];
@@ -137,6 +138,7 @@ public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'required' => false,
+            'autoload_ckeditor_js' => $this->container->getParameter('trsteel_ckeditor.autoload_ckeditor_js'),
             'transformers' => $this->container->getParameter('trsteel_ckeditor.ckeditor.transformers'),
             'toolbar' => $this->container->getParameter('trsteel_ckeditor.ckeditor.toolbar'),
             'toolbar_groups' => $this->container->getParameter('trsteel_ckeditor.ckeditor.toolbar_groups'),

diff --git a/Resources/views/Form/ckeditor_widget.html.twig b/Resources/views/Form/ckeditor_widget.html.twig
@@ -7,7 +7,10 @@
     {% endautoescape %}
     </script>
 
-    <script type="text/javascript" src="{{ asset(base_path ~ 'ckeditor.js') }}"></script>
+    {% if autoload_ckeditor_js %}
+        <script type="text/javascript" src="{{ asset(base_path ~ 'ckeditor.js') }}"></script>
+    {% endif %}
+
     <script type="text/javascript">
     {% autoescape false %}
         {% set plugins = '' %}

diff --git a/Tests/AppKernel.php b/Tests/AppKernel.php
@@ -23,7 +23,7 @@ public function registerBundles(): iterable
         return $bundles;
     }
 
-    public function registerContainerConfiguration(LoaderInterface $loader)
+    public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load(__DIR__.'/Resources/config/config.yml');
     }

diff --git a/Tests/Form/CkeditorTypeTest.php b/Tests/Form/CkeditorTypeTest.php
@@ -55,6 +55,33 @@ public function get($serviceId)
         return self::$kernel->getContainer()->get($serviceId);
     }
 
+    /**
+     * Check the default required property.
+     */
+    public function testDefaultAutoloadCkeditorJs()
+    {
+        $form = $this->factory->create($this->formType);
+        $view = $form->createView();
+        $autoloadCkeditorJs = $view->vars['autoload_ckeditor_js'];
+
+        $this->assertTrue($autoloadCkeditorJs);
+    }
+
+    /**
+     * Check the required property.
+     */
+    public function testAutoloadCkeditorJs()
+    {
+        $form = $this->factory->create($this->formType, null, [
+            'autoload_ckeditor_js' => true,
+        ]);
+
+        $view = $form->createView();
+        $autoloadCkeditorJs = $view->vars['autoload_ckeditor_js'];
+
+        $this->assertSame($autoloadCkeditorJs, true);
+    }
+
     /**
      * Check the default required property.
      */

diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -9,5 +9,6 @@ parameters:
     excludePaths:
         - vendor
         - Tests
+        - var/cache
 
     checkGenericClassInNonGenericObjectType: false
diff --git a/rector.php b/rector.php
@@ -16,6 +16,7 @@
     $rectorConfig->skip([
         __DIR__.'/vendor',
         __DIR__.'/Tests',
+        __DIR__.'/var',
     ]);
 
     $rectorConfig->importNames();