Merge pull request #31 from a-kehr/controller

Umsetzung als Symfony Bundle

.gitignore

@@ -0,0 +1,4 @@
+/.idea/
+/vendor/
+/composer.lock
+/composer.phar

.php-cs-fixer.dist.php

@@ -0,0 +1,28 @@
+<?php
+
+$date = date('Y');
+
+$header = <<<EOF
+Contao Onepage Navigation for Contao Open Source CMS.
+
+@copyright  Copyright (c) $date, Erdmann & Freunde
+@author     Erdmann & Freunde <https://erdmann-freunde.de>
+@license    MIT
+@link       https://github.com/erdmannfreunde/contao-onepage-navigation
+EOF;
+
+$finder = (new \PhpCsFixer\Finder())
+    ->in(__DIR__ . '/src');
+
+return (new \PhpCsFixer\Config())
+    ->setRules(
+        [
+            '@Symfony'       => true,
+            'header_comment' => [
+                'header' => $header
+            ],
+        ]
+    )
+    ->setFinder($finder)
+    ->setUsingCache(false)
+    ->setLineEnding("\r\n");

composer.json

@@ -12,8 +12,13 @@
 		},
 		{
 			"name":"Erdmann & Freunde // Sebastian Buck",
-			"homepage":"http://erdmann-freunde.de",
+			"homepage":"https://erdmann-freunde.de",
 			"role":"Developer"
+		},
+		{
+			"name": "Kehr Solutions",
+			"homepage": "https://www.kehr-solutions.de",
+			"role": "Developer"
 		}
 	],
 	"support":{
@@ -22,10 +27,13 @@
 		"source":"https://github.com/ErdmannFreunde/contao-onepage-navigation"
 	},
 	"require":{
-		"contao/core-bundle": "~4.9 || ~5.0"
+		"php": "^8.2",
+		"contao/core-bundle": "^5.3"
 	},
 	"require-dev": {
-		 "contao/manager-plugin": "^2.0"
+		 "contao/manager-plugin": "^2.0",
+		"friendsofphp/php-cs-fixer": "^3.64",
+		"phpstan/phpstan": "^1.12"
 	},
 	"replace":{
 		"sascha-brandhoff/onepage-navigation":"self.version"
@@ -37,5 +45,12 @@
 	},
 	"extra": {
 		"contao-manager-plugin": "EuF\\OnepageNavigation\\ContaoManager\\ContaoManagerPlugin"
+	},
+	"config": {
+		"allow-plugins": {
+			"contao-components/installer": true,
+			"php-http/discovery": true,
+			"contao/manager-plugin": true
+		}
 	}
 }

config/services.yaml

@@ -0,0 +1,9 @@
+services:
+  _defaults:
+    autoconfigure: true
+    autowire: true
+
+  EuF\OnepageNavigation\EventListener\InsertTagsListener: ~
+  EuF\OnepageNavigation\EventListener\GetArticleListener: ~
+  EuF\OnepageNavigation\Controller\FrontendModule\OnepageNavigationController: ~
+  EuF\OnepageNavigation\EventListener\DataContainer\GenerateAliasSaveCallback: ~

contao/dca/tl_article.php

@@ -0,0 +1,74 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Contao Onepage Navigation for Contao Open Source CMS.
+ *
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
+ * @author     Erdmann & Freunde <https://erdmann-freunde.de>
+ * @license    MIT
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
+ */
+
+use Contao\CoreBundle\DataContainer\PaletteManipulator;
+
+/*
+ * Palettes
+ */
+PaletteManipulator::create()
+    ->addLegend('onepage_legend', 'layout_legend', PaletteManipulator::POSITION_BEFORE)
+    ->addField('addNavigation', 'onepage_legend', PaletteManipulator::POSITION_APPEND)
+    ->applyToPalette('default', 'tl_article');
+
+$GLOBALS['TL_DCA']['tl_article']['palettes']['__selector__'][] = 'addNavigation';
+$GLOBALS['TL_DCA']['tl_article']['subpalettes']['addNavigation'] = 'navigation_title,navigation_jumpTo';
+
+/*
+ * Fields
+ */
+$GLOBALS['TL_DCA']['tl_article']['fields']['addNavigation'] = [
+    'exclude' => true,
+    'inputType' => 'checkbox',
+    'eval' => [
+        'submitOnChange' => true,
+        'doNotCopy' => true,
+    ],
+    'sql' => [
+        'type' => 'string',
+        'length' => 1,
+        'fixed' => true,
+        'default' => '',
+    ],
+];
+
+$GLOBALS['TL_DCA']['tl_article']['fields']['navigation_title'] = [
+    'exclude' => true,
+    'inputType' => 'text',
+    'search' => true,
+    'eval' => [
+        'mandatory' => false,
+        'decodeEntities' => true,
+        'maxlength' => 255,
+        'tl_class' => 'w50',
+    ],
+    'sql' => [
+        'type' => 'string',
+        'default' => '',
+    ],
+];
+
+$GLOBALS['TL_DCA']['tl_article']['fields']['navigation_jumpTo'] = [
+    'exclude' => true,
+    'inputType' => 'text',
+    'search' => true,
+    'eval' => [
+        'maxlength' => 255,
+        'tl_class' => 'w50',
+        'rgxp' => 'alias',
+    ],
+    'sql' => [
+        'type' => 'string',
+        'default' => '',
+    ],
+];

contao/dca/tl_module.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Contao Onepage Navigation for Contao Open Source CMS.
+ *
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
+ * @author     Erdmann & Freunde <https://erdmann-freunde.de>
+ * @license    MIT
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
+ */
+
+use EuF\OnepageNavigation\Controller\FrontendModule\OnepageNavigationController;
+
+/*
+ * Palettes
+ */
+$GLOBALS['TL_DCA']['tl_module']['palettes'][OnepageNavigationController::TYPE] = '{title_legend},name,headline,type;{reference_legend:hide},defineRoot;{template_legend:hide},customTpl;{protected_legend:hide},protected;{expert_legend:hide},guests,cssID;';

