Add HeaderSoftHyphen processor to handle soft hyphens in headers

Author: Vladimir Falcón Piva

Classes/DataProcessing/HeaderDataProcessor.php

@@ -7,6 +7,7 @@
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\FrameClassProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLayoutProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLinkProcessor;
+use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderSoftHyphen;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeadlinesProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\PassThrough;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\SpaceBeforeProcessor;
@@ -25,7 +26,7 @@ class HeaderDataProcessor extends TtContentDataProcessor implements FieldMapping
     use FieldMappingTrait;
 
     public const DEFAULT_FIELDS = [
-        self::FIELD_HEADER => PassThrough::class,
+        self::FIELD_HEADER => HeaderSoftHyphen::class,
         self::FIELD_SUBHEADER => PassThrough::class,
         self::FIELD_HEADER_LAYOUT => HeaderLayoutProcessor::class,
         // note: `header_link` must be processed before `headlines`

Classes/DataProcessing/TextMediaDataProcessor.php

@@ -10,6 +10,7 @@
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\FrameClassProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLayoutProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLinkProcessor;
+use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderSoftHyphen;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeadlinesProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\ImageBelowTextProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\ImageOrientProcessor;
@@ -35,7 +36,7 @@ class TextMediaDataProcessor extends TtContentDataProcessor implements FieldMapp
     public const DEFAULT_FIELDS = [
         self::FIELD_ASSETS => MediaProcessor::class,
         self::FIELD_BODYTEXT => BodytextProcessor::class,
-        self::FIELD_HEADER => PassThrough::class,
+        self::FIELD_HEADER => HeaderSoftHyphen::class,
         self::FIELD_HEADER_LAYOUT => HeaderLayoutProcessor::class,
         self::FIELD_HEADER_LINK => HeaderLinkProcessor::class,
         self::FIELD_HEADLINES => HeadlinesProcessor::class,

Classes/DataProcessing/TtContent/Field/HeaderSoftHyphen.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field;
+
+use Cpsit\BravoHandlebarsContent\DataProcessing\FieldProcessorInterface;
+
+/*
+ * This file is part of the bravo handlebars content package.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ */
+
+/**
+ * Class PassThrough
+ *
+ * This processor just returns the value of a given field in the data array
+ */
+class HeaderSoftHyphen implements FieldProcessorInterface
+{
+    use FieldProcessorConfigTrait;
+
+    public function process(string $fieldName, array $data, array $variables): array
+    {
+        if (isset($data[$fieldName])) {
+            $sanitizedData = htmlspecialchars((string)$data[$fieldName], ENT_COMPAT, 'UTF-8', false);
+            $variables[$fieldName] = str_replace('--', '&shy;', $sanitizedData);
+        }
+
+        return $variables;
+    }
+}

Classes/DataProcessing/TtContentDataProcessor.php

@@ -18,6 +18,7 @@
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\FrameClassProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLayoutProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLinkProcessor;
+use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderSoftHyphen;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeadlinesProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\PassThrough;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\SpaceBeforeProcessor;
@@ -36,7 +37,7 @@ class TtContentDataProcessor implements DataProcessorInterface, FieldAwareProces
 
     public const DEFAULT_FIELDS = [
         self::FIELD_BODYTEXT => BodytextProcessor::class,
-        self::FIELD_HEADER => PassThrough::class,
+        self::FIELD_HEADER => HeaderSoftHyphen::class,
         self::FIELD_HEADER_LAYOUT => HeaderLayoutProcessor::class,
         // note: `header_link` must be processed before `headlines`
         self::FIELD_HEADER_LINK => HeaderLinkProcessor::class,

Classes/DataProcessing/UploadsDataProcessor.php

@@ -15,6 +15,7 @@
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\FrameClassProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLayoutProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderLinkProcessor;
+use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeaderSoftHyphen;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\HeadlinesProcessor;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\PassThrough;
 use Cpsit\BravoHandlebarsContent\DataProcessing\TtContent\Field\SpaceBeforeProcessor;
@@ -25,7 +26,7 @@ class UploadsDataProcessor extends TtContentDataProcessor implements FieldMappin
     use FieldMappingTrait;
 
     public const DEFAULT_FIELDS = [
-        self::FIELD_HEADER => PassThrough::class,
+        self::FIELD_HEADER => HeaderSoftHyphen::class,
         self::FIELD_HEADER_LAYOUT => HeaderLayoutProcessor::class,
         self::FIELD_HEADER_LINK => HeaderLinkProcessor::class,
         self::FIELD_HEADLINES => HeadlinesProcessor::class,