update structure of composer.json and update dependencies

* version/2.x-dev:

Classes/MenuService/ServiceInterface.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace DigiComp\Menu\MenuService;
 
 /*
@@ -16,11 +17,10 @@ namespace DigiComp\Menu\MenuService;
  */
 interface ServiceInterface
 {
-
     /**
-     * @param mixed $forPath
+     * @param string|null $forPath
      *
-     * @return array|\Iterator
+     * @return \Iterator
      */
-    public function getItems($forPath = null);
+    public function getItems(string $forPath = null): \Iterator;
 }

Classes/MenuService/SettingsService.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace DigiComp\Menu\MenuService;
 
 /*
@@ -12,53 +13,38 @@ namespace DigiComp\Menu\MenuService;
  */
 
 use Neos\Flow\Annotations as Flow;
-use Neos\Flow\Configuration\ConfigurationManager;
 
 /**
- * @package DigiComp\Menu\Menu
- *
  * @Flow\Scope("singleton")
  */
 class SettingsService implements ServiceInterface
 {
     /**
-     * @var \Neos\Flow\Configuration\ConfigurationManager
+     * @Flow\InjectConfiguration(type="Menu")
+     * @var array
      */
-    protected $configurationManager;
-    public function injectConfigurationManager(ConfigurationManager $configurationManager)
-    {
-        $this->configurationManager = $configurationManager;
-        $this->menuConfiguration = $this->configurationManager->getConfiguration('Menu');
-    }
+    protected array $menuConfiguration;
 
     /**
      * @var array
      */
-    protected $menuConfiguration;
+    protected array $items = [];
 
-    /**
-     * @var array
-     */
-    protected $items = array();
-
-    /**
-     * @param string $forMenu
-     * @return array
-     */
-    public function getItems($forMenu = null)
+    public function getItems(string $forPath = null): \Iterator
     {
-        if ($forMenu) {
-            $items = &$this->menuConfiguration[$forMenu];
+        if ($forPath) {
+            $items = &$this->menuConfiguration[$forPath];
         } else {
             $items = &$this->menuConfiguration;
         }
         if ($items) {
-            uasort(
-                $items, function ($a, $b) {
+            \uasort(
+                $items,
+                static function ($a, $b) {
                     return $a['sorting'] > $b['sorting'];
                 }
             );
         }
-        return $items;
+        return new \ArrayIterator($items);
     }
-}
+}

Classes/Package.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace DigiComp\Menu;
 
 /*
@@ -11,26 +12,26 @@ namespace DigiComp\Menu;
  * source code.
  */
 
+use Neos\Flow\Configuration\ConfigurationManager;
 use Neos\Flow\Core\Bootstrap;
 use Neos\Flow\Package\Package as BasePackage;
-use Neos\Flow\Configuration\ConfigurationManager;
 
 /**
  * Package base class of the DigiComp.Menu package.
  */
 class Package extends BasePackage
 {
-
     public function boot(Bootstrap $bootstrap)
     {
         parent::boot($bootstrap);
 
         $dispatcher = $bootstrap->getSignalSlotDispatcher();
         $dispatcher->connect(
-            'Neos\Flow\Configuration\ConfigurationManager', 'configurationManagerReady',
+            ConfigurationManager::class,
+            'configurationManagerReady',
             function (ConfigurationManager $configurationManager) {
                 $configurationManager->registerConfigurationType('Menu');
             }
         );
     }
-}
+}

Classes/ViewHelpers/ItemsViewHelper.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace DigiComp\Menu\ViewHelpers;
 
 /*
@@ -11,8 +12,10 @@ namespace DigiComp\Menu\ViewHelpers;
  * source code.
  */
 
+use DigiComp\Menu\MenuService\ServiceInterface;
 use Neos\Flow\Annotations as Flow;
 use Neos\FluidAdaptor\Core\ViewHelper\AbstractViewHelper;
+use Neos\FluidAdaptor\Core\ViewHelper\Exception;
 
 /**
  * Just adds the return of MenuService
@@ -20,23 +23,32 @@ use Neos\FluidAdaptor\Core\ViewHelper\AbstractViewHelper;
  */
 class ItemsViewHelper extends AbstractViewHelper
 {
-
     protected $escapeOutput = false;
 
     /**
-     * @var \DigiComp\Menu\MenuService\ServiceInterface
      * @Flow\Inject
+     * @var ServiceInterface
      */
     protected $menuService;
 
     /**
-     * @param string $as
-     * @param string $for
-     * @return string
+     * @throws Exception
      */
-    public function render($as = 'items', $for = null)
+    public function initializeArguments(): void
     {
-        $this->templateVariableContainer->add($as, $this->menuService->getItems($for));
+        $this->registerArgument('for', 'string', 'path in Menu.yaml', false);
+        $this->registerArgument('as', 'string', 'Name in Frontend', false);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function render()
+    {
+        $this->templateVariableContainer->add(
+            $this->arguments['as'],
+            $this->menuService->getItems($this->arguments['for'])
+        );
         return $this->renderChildren();
     }
 }

Classes/ViewHelpers/ProgressViewHelper.php

@@ -1,4 +1,5 @@
 <?php
+
 namespace DigiComp\Menu\ViewHelpers;
 
 /*
@@ -12,47 +13,56 @@ namespace DigiComp\Menu\ViewHelpers;
  */
 
 use Neos\FluidAdaptor\Core\ViewHelper\AbstractViewHelper;
+use Neos\FluidAdaptor\Core\ViewHelper\Exception;
 
 /**
  * Helps to get useful template variables for process menus
  */
 class ProgressViewHelper extends AbstractViewHelper
 {
-
     protected $escapeOutput = false;
 
     /**
-     * @param array  $links
-     * @param int    $activeStep
-     * @param bool   $returnable
-     * @param string $stepsAs
-     * @param string $backLinkAs
-     * @param string $activeStepAs
-     * @param string $linksAs
-     * @param string $activeStepLinkAs
-     * @param int $offset
-     * @param int $linkCount if given overrides count($links)
-     *
-     * @return string
+     * @throws Exception
      */
-    public function render(
-        array $links,
-        $activeStep = 1,
-        $returnable = true,
-        $stepsAs = 'steps',
-        $backLinkAs = 'backLink',
-        $activeStepAs = 'activeStep',
-        $linksAs = 'links',
-        $activeStepLinkAs = 'activeStepLink',
-        $offset = 1,
-        $linkCount = null
-    ) {
+    public function initializeArguments(): void
+    {
+        $this->registerArgument('for', 'string', 'path in Menu.yaml', false);
+        $this->registerArgument('as', 'string', 'Name in Frontend', false);
+        $this->registerArgument('links', 'array', 'links to show', true);
+        $this->registerArgument('activeStep', 'int', 'current active link index', false, 1);
+        $this->registerArgument('returnable', 'bool', 'can you go back to the last index', false, true);
+        $this->registerArgument('stepsAs', 'string', 'variable name of a single step', false, 'steps');
+        $this->registerArgument('backLinkAs', 'string', 'variable name of a backlink', false, 'backLink');
+        $this->registerArgument('linksAs', 'string', 'variable name of the links array', false, 'links');
+        $this->registerArgument(
+            'activeStepLinkAs',
+            'string',
+            'variable name of the active step link',
+            false,
+            'activeStepLink'
+        );
+        $this->registerArgument('offset', 'int', 'offset to start with', false, 1);
+        $this->registerArgument('linkCount', 'int', 'force this number of steps', false);
+    }
+
+    /**
+     * @return mixed
+     */
+    public function render()
+    {
+        $links = $activeStep = $returnable = $stepsAs = $backLinkAs = $activeStepAs = $linksAs =
+            $activeStepLinkAs = $offset = $linkCount = null;
+        \extract($this->arguments, \EXTR_OVERWRITE);
         //handling famous off by one
         $activeStep -= $offset;
         //make sure our array index is numeric
-        $links = array_values($links);
+        if (\is_iterable($links)) {
+            $links = \iterator_to_array($links);
+        }
+        $links = \array_values($links);
         if (!$linkCount) {
-            $linkCount = count($links);
+            $linkCount = \count($links);
         }
         foreach ($links as $i => &$link) {
             $link['completed'] = $activeStep > $i;

License.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Ferdinand Kuhl <f.kuhl@digital-competence.de>
+Copyright (c) 2021 Ferdinand Kuhl <f.kuhl@digital-competence.de>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -16,4 +16,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

composer.json

@@ -1,33 +1,48 @@
 {
     "name": "digicomp/menu",
-    "type": "typo3-flow-package",
     "description": "Helps with the creation of simple fluid based menus",
+    "type": "neos-package",
     "keywords": [
-        "flow",
-        "neos",
+        "Neos",
+        "Flow",
         "menu"
     ],
+    "homepage": "https://git.digital-competence.de/Packages/DigiComp.Menu",
+    "license": "MIT",
     "authors": [
         {
             "name": "Ferdinand Kuhl",
             "email": "f.kuhl@digital-competence.de",
-            "homepage": "http://www.digital-competence.de",
+            "homepage": "https://www.digital-competence.de",
             "role": "Developer"
         }
     ],
-    "license": "MIT",
-    "homepage": "https://github.com/digicomp/DigiComp.Sequence",
     "require": {
-        "neos/flow": "~4.0|~5.3"
+        "php": ">=7.4.0",
+        "neos/flow": "^6.3.21"
+    },
+    "require-dev": {
+        "mikey179/vfsstream": "^1.6.1",
+        "neos/buildessentials": "^7.0.0",
+        "phpunit/phpunit": "~8.5",
+        "vimeo/psalm": "~4.22.0"
     },
     "autoload": {
         "psr-4": {
-            "DigiComp\\Menu\\": "Classes"
+            "DigiComp\\Menu\\": "Classes/"
         }
     },
+    "config": {
+        "sort-packages": true,
+        "platform-check": true
+    },
     "extra": {
         "branch-alias": {
-            "dev-master": "2.0.x-dev"
+            "dev-develop": "3.0.x-dev",
+            "dev-version/2.x-dev": "2.0.x-dev"
+        },
+        "neos": {
+            "package-key": "DigiComp.Menu"
         },
         "applied-flow-migrations": [
             "TYPO3.Fluid-20150214130800",
@@ -65,4 +80,4 @@
             "Neos.Flow-20180415105700"
         ]
     }
-}
+}