Upgrade to v11

Classes/Analyzers/AbstractAnalyzer.php

@@ -2,6 +2,7 @@
 
 namespace UniWue\UwA11yCheck\Analyzers;
 
+use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Client;
 use TYPO3\CMS\Backend\Utility\BackendUtility;
 use TYPO3\CMS\Core\Database\QueryGenerator;
@@ -15,31 +16,21 @@
  */
 abstract class AbstractAnalyzer implements AnalyzerInterface
 {
-    const TYPE_INTERNAL = 'internal';
+    final const TYPE_INTERNAL = 'internal';
 
-    /**
-     * @var string
-     */
-    protected $type = '';
+    protected  string $type = '';
 
     /**
      * @var array
      */
     protected $pageUids = [];
 
-    /**
-     * @return string
-     */
-    public function getType()
+    public function getType(): string
     {
         return $this->type;
     }
     /**
      * Runs all tests for the given preset and recordUid
-     *
-     * @param Preset $preset
-     * @param int $recordUid
-     * @return ResultSet
      */
     public function runTests(Preset $preset, int $recordUid): ResultSet
     {
@@ -58,7 +49,7 @@ public function runTests(Preset $preset, int $recordUid): ResultSet
                 $result = $test->run($html, $recordUid);
                 $results[] = $result;
             }
-        } catch (\GuzzleHttp\Exception\ClientException $e) {
+        } catch (ClientException $e) {
             $resultSet->setFailed(true);
             $resultSet->setFailedMessage($e->getMessage());
         }
