Fix ckeditor (#100)

add CkEditor support for static content admin

Author: ElectricMaxxx

composer.json

@@ -32,15 +32,17 @@
         "symfony/phpunit-bridge": "^3.2",
         "matthiasnoback/symfony-dependency-injection-test": "~0.6",
         "matthiasnoback/symfony-config-test": "^1.3.1",
-        "burgov/key-value-form-bundle": "^1.0"
+        "burgov/key-value-form-bundle": "^1.0",
+        "egeloen/ckeditor-bundle": "^4.0"
     },
     "minimum-stability": "dev",
     "prefer-stable": true,
     "suggest": {
         "symfony-cmf/routing-bundle": "To make use of the alternate locale provider.",
         "doctrine/phpcr-bundle": "To persist the metadata in PHPCR ODM documents",
         "doctrine/doctrine-bundle": "To persist the metadata in ORM entities",
-        "doctrine/orm": "To persist the metadata in ORM entities, ~2.4"
+        "doctrine/orm": "To persist the metadata in ORM entities, ~2.4",
+        "egeloen/ckeditor-bundle": "To have CkEditor support on textareas."
     },
     "autoload": {
         "psr-4": {

src/Admin/Content/StaticContentAdmin.php

@@ -11,22 +11,42 @@
 
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\Admin\Content;
 
+use Ivory\CKEditorBundle\Form\Type\CKEditorType;
 use Sonata\AdminBundle\Datagrid\DatagridMapper;
 use Sonata\AdminBundle\Datagrid\ListMapper;
 use Sonata\AdminBundle\Form\FormMapper;
 use Symfony\Cmf\Bundle\ContentBundle\Model\StaticContentBase;
 use Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\Admin\AbstractAdmin;
 use Symfony\Cmf\Bundle\TreeBrowserBundle\Form\Type\TreeSelectType;
-use Symfony\Component\Form\Extension\Core\Type\TextType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
+use Symfony\Component\Form\Extension\Core\Type\TextType;
 
 class StaticContentAdmin extends AbstractAdmin
 {
     protected $translationDomain = 'CmfSonataPhpcrAdminIntegrationBundle';
 
+    /**
+     * Configuration, that can be passed to CKEditorType.
+     *
+     * @var array
+     */
+    private $ckEditorConfig;
+
     public function getExportFormats()
     {
-        return array();
+        return [];
+    }
+
+    /**
+     * Set configuration for CKEditorType.
+     *
+     * Documentation: http://symfony.com/doc/master/bundles/IvoryCKEditorBundle/usage/config.html
+     *
+     * @param array $config configuration for CKEditorType
+     */
+    public function setCkEditorConfig(array $config)
+    {
+        $this->ckEditorConfig = $config;
     }
 
     protected function configureListFields(ListMapper $listMapper)
@@ -44,7 +64,11 @@ protected function configureFormFields(FormMapper $formMapper)
             ->tab('form.tab_general')
                 ->with('form.group_content', ['class' => 'col-md-9'])
                     ->add('title', TextType::class)
-                    ->add('body', TextareaType::class)
+                    ->add(
+                        'body',
+                        $this->ckEditorConfig ? CKEditorType::class : TextareaType::class,
+                        $this->ckEditorConfig
+                    )
                 ->end()
 
                 ->with('form.group_location', ['class' => 'col-md-3'])

src/DependencyInjection/CmfSonataPhpcrAdminIntegrationExtension.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection;
 
+use Ivory\CKEditorBundle\IvoryCKEditorBundle;
+use Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection\Factory\IsConfigEnabledTrait;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
@@ -24,6 +26,8 @@
  */
 class CmfSonataPhpcrAdminIntegrationExtension extends Extension implements CompilerPassInterface
 {
+    use IsConfigEnabledTrait;
+
     /**
      * @var AdminFactoryInterface[]
      */
@@ -61,6 +65,36 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('main.xml');
         $loader->load('enhancer.xml');
+
+        $this->loadIvoryCKEditor($config['ivory_ckeditor'], $container);
+    }
+
+    /**
+     * Adds the ckEditor configuration to the parameters list when configuration is enabled (auto, true). For both
+     * settings the "egeloen/ckeditor-bundle" has to be installed and enabled.
+     *
+     * @param array            $config
+     * @param ContainerBuilder $container
+     *
+     * @throws \LogicException when configuration is enabled by true and "IvoryCKEditorBundle" is not enabled
+     */
+    protected function loadIvoryCKEditor(array $config, ContainerBuilder $container)
+    {
+        $configParameter = [];
+        if ($this->isConfigEnabled($container, $config)) {
+            $bundles = $container->getParameter('kernel.bundles');
+            if (true === $config['enabled'] && !isset($bundles['IvoryCKEditorBundle'])) {
+                $message = 'IvoryCKEditorBundle integration was explicitely enabled, but the bundle is not available';
+                if (class_exists(IvoryCKEditorBundle::class)) {
+                    $message .= ' (did you forget to register the bundle in the AppKernel?)';
+                }
+                throw new \LogicException($message.'.');
+            } elseif (isset($bundles['IvoryCKEditorBundle'])) {
+                $configParameter = ['config_name' => $config['config_name']];
+            }
+        }
+
+        $container->setParameter('cmf_sonata_phpcr_admin_integration.ivory_ckeditor.config', $configParameter);
     }
 
     /**

src/DependencyInjection/Configuration.php

@@ -41,6 +41,20 @@ public function getConfigTreeBuilder()
 
         $this->addBundlesSection($root);
 
+        $root
+            ->children()
+                ->arrayNode('ivory_ckeditor')
+                    ->addDefaultsIfNotSet()
+                    ->children()
+                        ->enumNode('enabled')
+                            ->values([true, false, 'auto'])
+                            ->defaultValue('auto')
+                        ->end()
+                        ->scalarNode('config_name')->isRequired()->end()
+                    ->end()
+                ->end()
+            ->end();
+
         return $treeBuilder;
     }
 

src/DependencyInjection/Factory/IsConfigEnabledTrait.php

@@ -12,6 +12,7 @@
 namespace Symfony\Cmf\Bundle\SonataPhpcrAdminIntegrationBundle\DependencyInjection\Factory;
 
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 
 trait IsConfigEnabledTrait
 {

src/Resources/config/content.xml

@@ -26,6 +26,10 @@
             <call method="setRootPath">
                 <argument>%cmf_content.persistence.phpcr.content_basepath%</argument>
             </call>
+
+            <call method="setCkEditorConfig">
+                <argument>%cmf_sonata_phpcr_admin_integration.ivory_ckeditor.config%</argument>
+            </call>
         </service>
     </services>
 </container>

src/Resources/config/schema/sonata-phpcr-admin-integration.xsd

@@ -9,6 +9,7 @@
     <xsd:complexType name="config">
         <xsd:sequence>
             <xsd:element name="bundles" type="bundles" minOccurs="0" maxOccurs="1" />
+            <xsd:element name="ivory_ckeditor" type="ivory_ckeditor" minOccurs="0" maxOccurs="1" />
         </xsd:sequence>
     </xsd:complexType>
 
@@ -18,4 +19,17 @@
         </xsd:sequence>
     </xsd:complexType>
 
+    <xsd:complexType name="ivory_ckeditor">
+        <xsd:attribute name="enabled" type="enabled" default="auto" />
+        <xsd:attribute name="config_name" type="xsd:string"/>
+    </xsd:complexType>
+
+    <xsd:simpleType name="enabled">
+        <xsd:restriction base="xsd:string">
+            <xsd:enumeration value="true"/>
+            <xsd:enumeration value="false"/>
+            <xsd:enumeration value="auto"/>
+        </xsd:restriction>
+    </xsd:simpleType>
+
 </xsd:schema>

tests/Resources/Fixtures/config/config.php

@@ -18,4 +18,7 @@
             'enabled' => true,
         ],
     ],
+    'ivory_ckeditor' => [
+        'config_name' => 'cmf_sonata_phpcr_admin_integration',
+    ],
 ]);

tests/Resources/Fixtures/config/config.xml

@@ -7,5 +7,6 @@
         <bundles>
             <seo enabled="true" />
         </bundles>
+        <ivory_ckeditor config_name="cmf_sonata_phpcr_admin_integration" />
     </config>
 </container>

tests/Resources/Fixtures/config/config.yml

@@ -1,4 +1,5 @@
 cmf_sonata_phpcr_admin_integration:
     bundles:
-        seo:
-            enabled: true
+        seo: ~
+    ivory_ckeditor:
+        config_name: "cmf_sonata_phpcr_admin_integration"