FEATURE: Props, PropSets, UseCases Container initially work for CPX

Author: mficzel

Classes/Controller/ApiController.php

@@ -56,12 +56,14 @@ public function configurationAction(?string $sitePackageKey = null): void
         $value['ui'] = [
             'sitePackages' => $allStyleguides,
             'styleguides' => $allStyleguides,
-            'viewportPresets' => $this->configurationService->getSiteConfiguration($styleguideAddress->toString(), 'ui.viewportPresets'),
-            'localePresets' => $this->configurationService->getSiteConfiguration($styleguideAddress->toString(), 'ui.localePresets'),
-            'hotkeys' => $this->configurationService->getSiteConfiguration($styleguideAddress->toString(), 'ui.hotkeys'),
-            'preview' => $this->configurationService->getSiteConfiguration($styleguideAddress->toString(), 'preview')
+            'viewportPresets' => $this->configurationService->getStyleguideConfiguration($styleguideAddress, 'ui.viewportPresets'),
+            'localePresets' => $this->configurationService->getStyleguideConfiguration($styleguideAddress, 'ui.localePresets'),
+            'hotkeys' => $this->configurationService->getStyleguideConfiguration($styleguideAddress, 'ui.hotkeys'),
+            'preview' => $this->configurationService->getStyleguideConfiguration($styleguideAddress, 'preview')
         ];
         $value['styleguideObjects'] = $styleguide->getStyleguideObjectList();
+
+        $this->view->setVariablesToRender(['value']);
         $this->view->assign('value', $value);
     }
 

Classes/Controller/ModuleController.php

@@ -39,7 +39,9 @@ class ModuleController extends ActionController
      */
     public function initializeView(ViewInterface $view)
     {
-        $styleguideAddress = $this->styleguideRepository->getDefault()->address->toString();
+        $defaultStyleguide = $this->styleguideRepository->getDefault();
+        $styleguideAddress = $defaultStyleguide->address->toString();
+
         $this->view->assign('defaultStyleguideAddress', $styleguideAddress);
     }
 

Classes/Controller/PreviewController.php

@@ -58,10 +58,9 @@ class PreviewController extends ActionController
      * @param  string|null  $propSet
      * @param  string|null  $props props as json encoded string
      * @param  string|null  $locales locales-fallback-chain as comma sepertated string
-     * @param  bool|null $showGrid
      * @return string
      */
