Introduce self-wrapping capabilities for presentational components

Author: Bernhard Schmitt

Classes/Fusion/AbstractComponentPresentationObjectFactory.php

@@ -13,6 +13,7 @@
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\I18n\Translator;
 use Neos\Neos\Service\ContentElementEditableService;
+use Neos\Neos\Service\ContentElementWrappingService;
 use PackageFactory\AtomicFusion\PresentationObjects\Infrastructure\UriService;
 
 /**
@@ -38,12 +39,27 @@ abstract class AbstractComponentPresentationObjectFactory implements ComponentPr
      */
     protected $contentElementEditableService;
 
+    /**
+     * @Flow\Inject
+     * @var ContentElementWrappingService
+     */
+    protected $contentElementWrappingService;
+
     /**
      * @Flow\Inject
      * @var NodeTypeConstraintFactory
      */
     protected $nodeTypeConstraintFactory;
 
+    final protected function createWrapper(TraversableNodeInterface $node, PresentationObjectComponentImplementation $fusionObject): callable
+    {
+        $wrappingService = $this->contentElementWrappingService;
+
+        return function(string $content) use($node, $fusionObject, $wrappingService) {
+            return $wrappingService->wrapContentObject($node, $content, $fusionObject->getPath());
+        };
+    }
+
     final protected function getEditableProperty(TraversableNodeInterface $node, string $propertyName): string
     {
         return $this->contentElementEditableService->wrapContentProperty(
@@ -60,6 +76,7 @@ final protected function findChildNodesByNodeTypeFilterString(TraversableNodeInt
 
     /**
      * All methods are considered safe
+     *
      * @param string $methodName
      * @return boolean
      */

Classes/Fusion/PresentationObjectComponentImplementation.php

@@ -39,6 +39,11 @@ protected function prepare($context)
         return parent::prepare($context);
     }
 
+    public function getPath(): string
+    {
+        return $this->path;
+    }
+
     protected function isInPreviewMode(): bool
     {
         return $this->fusionValue(self::PREVIEW_MODE);

Classes/Fusion/SelfWrapping.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace PackageFactory\AtomicFusion\PresentationObjects\Fusion;
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package
+ */
+
+/**
+ * The trait for self-wrapping presentation components for inline editing
+ *
+ * The wrapper function should be created by AbstractComponentPresentationObjectFactory::createWrapper()
+ */
+trait SelfWrapping
+{
+    /**
+     * @var callable|null
+     */
+    private $wrapper;
+
+    final public function wrap(string $value): string
+    {
+        $wrapper = $this->wrapper;
+
+        return $wrapper ? $wrapper($value) : $value;
+    }
+}