@@ -75,9 +66,6 @@ public function runTests(Preset $preset, int $recordUid): ResultSet
 
     /**
      * Initializes the pageUids to check
-     *
-     * @param int $pageUid
-     * @param int $levels
      */
     public function initializePageUids(int $pageUid, int $levels = 0): void
     {
@@ -93,10 +81,6 @@ public function initializePageUids(int $pageUid, int $levels = 0): void
 
     /**
      * Returns the PID of the record
-     *
-     * @param string $table
-     * @param int $recordUid
-     * @return int
      */
     protected function getPidByRecordUid(string $table, int $recordUid): int
     {
@@ -110,9 +94,6 @@ protected function getPidByRecordUid(string $table, int $recordUid): int
 
     /**
      * Fetches the resulting HTML from the given URL
-     *
-     * @param string $url
-     * @return string
      */
     protected function fetchHtml(string $url): string
     {

Classes/Analyzers/NewsAnalyzer.php

@@ -13,16 +13,12 @@
  */
 class NewsAnalyzer extends AbstractAnalyzer
 {
-    /**
-     * @var string
-     */
-    protected $type = AbstractAnalyzer::TYPE_INTERNAL;
+    protected string $type = AbstractAnalyzer::TYPE_INTERNAL;
 
     /**
      * Return an aray of news record Uids to check
      *
-     * @param Preset $preset
-     * @return array
+     * @return mixed[]
      */
     public function getCheckRecordUids(Preset $preset): array
     {
@@ -44,10 +40,9 @@ public function getCheckRecordUids(Preset $preset): array
     /**
      * Returns all news UIDs matching the given demand
      *
-     * @param SingleTableDemand $demand
-     * @return array
+     * @return mixed[]
      */
-    protected function getNewsRecordUids(SingleTableDemand $demand)
+    protected function getNewsRecordUids(SingleTableDemand $demand): array
     {
         $queryBuilder = GeneralUtility::makeInstance(ConnectionPool::class)
             ->getQueryBuilderForTable($demand->getTableName());

Classes/Analyzers/PageContentAnalyzer.php

@@ -9,16 +9,12 @@
  */
 class PageContentAnalyzer extends AbstractAnalyzer
 {
-    /**
-     * @var string
-     */
-    protected $type = AbstractAnalyzer::TYPE_INTERNAL;
+    protected string $type = AbstractAnalyzer::TYPE_INTERNAL;
 
     /**
      * Return an aray of page record Uids to check
      *
-     * @param Preset $preset
-     * @return array
+     * @return mixed[]
      */
     public function getCheckRecordUids(Preset $preset): array
     {

Classes/Check/A11yCheck.php

@@ -7,27 +7,17 @@
  */
 class A11yCheck
 {
-    /**
-     * @var Preset
-     */
-    protected $preset;
-
     /**
      * A11yCheck constructor.
-     *
-     * @param Preset $preset
      */
-    public function __construct(Preset $preset)
+    public function __construct(protected Preset $preset)
     {
-        $this->preset = $preset;
     }
 
     /**
      * Executes the check and returns the result as objectStorage
      *
-     * @param int $id
-     * @param int $levels
-     * @return array
+     * @return ResultSet[]
      */
     public function executeCheck(int $id, int $levels = 0): array
     {

Classes/Check/Preset.php

@@ -10,115 +10,48 @@
  */
 class Preset
 {
-    /**
-     * @var string
-     */
-    protected $id = '';
-
-    /**
-     * @var string
-     */
-    protected $name = '';
-
-    /**
-     * @var string
-     */
-    protected $description = '';
-
-    /**
-     * @var AbstractAnalyzer
-     */
-    protected $analyzer;
-
-    /**
-     * @var AbstractCheckUrlGenerator
-     */
-    protected $checkUrlGenerator;
-
-    /**
-     * @var TestSuite
-     */
-    protected $testSuite;
+    protected string $description = '';
 
     /**
      * Preset constructor.
-     *
-     * @param string $id
-     * @param string $name
-     * @param AbstractAnalyzer $analyzer
-     * @param AbstractCheckUrlGenerator $checkUrlGenerator
-     * @param TestSuite $testSuite
-     * @param array $configuration
      */
-    public function __construct(
-        string $id,
-        string $name,
-        AbstractAnalyzer $analyzer,
-        AbstractCheckUrlGenerator $checkUrlGenerator,
-        TestSuite $testSuite,
-        array $configuration
-    ) {
-        $this->id = $id;
-        $this->name = $name;
-        $this->analyzer = $analyzer;
-        $this->checkUrlGenerator = $checkUrlGenerator;
-        $this->testSuite = $testSuite;
+    public function __construct(protected string $id, protected string $name, protected AbstractAnalyzer $analyzer, protected AbstractCheckUrlGenerator $checkUrlGenerator, protected TestSuite $testSuite, array $configuration)
+    {
     }
 
-    /**
-     * @return string
-     */
-    public function getId()
+    public function getId(): string
     {
         return $this->id;
     }
 
-    /**
-     * @return string
-     */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * @return string
-     */
     public function getDescription(): string
     {
         return $this->description;
     }
 
-    /**
-     * @return string
-     */
     public function getCheckTableName(): string
     {
         return $this->checkUrlGenerator->getTableName();
     }
 
-    /**
-     * @return string
-     */
     public function getEditRecordTableName(): string
     {
         return $this->checkUrlGenerator->getEditRecordTable();
     }
 
     /**
      * Returns the check URL
-     *
-     * @param int $id
-     * @return string
      */
     public function getCheckUrl(int $id): string
     {
         return $this->checkUrlGenerator->getCheckUrl($id);
     }
 
-    /**
-     * @return TestSuite
-     */
     public function getTestSuite(): TestSuite
     {
         return $this->testSuite;
@@ -127,11 +60,9 @@ public function getTestSuite(): TestSuite
     /**
      * Executes the testSuite configured in the preset by the given page UID and recursive levels
      *
-     * @param int $pageUid
-     * @param int $levels
-     * @return array
+     * @return ResultSet[]
      */
-    public function executeTestSuiteByPageUid(int $pageUid, int $levels)
+    public function executeTestSuiteByPageUid(int $pageUid, int $levels): array
     {
         $result = [];
         $this->analyzer->initializePageUids($pageUid, $levels);
@@ -146,8 +77,7 @@ public function executeTestSuiteByPageUid(int $pageUid, int $levels)
     /**
      * Executes the testSuite configured in the preset by the given array of record UIDs
      *
-     * @param array $recordUids
-     * @return array
+     * @return ResultSet[]
      */
     public function executeTestSuiteByRecordUids(array $recordUids): array
     {