Merge pull request #70 from Flowpack/feature/parentNodeAndDeprecateTriggeringNode

FEATURE: Deprecate `triggeringNode` in favour of `site` and `parentNode`

Author: mhsdesign

Classes/Domain/TemplateNodeCreationHandler.php

@@ -9,6 +9,7 @@
 use Neos\ContentRepository\Domain\Model\NodeInterface;
 use Neos\ContentRepository\Domain\Service\NodeTypeManager;
 use Neos\Flow\Annotations as Flow;
+use Neos\Neos\Domain\Service\ContentContext;
 use Neos\Neos\Ui\NodeCreationHandler\NodeCreationHandlerInterface;
 
 class TemplateNodeCreationHandler implements NodeCreationHandlerInterface
@@ -49,9 +50,15 @@ public function handle(NodeInterface $node, array $data): void
             return;
         }
 
+        /** @var ContentContext $contentContext */
+        $contentContext = $node->getContext();
+
         $evaluationContext = [
             'data' => $data,
+            // triggeringNode is deprecated and will be removed in 3.0
             'triggeringNode' => $node,
+            'site' => $contentContext->getCurrentSiteNode(),
+            'parentNode' => $node->getParent(),
         ];
 
         $templateConfiguration = $node->getNodeType()->getConfiguration('options.template');

README.md

@@ -159,19 +159,29 @@ because it inspires a more declarative mood. The naming is inspired by Ansible.
 
 There are several variables available in the EEL context for example.
 
-| Variable name  | Type                 | Description                                                | Availability          |
-|----------------|----------------------|------------------------------------------------------------|-----------------------|
-| data           | array<string, mixed> | Data from the node creation dialog                         | Global                |
-| triggeringNode | NodeInterface        | The main node whose creation triggered template processing | Global                |
-| item           | mixed                | The current item inside a withItems loop                   | Inside withItems loop |
-| key            | string               | The current key inside a withItems loop                    | Inside withItems loop |
+| Variable name    | Type                   | Description                                                                   | Availability            |
+|------------------|------------------------|-------------------------------------------------------------------------------|-------------------------|
+| data             | `array<string, mixed>` | Data from the node creation dialog                                            | Global                  |
+| site             | `Node`                 | The site node in which the new node be created in                             | Global                  |
+| parentNode       | `Node`                 | The node where the new utmost node will be created inside                     | Global                  |
+| ~triggeringNode~ | `Node`                 | _Deprecated:_ The new node itself which is triggering the template processing | Global                  |
+| item             | `mixed`                | The current item value inside a loop                                          | Inside `withItems` loop |
+| key              | `string`               | The current item key inside a loop                                            | Inside `withItems` loop |
+
+> **Notice**
+> `triggeringNode` will be removed with version 3.0
+
+> **Warning**
+> The behaviour of `parentNode` changed from version 1.x to version 2.2
+> Previously it referenced the parent node of the current template part and its nesting.
+> With version 2.0 it was removed and 2.2 reintroduced the variable identifying the parent node of the first/utmost node that will be created.
 
 ### Additional context
 
 You can add more context variables to a template via the ``withContext`` setting. ``withContext``
 takes an arbitrary array of items whose values might also contain EEL expressions:
 
-```
+```yaml
 template:
   withContext:
     someText: '<p>foo</p>'

Tests/Functional/Features/Variables/NodeTypes.Variables.yaml

@@ -0,0 +1,13 @@
+# We test that `parentNode` and `site` are accessible in EEL
+---
+
+'Flowpack.NodeTemplates:Content.Variables':
+  superTypes:
+    'Neos.Neos:Content': true
+  properties:
+    text:
+      type: string
+  options:
+    template:
+      properties:
+        text: "${'parentNode(' + parentNode.nodeType.name + ', ' + parentNode.name + ') site(' + site.nodeType.name + ', ' + site.name + ')'}"

Tests/Functional/Features/Variables/Snapshots/Variables.nodes.json

@@ -0,0 +1,5 @@
+{
+    "properties": {
+        "text": "parentNode(Neos.Neos:ContentCollection, main) site(unstructured, test-site)"
+    }
+}

Tests/Functional/Features/Variables/Snapshots/Variables.template.json

@@ -0,0 +1,6 @@
+{
+    "properties": {
+        "text": "parentNode(Neos.Neos:ContentCollection, main) site(unstructured, test-site)"
+    },
+    "childNodes": []
+}

Tests/Functional/Features/Variables/Snapshots/Variables.yaml

@@ -0,0 +1,5 @@
+'{nodeTypeName}':
+  options:
+    template:
+      properties:
+        text: 'parentNode(Neos.Neos:ContentCollection, main) site(unstructured, test-site)'

Tests/Functional/Features/Variables/VariablesTest.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Flowpack\NodeTemplates\Tests\Functional\Features\Variables;
+
+use Flowpack\NodeTemplates\Tests\Functional\AbstractNodeTemplateTestCase;
+
+class VariablesTest extends AbstractNodeTemplateTestCase
+{
+    /** @test */
+    public function itMatchesSnapshot(): void
+    {
+        $createdNode = $this->createNodeInto(
+            $this->homePageMainContentCollectionNode,
+            'Flowpack.NodeTemplates:Content.Variables',
+            []
+        );
+
+        $this->assertLastCreatedTemplateMatchesSnapshot('Variables');
+
+        $this->assertNoExceptionsWereCaught();
+        $this->assertNodeDumpAndTemplateDumpMatchSnapshot('Variables', $createdNode);
+    }
+}