FEATURE: Add option to hide/disable nodes

This reverts commit 4fa4f45.

Author: mhsdesign

Classes/Domain/NodeCreation/NodeCreationService.php

@@ -53,6 +53,10 @@ public function apply(RootTemplate $template, NodeInterface $node, CaughtExcepti
             $node->setProperty($key, $value);
         }
 
+        if ($template->getDisabled() === true) {
+            $node->setHidden(true);
+        }
+
         $this->ensureNodeHasUriPathSegment($node, $template);
         $this->applyTemplateRecursively($template->getChildNodes(), $node, $caughtExceptions);
     }
@@ -110,6 +114,9 @@ private function applyTemplateRecursively(Templates $templates, NodeInterface $p
                 $node->setProperty($key, $value);
             }
 
+            if ($template->getDisabled() === true) {
+                $node->setHidden(true);
+            }
             $this->ensureNodeHasUriPathSegment($node, $template);
             $this->applyTemplateRecursively($template->getChildNodes(), $node, $caughtExceptions);
         }

Classes/Domain/NodeCreation/PropertiesAndReferences.php

@@ -120,6 +120,9 @@ private function assertValidPropertyName($propertyName): void
         }
         if ($propertyName[0] === '_') {
             $lowerPropertyName = strtolower($propertyName);
+            if ($lowerPropertyName === '_hidden') {
+                throw new \InvalidArgumentException('Using "_hidden" as property declaration was removed. Please use "disabled" on the first level instead.');
+            }
             foreach ($legacyInternalProperties as $legacyInternalProperty) {
                 if ($lowerPropertyName === strtolower($legacyInternalProperty)) {
                     throw new \InvalidArgumentException(sprintf('Internal legacy property "%s" not implement.', $propertyName));

Classes/Domain/Template/RootTemplate.php

@@ -14,6 +14,8 @@
  */
 class RootTemplate implements \JsonSerializable
 {
+    private ?bool $disabled;
+
     /**
      * @var array<string, mixed>
      */
@@ -25,12 +27,18 @@ class RootTemplate implements \JsonSerializable
      * @internal
      * @param array<string, mixed> $properties
      */
-    public function __construct(array $properties, Templates $childNodes)
+    public function __construct(?bool $disabled, array $properties, Templates $childNodes)
     {
+        $this->disabled = $disabled;
         $this->properties = $properties;
         $this->childNodes = $childNodes;
     }
 
+    public function getDisabled(): ?bool
+    {
+        return $this->disabled;
+    }
+
     /**
      * @return array<string, string>
      */
@@ -47,6 +55,7 @@ public function getChildNodes(): Templates
     public function jsonSerialize()
     {
         return [
+            'disabled' => $this->disabled,
             'properties' => $this->properties,
             'childNodes' => $this->childNodes
         ];

Classes/Domain/Template/Template.php

@@ -15,6 +15,8 @@ class Template implements \JsonSerializable
 
     private ?NodeName $name;
 
+    private ?bool $disabled;
+
     /**
      * @var array<string, mixed>
      */
@@ -26,10 +28,11 @@ class Template implements \JsonSerializable
      * @internal
      * @param array<string, mixed> $properties
      */
-    public function __construct(?NodeTypeName $type, ?NodeName $name, array $properties, Templates $childNodes)
+    public function __construct(?NodeTypeName $type, ?NodeName $name, ?bool $disabled, array $properties, Templates $childNodes)
     {
         $this->type = $type;
         $this->name = $name;
+        $this->disabled = $disabled;
         $this->properties = $properties;
         $this->childNodes = $childNodes;
     }
@@ -44,6 +47,11 @@ public function getName(): ?NodeName
         return $this->name;
     }
 
+    public function getDisabled(): ?bool
+    {
+        return $this->disabled;
+    }
+
     /**
      * @return array<string, string>
      */
@@ -62,6 +70,7 @@ public function jsonSerialize()
         return [
             'type' => $this->type,
             'name' => $this->name,
+            'disabled' => $this->disabled,
             'properties' => $this->properties,
             'childNodes' => $this->childNodes
         ];

Classes/Domain/Template/Templates.php

@@ -48,11 +48,12 @@ public function toRootTemplate(): RootTemplate
         }
         foreach ($this->items as $first) {
             return new RootTemplate(
+                $first->getDisabled(),
                 $first->getProperties(),
                 $first->getChildNodes()
             );
         }
-        return new RootTemplate( [], Templates::empty());
+        return new RootTemplate(null, [], Templates::empty());
     }
 
     public function jsonSerialize()

Classes/Domain/TemplateConfiguration/TemplateConfigurationProcessor.php

@@ -111,6 +111,7 @@ private function createTemplateFromTemplatePart(TemplatePart $templatePart): Tem
         return new Template(
             $type ? NodeTypeName::fromString($type) : null,
             $name ? NodeName::fromString($name) : null,
+            $templatePart->hasConfiguration('disabled') ? (bool)$templatePart->processConfiguration('disabled') : null,
             $processedProperties,
             $childNodeTemplates
         );

Classes/Domain/TemplateConfiguration/TemplatePart.php

@@ -192,11 +192,11 @@ private function validateTemplateConfigurationKeys(): void
     {
         $isRootTemplate = $this->fullPathToConfiguration === [];
         foreach (array_keys($this->configuration) as $key) {
-            if (!in_array($key, ['type', 'name', 'properties', 'childNodes', 'when', 'withItems', 'withContext'], true)) {
+            if (!in_array($key, ['type', 'name', 'disabled', 'properties', 'childNodes', 'when', 'withItems', 'withContext'], true)) {
                 throw new \InvalidArgumentException(sprintf('Template configuration has illegal key "%s"', $key));
             }
             if ($isRootTemplate) {
-                if (!in_array($key, ['properties', 'childNodes', 'when', 'withContext'], true)) {
+                if (!in_array($key, ['disabled', 'properties', 'childNodes', 'when', 'withContext'], true)) {
                     throw new \InvalidArgumentException(sprintf('Root template configuration doesnt allow option "%s', $key));
                 }
             }

Configuration/Testing/NodeTypes.yaml

@@ -14,6 +14,13 @@
       ui:
         label: "Text"
 
+'Flowpack.NodeTemplates:Content.Hidden':
+  superTypes:
+    'Neos.Neos:Content': true
+  options:
+    template:
+      disabled: true
+
 'Flowpack.NodeTemplates:Content.DifferentPropertyTypes':
   superTypes:
     'Neos.Neos:Content': true

README.md

@@ -129,6 +129,17 @@ The following example creates three different text child nodes in the main conte
 We call conditions ``when`` and loops ``withItems`` (instead of ``if`` and ``forEach``),
 because it inspires a more declarative mood. The naming is inspired by Ansible.
 
+## Disable nodes (previously called "hidden")
+
+The following example disables a newly created node:
+
+```yaml
+'Neos.NodeTypes:Page':
+  options:
+    template:
+      disabled: true
+```
+
 ## EEL context variables
 
 There are several variables available in the EEL context for example.

Tests/Functional/Fixtures/DifferentPropertyTypes.template.json

@@ -1,4 +1,5 @@
 {
+    "disabled": null,
     "properties": {
         "text": "abc",
         "isEnchanted": false,