Merge pull request #1 from dlubitz/html-hyphenation

Support for HTML

Author: mstruebing

Classes/Fusion/HyphenateImplementation.php

@@ -42,6 +42,11 @@ public function getLocale()
         return (string) $this->localizationService->getConfiguration()->getCurrentLocale();
     }
 
+    public function getType()
+    {
+        return strtolower($this->fusionValue('type'));
+    }
+
     public function getThreshold()
     {
         return $this->fusionValue('threshold');
@@ -70,6 +75,17 @@ public function evaluate()
         $syllable->setHyphen(new \Syllable_Hyphen_Soft);
         $syllable->setMinWordLength($this->getThreshold());
 
-        return $syllable->hyphenateText($this->getContent());
+        switch ($this->getType()) {
+            case 'html':
+                $html = mb_convert_encoding($this->getContent(), 'HTML-ENTITIES', "UTF-8");
+                $result = $syllable->hyphenateHtml($html);
+                break;
+            case 'test':
+                // Break missing intendedly
+            default:
+                $result = $syllable->hyphenateText($this->getContent());
+                break;
+        }
+        return $result;
     }
 }

Configuration/Settings.yaml

@@ -0,0 +1,5 @@
+Neos:
+  Neos:
+    fusion:
+      autoInclude:
+        PackageFactory.Hyphenate: true

README.md

@@ -9,16 +9,40 @@ to the require-section of the composer.json or run `composer require packagefact
 
 ## Usage
 
-Just use the `PackageFactory.Hyphenate:Hyphenate` Fusion object as a processor on the fusion value that should be hyphenated.
+### Text
+Just use the `PackageFactory.Hyphenate:HyphenateText` Fusion object as a processor on the fusion value that should be hyphenated.
 
 ```
 someFusionValue = 'Grund­stücks­ver­kehrs­ge­neh­mi­gungs­zu­stän­dig­keits­über­tra­gungs­ver­ord­nung'
-[email protected] = PackageFactory.Hyphenate:Hyphenate {
-	locale = 'de'
+[email protected] = PackageFactory.Hyphenate:HyphenateText {
+  locale = 'de'
 }
 ```
 
-**!!! Warning: !!!** This mechanism breaks HTML code. There's no support for hyphenating HTML Strings yet (PRs are welcome ;) ).
+### HTML
+Similar to text elements you can use `PackageFactory.Hyphenate:HyphenateHtml` for HTML elements.
+
+```
+[email protected] = PackageFactory.Hyphenate:HyphenateHtml {
+  locale = 'de'
+}
+```
+
+## Neos CMS integration example
+
+You can easily activate hyphenation for all Neos CMS text- and headline nodetypes with following Fusion code: 
+
+```
+prototype(Neos.NodeTypes:Text) {
+  [email protected] = PackageFactory.Hyphenate:HyphenateHtml
+}
+
+prototype(Neos.NodeTypes:Headline) {
+  [email protected] = PackageFactory.Hyphenate:HyphenateHtml
+}
+
+```
+
 
 ## Parameters
 

Resources/Private/Fusion/Root.fusion

@@ -1,5 +1,13 @@
 prototype(PackageFactory.Hyphenate:Hyphenate) {
     @class = 'PackageFactory\\Hyphenate\\Fusion\\HyphenateImplementation'
-
+    type = 'text'
     content = ${value}
+
+    @if.onlyRenderWhenNotInBackend = ${!documentNode.context.inBackend}
+}
+
+prototype(PackageFactory.Hyphenate:HyphenateText) < prototype(PackageFactory.Hyphenate:Hyphenate)
+
+prototype(PackageFactory.Hyphenate:HyphenateHtml) < prototype(PackageFactory.Hyphenate:Hyphenate) {
+    type = 'html'
 }