Merge pull request #17 from PackageFactory/enum-provider

Enum provider

Author: nezaniel

Classes/Application/PseudoEnumProvider.php

@@ -0,0 +1,109 @@
+<?php declare(strict_types=1);
+namespace PackageFactory\AtomicFusion\PresentationObjects\Application;
+
+/*
+ * This file is part of the PackageFactory.AtomicFusion.PresentationObjects package.
+ */
+
+use Neos\ContentRepository\Domain\Model\NodeInterface;
+use Neos\ContentRepository\Domain\Model\NodeType;
+use Neos\ContentRepository\NodeTypePostprocessor\NodeTypePostprocessorInterface;
+use Neos\Flow\Annotations as Flow;
+use Neos\Flow\I18n\Translator;
+use Neos\Neos\Service\DataSource\AbstractDataSource;
+use Neos\Eel\ProtectedContextAwareInterface;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Component\PropType\IsEnum;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\EnumLabel;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\PseudoEnumInterface;
+
+final class PseudoEnumProvider extends AbstractDataSource implements ProtectedContextAwareInterface, NodeTypePostprocessorInterface
+{
+    /**
+     * @Flow\Inject
+     * @var Translator
+     */
+    protected $translator;
+
+    /**
+     * @var string
+     */
+    protected static $identifier = 'packagefactory-atomicfusion-presentationobjects-enumcases';
+
+    /**
+     * @param NodeInterface|null $node
+     * @param array<string|int,string> $arguments
+     * @return array<string|int,array<string,string>>
+     */
+    public function getData(NodeInterface $node = null, array $arguments = []): array
+    {
+        if (!array_key_exists('enumName', $arguments) || !is_string($arguments['enumName'])) {
+            throw new \InvalidArgumentException('Argument "enumName" must be provided.', 1625297174);
+        }
+        /** @var class-string<mixed> $enumName */
+        $enumName = $arguments['enumName'];
+
+        $values = $this->getValues($enumName);
+        $enumLabel = EnumLabel::fromEnumName($enumName);
+        $options = [];
+        foreach ($values as $value) {
+            $options[$value]['label'] = $enumLabel->translate((string)$value, $this->translator);
+        }
+
+        return $options;
+    }
+
+    /**
+     * @param NodeType $nodeType
+     * @param array<mixed> $configuration
+     * @param array<mixed> $options
+     */
+    public function process(NodeType $nodeType, array &$configuration, array $options)
+    {
+        if (!array_key_exists('enumName', $options) || !is_string($options['enumName'])) {
+            throw new \InvalidArgumentException('Option "enumName" must be provided.', 1625298032);
+        }
+        if (!array_key_exists('propertyNames', $options) || !is_array($options['propertyNames'])) {
+            throw new \InvalidArgumentException('Option "propertyNames" must be provided.', 1626540931);
+        }
+        /** @var class-string<mixed> $enumName */
+        $enumName = $options['enumName'];
+        $values = $this->getValues($enumName);
+        $enumLabel = EnumLabel::fromEnumName($enumName);
+        foreach ($options['propertyNames'] as $propertyName) {
+            foreach ($values as $value) {
+                $configuration['properties'][$propertyName]['ui']['inspector']['editorOptions']['values'][$value] = [
+                    'label' => $enumLabel->translate((string)$value, $this->translator)
+                ];
+            }
+        }
+    }
+
+    /**
+     * @param class-string<mixed> $enumName
+     * @return array|string[]|int[]
+     */
+    public function getValues(string $enumName): array
+    {
+        return array_map(function (PseudoEnumInterface $case) {
+            return $case->getValue();
+        }, $this->getCases($enumName));
+    }
+
+    /**
+     * @param class-string<mixed> $enumName
+     * @return array|PseudoEnumInterface[]
+     */
+    public function getCases(string $enumName): array
+    {
+        if (!IsEnum::isSatisfiedByClassName($enumName)) {
+            throw new \InvalidArgumentException('Given enum "' . $enumName . '" does not exist or does not implement the required ' . PseudoEnumInterface::class, 1625297031);
+        }
+
+        return $enumName::cases();
+    }
+
+    public function allowsCallOfMethod($methodName): bool
+    {
+        return true;
+    }
+}

Classes/Domain/Component/PropType/EnumPropType.php

@@ -6,6 +6,7 @@
  */
 
 use Neos\Flow\Annotations as Flow;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\PseudoEnumInterface;
 
 /**
  * @Flow\Proxy(false)
@@ -60,15 +61,17 @@ public function getStyleGuideValue(int $nestingLevel = 0): string
             return '= \'\'';
         }
 
-        $values = $this->className::getValues();
-        $value = reset($values);
-        switch ((string) $type) {
-            case 'string':
-                return '= \'' . $value . '\'';
-            case 'int':
-            case 'float':
-                return '= ' . $value;
-            default:
+        $cases = $this->className::cases();
+        if (!empty($cases)) {
+            /** @var PseudoEnumInterface $defaultCase */
+            $defaultCase = reset($cases);
+            switch ((string) $type) {
+                case 'string':
+                    return '= \'' . $defaultCase->getValue() . '\'';
+                case 'int':
+                    return '= ' . $defaultCase->getValue();
+                default:
+            }
         }
 
         return '= \'\'';

Classes/Domain/Component/PropType/IsEnum.php

@@ -6,7 +6,7 @@
  */
 
 use Neos\Flow\Annotations as Flow;
-use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\EnumInterface;
+use PackageFactory\AtomicFusion\PresentationObjects\Domain\Enum\PseudoEnumInterface;
 
 /**
  * The specification for enum classes
@@ -17,6 +17,6 @@ final class IsEnum
     public static function isSatisfiedByClassName(string $className): bool
     {
         return class_exists($className)
-            && is_subclass_of($className, EnumInterface::class);
+            && is_subclass_of($className, PseudoEnumInterface::class);
     }
 }