Merge branch 'feat-quqiqer-v2' into 'dev'

feat!: quiqqer v2

See merge request !8

.gitignore

+tools/
+phpstan.neon
+.phpunit.result.cache
+phpunit.xml
\ No newline at end of file

.phive/phars.xml

+<?xml version="1.0" encoding="UTF-8"?>
+<phive xmlns="https://phar.io/phive">
+  <phar name="phpstan" version="^1.10.67" installed="1.10.67" location="./tools/phpstan" copy="false"/>
+</phive>

composer.json

 {
-    "name": "quiqqer\/faq",
-    "type": "quiqqer-module",
-    "description": "With the FAQ page types it is easy to create FAQs for your users.",
-    "license": [
-        "PCSG QL-1.0",
-        "CC BY-NC-SA 4.0"
-    ],
-    "authors": [
-        {
-            "name": "Henning Leutz",
-            "email": "leutz@pcsg.de",
-            "homepage": "http:\/\/www.pcsg.de",
-            "role": "Developer"
-        }
-    ],
-    "support": {
-        "email": "support@pcsg.de",
-        "url": "http:\/\/www.pcsg.de"
-    },
-    "require": {
-        "php": ">=5.3",
-        "quiqqer\/quiqqer": "*@dev"
-    },
-    "autoload": {
-        "psr-4": {
-            "QUI\\FAQ\\": "src\/QUI\/FAQ\/"
-        }
+  "name": "quiqqer/faq",
+  "type": "quiqqer-module",
+  "description": "With the FAQ page types it is easy to create FAQs for your users.",
+  "license": [
+    "PCSG QL-1.0",
+    "CC BY-NC-SA 4.0"
+  ],
+  "authors": [
+    {
+      "name": "Henning Leutz",
+      "email": "leutz@pcsg.de",
+      "homepage": "https://www.pcsg.de",
+      "role": "Developer"
     }
+  ],
+  "support": {
+    "email": "support@pcsg.de",
+    "url": "https://www.pcsg.de"
+  },
+  "require": {
+    "php": "^8.1",
+    "quiqqer/core": "^2"
+  },
+  "autoload": {
+    "psr-4": {
+      "QUI\\FAQ\\": "src/QUI/FAQ/"
+    }
+  }
 }
\ No newline at end of file

phpstan.dist.neon

+includes:
+    - phpstan-baseline.neon
+
+parameters:
+    level: 1
+    paths:
+        - src
+        - types
+    bootstrapFiles:
+        - tests/phpstan-bootstrap.php
\ No newline at end of file

src/QUI/FAQ/Controls/Accordion.php

@@ -7,8 +7,12 @@
 namespace QUI\FAQ\Controls;
 
 use QUI;
+use QUI\Exception;
+use QUI\Projects\Site;
 use QUI\Projects\Site\Utils;
 
+use function boolval;
+
 /**
  * Class Listing
  *
@@ -22,27 +26,27 @@ class Accordion extends QUI\Control
      *
      * @param array $attributes
      */
-    public function __construct($attributes = [])
+    public function __construct(array $attributes = [])
     {
         // default options
         $this->setAttributes([
-            'class'                => 'quiqqer-faqAccordion',
-            'order'                => 'order_field',
-            'stayOpen'             => true, // if true make accordion items stay open when another item is opened
-            'openFirst'            => true, // the first entry is initially opened
-            'listMaxWidth'         => 0, // positive numbers only, 0 disabled this option.
-            'max'                  => 10, // max entries
-            'parentSite'           => null,
-            'siteType'             => 'quiqqer/faq:types/entry',
-            'showMoreButton'       => false,
-            'moreSite'             => '',
+            'class' => 'quiqqer-faqAccordion',
+            'order' => 'order_field',
+            'stayOpen' => true, // if true make accordion items stay open when another item is opened
+            'openFirst' => true, // the first entry is initially opened
+            'listMaxWidth' => 0, // positive numbers only, 0 disabled this option.
+            'max' => 10, // max entries
+            'parentSite' => null,
+            'siteType' => 'quiqqer/faq:types/entry',
+            'showMoreButton' => false,
+            'moreSite' => '',
             'useFaqStructuredData' => false
         ]);
 
         parent::__construct($attributes);
 
         $this->addCSSFile(
-            dirname(__FILE__).'/Accordion.css'
+            dirname(__FILE__) . '/Accordion.css'
         );
 
         $this->setAttribute('cacheable', 0);
@@ -53,18 +57,19 @@ class Accordion extends QUI\Control
      * Can be overwritten
      *
      * @return String
+     * @throws Exception
      */
-    public function getBody()
+    public function getBody(): string
     {
         $FAQParentSite = null;
-        $Engine        = QUI::getTemplateManager()->getEngine();
+        $Engine = QUI::getTemplateManager()->getEngine();
 
         if ($this->getAttribute('parentSite')) {
             try {
-                if ($this->getAttribute('parentSite') instanceof \QUI\Projects\Site) {
+                if ($this->getAttribute('parentSite') instanceof Site) {
                     $FAQParentSite = $this->getAttribute('parentSite');
                 } else {
-                    $FAQParentSite = \QUI\Projects\Site\Utils::getSiteByLink($this->getAttribute('parentSite'));
+                    $FAQParentSite = Utils::getSiteByLink($this->getAttribute('parentSite'));
                 }
             } catch (QUI\Exception $Exception) {
                 QUI\System\Log::addInfo($Exception->getMessage());
@@ -76,7 +81,7 @@ class Accordion extends QUI\Control
         $faqSites = $FAQParentSite->getChildren([
             'where' => [
                 'active' => 1,
-                'type'   => $this->getAttribute('siteType'),
+                'type' => $this->getAttribute('siteType'),
             ],
             'limit' => $this->getAttribute('max'),
             'order' => $this->getAttribute('order')
@@ -84,12 +89,12 @@ class Accordion extends QUI\Control
 
         // show "more faq" link
         $showMoreButton = $this->getAttribute('showMoreButton');
-        $MoreSite       = $FAQParentSite;
+        $MoreSite = $FAQParentSite;
 
         if ($showMoreButton || $this->getAttribute('moreSite')) {
             if ($this->getAttribute('moreSite')) {
                 try {
-                    $MoreSite       = \QUI\Projects\Site\Utils::getSiteByLink($this->getAttribute('moreSite'));
+                    $MoreSite = Utils::getSiteByLink($this->getAttribute('moreSite'));
                     $showMoreButton = true;
                 } catch (QUI\Exception $Exception) {
                     QUI\System\Log::addInfo($Exception->getMessage());
@@ -99,7 +104,7 @@ class Accordion extends QUI\Control
                 $countFaqEntries = $FAQParentSite->getChildren([
                     'where' => [
                         'active' => 1,
-                        'type'   => $this->getAttribute('siteType'),
+                        'type' => $this->getAttribute('siteType'),
                     ],
                     'count' => 1
                 ]);
@@ -113,21 +118,21 @@ class Accordion extends QUI\Control
         $entries = [];
 
         foreach ($faqSites as $FaqSite) {
-            $short   = $FaqSite->getAttribute('short');
+            $short = $FaqSite->getAttribute('short');
             $content = $FaqSite->getAttribute('content');
 
             if ($short) {
-                $short = '<div class="quiqqer-faqAccordion-item-content-pageShort text-muted">'.$short.'</div>';
+                $short = '<div class="quiqqer-faqAccordion-item-content-pageShort text-muted">' . $short . '</div>';
             }
 
             if ($content) {
-                $content = '<div class="quiqqer-faqAccordion-item-content-pageContent">'.$content.'</div>';
+                $content = '<div class="quiqqer-faqAccordion-item-content-pageContent">' . $content . '</div>';
             }
 
-            $entryContent = $short.$content;
+            $entryContent = $short . $content;
 
             $entry = [
-                'entryTitle'   => $FaqSite->getAttribute('title'),
+                'entryTitle' => $FaqSite->getAttribute('title'),
                 'entryContent' => $entryContent,
             ];
 
@@ -135,22 +140,22 @@ class Accordion extends QUI\Control
         }
 
         $Accordion = new QUI\Bricks\Controls\Accordion([
-            'stayOpen'             => \boolval($this->getAttribute('stayOpen')),
-            'openFirst'            => $this->getAttribute('openFirst'),
-            'listMaxWidth'         => $this->getAttribute('listMaxWidth'),
-            'entries'              => $entries,
+            'stayOpen' => boolval($this->getAttribute('stayOpen')),
+            'openFirst' => $this->getAttribute('openFirst'),
+            'listMaxWidth' => $this->getAttribute('listMaxWidth'),
+            'entries' => $entries,
             'useFaqStructuredData' => $this->getAttribute('useFaqStructuredData'),
         ]);
 
         $this->addCSSFiles($Accordion->getCSSFiles());
 
         $Engine->assign([
-            'this'           => $this,
-            'Accordion'      => $Accordion,
+            'this' => $this,
+            'Accordion' => $Accordion,
             'showMoreButton' => $showMoreButton,
-            'MoreSite'       => $MoreSite
+            'MoreSite' => $MoreSite
         ]);
 
-        return $Engine->fetch(dirname(__FILE__).'/Accordion.html');
+        return $Engine->fetch(dirname(__FILE__) . '/Accordion.html');
     }
 }

src/QUI/FAQ/EventsHandler.php

@@ -6,6 +6,8 @@
 
 namespace QUI\FAQ;
 
+use QUI\Exception;
+use QUI\Interfaces\Projects\Site;
 use QUI\Projects\Site\Edit;
 
 /**
@@ -19,20 +21,22 @@ class EventsHandler
      * event on child create
      *
      * @param integer $newId
-     * @param \QUI\Projects\Site\Edit $Parent
+     * @param Site $Parent
+     * @throws Exception
      */
-    public static function onChildCreate($newId, $Parent)
+    public static function onChildCreate(int $newId, Site $Parent): void
     {
         $type = $Parent->getAttribute('type');
 
-        if ($type != 'quiqqer/faq:types/list'
+        if (
+            $type != 'quiqqer/faq:types/list'
             && $type != 'quiqqer/faq:types/category'
         ) {
             return;
         }
 
         $Project = $Parent->getProject();
-        $Site    = new Edit($Project, $newId);
+        $Site = new Edit($Project, $newId);
 
         if ($type == 'quiqqer/faq:types/list') {
             $Site->setAttribute('type', 'quiqqer/faq:types/category');

tests/phpstan-bootstrap.php

+<?php
+
+if (!defined('QUIQQER_SYSTEM')) {
+    define('QUIQQER_SYSTEM', true);
+}
+
+if (!defined('QUIQQER_AJAX')) {
+    define('QUIQQER_AJAX', true);
+}
+
+putenv("QUIQQER_OTHER_AUTOLOADERS=KEEP");
+
+require_once __DIR__ . '/../../../../bootstrap.php';

types/category.php

 <?php
 
+/**
+ * This file contains the category site type
+ *
+ * @var QUI\Projects\Project $Project
+ * @var QUI\Projects\Site $Site
+ * @var QUI\Interfaces\Template\EngineInterface $Engine
+ * @var QUI\Template $Template
+ **/
+
 $entries = $Site->getChildren([
     'type' => 'quiqqer/faq:types/entry'
 ]);

types/entry.php

 <?php
 
 /**
- * FAQ Entry
- */
+ * This file contains the faq entry site type
+ *
+ * @var QUI\Projects\Project $Project
+ * @var QUI\Projects\Site $Site
+ * @var QUI\Interfaces\Template\EngineInterface $Engine
+ * @var QUI\Template $Template
+ **/
 
-$Parent     = $Site->getParent();
+$Parent = $Site->getParent();
 $parentType = $Parent->getAttribute('type');
 
-if ($parentType == 'quiqqer/faq:types/list'
+if (
+    $parentType == 'quiqqer/faq:types/list'
     || $parentType == 'quiqqer/faq:types/category'
 ) {
     QUI::getRewrite()->showErrorHeader(

types/list.php

 <?php
 
-$categories = $Site->getChildren(array(
+/**
+ * This file contains the faq list site type
+ *
+ * @var QUI\Projects\Project $Project
+ * @var QUI\Projects\Site $Site
+ * @var QUI\Interfaces\Template\EngineInterface $Engine
+ * @var QUI\Template $Template
+ **/
+
+$categories = $Site->getChildren([
     'type' => 'quiqqer/faq:types/category'
-));
+]);
 
-$Engine->assign(array(
+$Engine->assign([
     'categories' => $categories
-));
+]);