-    public function indexAction(string $prototypeName, string $sitePackageKey, ?string $useCase = '__default', ?string $propSet = '__default', ?string $props = '', ?string $locales = '', ?bool $showGrid = false): string
+    public function indexAction(string $prototypeName, string $sitePackageKey, ?string $useCase = '__default', ?string $propSet = '__default', ?string $props = '', ?string $locales = ''): string
     {
         $renderProps = [];
         if ($props) {
@@ -85,10 +84,6 @@ public function indexAction(string $prototypeName, string $sitePackageKey, ?stri
             $renderLocales = $this->localeFallback ?: [$this->defaultLocale];
         }
 
-//        if ($showGrid) {
-//            $gridConfigurations = $this->configurationService->getSiteConfiguration($sitePackageKey, ['ui', 'grids']);
-//        }
-
         $styleguide = $this->styleguideRepository->getStyleGuide(StyleguideAddress::fromString($sitePackageKey));
         $result = $styleguide->renderStyleguideObject(
             StyleguideObjectIdentifier::fromString($prototypeName),

Classes/Domain/StyleguideInterface.php

@@ -26,6 +26,8 @@
 
 interface StyleguideInterface
 {
+    public function getStyleguideAddress(): StyleguideAddress;
+
     public function getStyleguideIdentifier(): StyleguideIdentifier;
 
     public function getStyleguideObjectList(): StyleguideObjectCollection;

Classes/Domain/StyleguideMetadataCollection.php

@@ -24,14 +24,28 @@
 final readonly class StyleguideMetadataCollection implements \JsonSerializable, \IteratorAggregate
 {
     /**
-     * @var StyleguideMetadata[]
+     * @var array<string, StyleguideMetadata>
      */
     public array $metadataItems;
 
     public function __construct(
         StyleguideMetadata ... $metadata
     ) {
-        $this->metadataItems = $metadata;
+        $items = [];
+        foreach ($metadata as $metadataItem) {
+            $items[$metadataItem->address->toString()] = $metadataItem;
+        }
+        $this->metadataItems = $items;
+    }
+
+    public function byAddress(StyleguideAddress $address): ?StyleguideMetadata
+    {
+        return $this->metadataItems[$address->toString()] ?? null;
+    }
+
+    public function first(): ?StyleguideMetadata
+    {
+        return $this->metadataItems[array_key_first($this->metadataItems)] ?? null;
     }
 
     public static function fromMultiple(StyleguideMetadataCollection ... $metadataCollection): self

Classes/Domain/StyleguideObjects/Props/Editor.php

@@ -16,7 +16,7 @@
 use Neos\Flow\Annotations as Flow;
 
 #[Flow\Proxy(false)]
-final readonly class Editor
+final readonly class Editor implements \JsonSerializable
 {
     public function __construct(
         public EditorIdentifier $identifier,

Classes/Domain/StyleguideObjects/Props/Prop.php

@@ -16,7 +16,7 @@
 use Neos\Flow\Annotations as Flow;
 
 #[Flow\Proxy(false)]
-final readonly class Prop
+final readonly class Prop implements \JsonSerializable
 {
     public function __construct(
         public PropName $name,

Classes/Domain/StyleguideObjects/Props/PropsCollection.php

@@ -16,7 +16,7 @@
 use Neos\Flow\Annotations as Flow;
 
 #[Flow\Proxy(false)]
-final readonly class PropsCollection
+final readonly class PropsCollection implements \JsonSerializable
 {
     /**
      * @var Prop[]
@@ -31,14 +31,6 @@ public function __construct(Prop ...$props)
         $this->props = $props;
     }
 
-    /**
-     * @return iterable<mixed,Prop>
-     */
-    public function getProps(): iterable
-    {
-        return $this->props;
-    }
-
     /**
      * @return array|Prop[]
      */

Classes/Domain/StyleguideProviderInterface.php

@@ -19,5 +19,5 @@ interface StyleguideProviderInterface
 {
     public function getStyleguideMetadataCollection(StyleguideProviderIdentifier $providerIdentifier): StyleguideMetadataCollection;
 
-    public function getStyleguide(StyleguideIdentifier $identifier): StyleguideInterface;
+    public function getStyleguide(StyleguideAddress $address): StyleguideInterface;
 }

Classes/Domain/StyleguideRepository.php

@@ -5,19 +5,17 @@
 
 use Neos\Flow\Annotations as Flow;
 use Neos\Flow\ObjectManagement\ObjectManagerInterface;
-use Neos\Flow\Reflection\ReflectionService;
-use function PHPUnit\Framework\fileExists;
 
 #[Flow\Scope("singleton")]
 class StyleguideRepository
 {
     #[Flow\Inject]
     protected ObjectManagerInterface $objectManager;
 
-    #[Flow\InjectConfiguration(path: 'styleguideProviders')]
+    #[Flow\InjectConfiguration(package: 'Sitegeist.Monocle', path: 'styleguideProviders')]
     protected array $styleguideProviderConfiguration;
 
-    #[Flow\InjectConfiguration(path: 'defaultStyleguide')]
+    #[Flow\InjectConfiguration(package: 'Sitegeist.Monocle', path: 'defaultStyleguide')]
     protected ?string $defaultStyleguide;
 
     /**
@@ -28,7 +26,10 @@ class StyleguideRepository
     public function getDefault(): StyleguideMetadata
     {
         $all = $this->getAllStyleGuides();
-        return $all->metadataItems[array_key_first($all->metadataItems)];
+        if ($this->defaultStyleguide) {
+            return $all->byAddress(StyleguideAddress::fromString($this->defaultStyleguide));
+        }
+        return $all->first();
     }
 
     public function getAllStyleGuides(): StyleguideMetadataCollection
@@ -46,7 +47,7 @@ public function getStyleGuide(StyleguideAddress $address): StyleguideInterface
         $providers = $this->getProviders();
         $provider = $providers[$address->provider->value] ?? null;
         if ($provider instanceof StyleguideProviderInterface) {
-            return $provider->getStyleguide($address->styleguide);
+            return $provider->getStyleguide($address);
         }
 
         throw new \Exception(sprintf('Styleguide %s in Provider %s was not found', $address->styleguide->value, $address->provider->value));