FEATURE: Add option to hide/disable nodes

This reverts commit 4fa4f45.

Author: mhsdesign

Classes/Domain/NodeCreation/NodeCreationService.php

@@ -53,6 +53,10 @@ public function createMutatorsForRootTemplate(RootTemplate $template, NodeType $
             $this->referencesProcessor->processAndValidateReferences($node, $processingErrors)
         );
 
+        if ($template->getDisabled() === true) {
+            $node->setHidden(true);
+        }
+
         return NodeMutatorCollection::from(
             NodeMutator::setProperties($validProperties),
             $this->createMutatorForUriPathSegment($template->getProperties()),
@@ -164,6 +168,10 @@ private function createMutatorsForChildNodeTemplates(Templates $templates, Trans
 
         }
 
+        if ($template->getDisabled() === true) {
+            $node->setHidden(true);
+        }
+
         return $nodeMutators;
     }
 

Classes/Domain/NodeCreation/PropertiesProcessor.php

@@ -94,6 +94,9 @@ private function assertValidPropertyName($propertyName): void
         }
         if ($propertyName[0] === '_') {
             $lowerPropertyName = strtolower($propertyName);
+            if ($lowerPropertyName === '_hidden') {
+                throw new PropertyIgnoredException('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 PropertyIgnoredException(sprintf('Because internal legacy property "%s" not implement.', $propertyName), 1686149513158);

Classes/Domain/Template/RootTemplate.php

@@ -12,6 +12,8 @@
  */
 class RootTemplate implements \JsonSerializable
 {
+    private ?bool $disabled;
+
     /**
      * @var array<string, mixed>
      */
@@ -23,15 +25,21 @@ 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 static function empty(): self
     {
-        return new RootTemplate([], Templates::empty());
+        return new RootTemplate(null, [], Templates::empty());
+    }
+
+    public function getDisabled(): ?bool
+    {
+        return $this->disabled;
     }
 
     /**
@@ -50,6 +58,7 @@ public function getChildNodes(): Templates
     public function jsonSerialize(): array
     {
         return [
+            'disabled' => $this->disabled,
             'properties' => $this->properties,
             'childNodes' => $this->childNodes
         ];

Classes/Domain/Template/Template.php

@@ -18,6 +18,8 @@ class Template implements \JsonSerializable
 
     private ?NodeName $name;
 
+    private ?bool $disabled;
+
     /**
      * @var array<string, mixed>
      */
@@ -29,10 +31,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;
     }
@@ -47,6 +50,11 @@ public function getName(): ?NodeName
         return $this->name;
     }
 
+    public function getDisabled(): ?bool
+    {
+        return $this->disabled;
+    }
+
     /**
      * @return array<string, string>
      */
@@ -65,6 +73,7 @@ public function jsonSerialize(): array
         return [
             'type' => $this->type,
             'name' => $this->name,
+            'disabled' => $this->disabled,
             'properties' => $this->properties,
             'childNodes' => $this->childNodes
         ];

Classes/Domain/Template/Templates.php

@@ -50,6 +50,7 @@ public function toRootTemplate(): RootTemplate
         }
         foreach ($this->items as $first) {
             return new RootTemplate(
+                $first->getDisabled(),
                 $first->getProperties(),
                 $first->getChildNodes()
             );

Classes/Domain/TemplateConfiguration/TemplateConfigurationProcessor.php

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

Classes/Domain/TemplateConfiguration/TemplatePart.php

@@ -210,15 +210,15 @@ 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)) {
                 $this->addProcessingErrorForPath(
                     new \InvalidArgumentException(sprintf('Template configuration has illegal key "%s"', $key), 1686150349274),
                     $key
                 );
                 throw new StopBuildingTemplatePartException();
             }
             if ($isRootTemplate) {
-                if (!in_array($key, ['properties', 'childNodes', 'when', 'withContext'], true)) {
+                if (!in_array($key, ['disabled', 'properties', 'childNodes', 'when', 'withContext'], true)) {
                     $this->addProcessingErrorForPath(
                         new \InvalidArgumentException(sprintf('Root template configuration doesnt allow option "%s', $key), 1686150340657),
                         $key

README.md

@@ -155,6 +155,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 (in version 1.0 "_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.