src/Resources/contao/languages/de/modules.php → contao/languages/de/modules.php

@@ -5,10 +5,10 @@
 /*
  * Contao Onepage Navigation for Contao Open Source CMS.
  *
- * @copyright  Copyright (c) 2021, Erdmann & Freunde
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
  * @author     Erdmann & Freunde <https://erdmann-freunde.de>
  * @license    MIT
- * @link       http://github.com/erdmannfreunde/contao-onepage-navigation
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
  */
 
 /*

contao/languages/de/tl_article.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * Contao Onepage Navigation for Contao Open Source CMS.
+ *
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
+ * @author     Erdmann & Freunde <https://erdmann-freunde.de>
+ * @license    MIT
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
+ */
+
+/*
+ * Legends
+ */
+$GLOBALS['TL_LANG']['tl_article']['onepage_legend'] = 'Onepage-Navigation';
+
+/*
+ * Fields
+ */
+$GLOBALS['TL_LANG']['tl_article']['addNavigation'] = ['Als Navigationspunkt hinzufügen', 'Wenn Sie diesen Artikel zur Navigation hinzufügen möchten, aktivieren Sie bitte die Checkbox.'];
+$GLOBALS['TL_LANG']['tl_article']['navigation_title'] = ['Navigationtitel', 'Bitte geben Sie den Titel für die Navigation ein, wenn dieser abweichend vom allgemeinen Titel ist.'];
+$GLOBALS['TL_LANG']['tl_article']['navigation_jumpTo'] = ['Sprungmarke', 'Hier können Sie eine optionale Bezeichnung der Sprungmarke eingeben. Diese wird nur gesetzt, wenn Sie keine ID festgelegt haben.'];

src/Resources/contao/languages/en/modules.php → contao/languages/en/modules.php

@@ -5,10 +5,10 @@
 /*
  * Contao Onepage Navigation for Contao Open Source CMS.
  *
- * @copyright  Copyright (c) 2021, Erdmann & Freunde
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
  * @author     Erdmann & Freunde <https://erdmann-freunde.de>
  * @license    MIT
- * @link       http://github.com/erdmannfreunde/contao-onepage-navigation
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
  */
 
 /*

src/Resources/contao/languages/en/tl_article.php → contao/languages/en/tl_article.php

@@ -5,10 +5,10 @@
 /*
  * Contao Onepage Navigation for Contao Open Source CMS.
  *
- * @copyright  Copyright (c) 2021, Erdmann & Freunde
+ * @copyright  Copyright (c) 2024, Erdmann & Freunde
  * @author     Erdmann & Freunde <https://erdmann-freunde.de>
  * @license    MIT
- * @link       http://github.com/erdmannfreunde/contao-onepage-navigation
+ * @link       https://github.com/erdmannfreunde/contao-onepage-navigation
  */
 
 /*
@@ -19,6 +19,6 @@
 /*
  * Fields
  */
-$GLOBALS['TL_LANG']['tl_article']['addNavigation']     = ['Add as navigation item', 'If you want to add this article to the navigation check this box.'];
-$GLOBALS['TL_LANG']['tl_article']['navigation_title']  = ['Alternative title', 'You can define an optional title to be displayed in the navigation for this item.'];
+$GLOBALS['TL_LANG']['tl_article']['addNavigation'] = ['Add as navigation item', 'If you want to add this article to the navigation check this box.'];
+$GLOBALS['TL_LANG']['tl_article']['navigation_title'] = ['Alternative title', 'You can define an optional title to be displayed in the navigation for this item.'];
 $GLOBALS['TL_LANG']['tl_article']['navigation_jumpTo'] = ['Anchor', 'Define an optional jump to anchor. It will only be used if you did not define a custom ID.'];

contao/templates/frontend_module/onepage_navigation.html.twig

@@ -0,0 +1,15 @@
+{% extends '@Contao/frontend_module/_base.html.twig' %}
+
+{% set searchable = false %}
+
+{% block content %}
+    {% if hasItems %}
+        <ul class="level_1">
+            {% for item in navigation %}
+                <li{% if item.css is defined %} class="{{ item.css }}"{% endif %} data-onepage-link="{{ item.navigation_jumpTo }}">
+                    <a href="{{ item.onepage_jump }}" data-onepage-link="{{ item.navigation_jumpTo }}" title="{{ item.title }}">{{ item.title }}</a>
+                </li>
+            {% endfor %}
+        </ul>
+    {% endif %}
+{% endblock %}

src/Resources/contao/templates/js_onepage_navigation.html5 → contao/templates/js_onepage_navigation.html5

@@ -3,7 +3,7 @@
 
 <script>
 (function() {
-  let list = document.querySelector('.mod_onepage_navigation');
+  let list = document.querySelector('.module-onepage-navigation');
 
   new Onepage(list, {
     'offset': '30', // make navigation active when 30% is visible

phpstan.neon

@@ -0,0 +1,19 @@
+parameters:
+    level: 6
+
+    featureToggles:
+        alwaysTrueAlwaysReported: false
+        detectDeadTypeInMultiCatch: false
+        disableCheckMissingIterableValueType: false
+
+    universalObjectCratesClasses:
+        - Contao\Model
+        - Contao\ArticleModel
+        - Contao\DataContainer
+        - Contao\Model\Collection
+
+    ignoreErrors:
+        - identifier: missingType.iterableValue
+
+    treatPhpDocTypesAsCertain: false
+    rememberPossiblyImpureFunctionValues: false