[Twig] Renamed RichTextExtension to RichTextConverterExtension (#60)

Renamed and refactored RichText Twig Extension from RichTextExtension to RichTextConverterExtension to separate responsibilities
ezsystems · Aug 9, 2019 · d3f5540 · d3f5540
1 parent 6383ac6
commit d3f5540
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 22 deletions.
diff --git a/src/bundle/Resources/config/templating.yaml b/src/bundle/Resources/config/templating.yaml
@@ -1,7 +1,10 @@
 services:
-    EzSystems\EzPlatformRichTextBundle\Templating\Twig\Extension\RichTextExtension:
+    _defaults:
+        autowire: true
+        autoconfigure: true
+        public: false
+
+    EzSystems\EzPlatformRichTextBundle\Templating\Twig\Extension\RichTextConverterExtension:
         arguments:
-            - '@ezrichtext.converter.output.xhtml5'
-            - '@ezrichtext.converter.edit.xhtml5'
-        tags:
-            - { name: twig.extension }
+            $richTextOutputConverter: '@ezrichtext.converter.output.xhtml5'
+            $richTextEditConverter: '@ezrichtext.converter.edit.xhtml5'
diff --git a/...ting/Twig/Extension/RichTextExtension.php → .../Extension/RichTextConverterExtension.php b/...ting/Twig/Extension/RichTextExtension.php → .../Extension/RichTextConverterExtension.php
@@ -8,34 +8,33 @@
 
 namespace EzSystems\EzPlatformRichTextBundle\Templating\Twig\Extension;
 
+use DOMDocument;
 use EzSystems\EzPlatformRichText\eZ\RichText\Converter as RichTextConverterInterface;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFilter;
 
-class RichTextExtension extends AbstractExtension
+class RichTextConverterExtension extends AbstractExtension
 {
-    /**
-     * @var \EzSystems\EzPlatformRichText\eZ\RichText\Converter
-     */
-    private $richTextConverter;
+    /** @var \EzSystems\EzPlatformRichText\eZ\RichText\Converter */
+    private $richTextOutputConverter;
 
-    /**
-     * @var \EzSystems\EzPlatformRichText\eZ\RichText\Converter
-     */
+    /** @var \EzSystems\EzPlatformRichText\eZ\RichText\Converter */
     private $richTextEditConverter;
 
-    public function __construct(RichTextConverterInterface $richTextConverter, RichTextConverterInterface $richTextEditConverter)
-    {
-        $this->richTextConverter = $richTextConverter;
+    public function __construct(
+        RichTextConverterInterface $richTextOutputConverter,
+        RichTextConverterInterface $richTextEditConverter
+    ) {
+        $this->richTextOutputConverter = $richTextOutputConverter;
         $this->richTextEditConverter = $richTextEditConverter;
     }
 
-    public function getName()
+    public function getName(): string
     {
-        return 'ezpublish.rich_text';
+        return 'ezrichtext.converter';
     }
 
-    public function getFilters()
+    public function getFilters(): array
     {
         return [
             new TwigFilter(
@@ -58,9 +57,9 @@ public function getFilters()
      *
      * @return string
      */
-    public function richTextToHtml5($xmlData)
+    public function richTextToHtml5(DOMDocument $xmlData): string
     {
-        return $this->richTextConverter->convert($xmlData)->saveHTML();
+        return $this->richTextOutputConverter->convert($xmlData)->saveHTML();
     }
 
     /**
@@ -70,7 +69,7 @@ public function richTextToHtml5($xmlData)
      *
      * @return string
      */
-    public function richTextToHtml5Edit($xmlData)
+    public function richTextToHtml5Edit(DOMDocument $xmlData): string
     {
         return $this->richTextEditConverter->convert($xmlData)->saveHTML();
     }