[TASK] Reports: Make status compatible to StatusProviderInterface

Adjust method signature and implement new method 'getLabel()'. Use new class ContextualFeedbackSeverity as status code. Resolves: #3376
TYPO3-Solr · Oct 28, 2022 · f671e75 · f671e75
1 parent 7331d7d
commit f671e75
Show file tree

Hide file tree

Showing 9 changed files with 132 additions and 53 deletions.
diff --git a/Classes/Report/AccessFilterPluginInstalledStatus.php b/Classes/Report/AccessFilterPluginInstalledStatus.php
@@ -21,6 +21,7 @@
 use ApacheSolrForTypo3\Solr\System\Solr\Service\SolrAdminService;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
 use Throwable;
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -53,12 +54,12 @@ class AccessFilterPluginInstalledStatus extends AbstractSolrStatus
      * Solr server. Only adds an entry if the Access Filter Query Parser Plugin
      * is not configured.
      *
+     * @return array
+     *
      * @throws DBALDriverException
      * @throws Throwable
-     *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
         $solrConnections = GeneralUtility::makeInstance(ConnectionManager::class)->getAllConnections();
@@ -82,6 +83,14 @@ public function getStatus()
         return $reports;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/access-filter';
+    }
+
     /**
      * Checks whether the Solr plugin is installed.
      *
@@ -106,7 +115,7 @@ protected function checkPluginInstallationStatus(SolrAdminService $adminService)
             /** @scrutinizer ignore-type */
             $report,
             /** @scrutinizer ignore-type */
-            Status::WARNING
+            ContextualFeedbackSeverity::WARNING
         );
     }
 
@@ -135,7 +144,7 @@ protected function checkPluginVersion(SolrAdminService $adminService): ?Status
             /** @scrutinizer ignore-type */
             $report,
             /** @scrutinizer ignore-type */
-            Status::WARNING
+            ContextualFeedbackSeverity::WARNING
         );
     }
 

diff --git a/Classes/Report/AllowUrlFOpenStatus.php b/Classes/Report/AllowUrlFOpenStatus.php
@@ -17,6 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Report;
 
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -30,19 +31,18 @@ class AllowUrlFOpenStatus extends AbstractSolrStatus
 {
     /**
      * Checks whether allow_url_fopen is enabled.
-     * @noinspection PhpMissingReturnTypeInspection
      *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
+     * @return array
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
-        $severity = Status::OK;
+        $severity = ContextualFeedbackSeverity::OK;
         $value = 'On';
         $message = '';
 
         if (!ini_get('allow_url_fopen')) {
-            $severity = Status::ERROR;
+            $severity = ContextualFeedbackSeverity::ERROR;
             $value = 'Off';
             $message = 'allow_url_fopen must be enabled in php.ini to allow
 				communication between TYPO3 and the Apache Solr server.
@@ -64,4 +64,12 @@ public function getStatus()
 
         return $reports;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/allow-url-open';
+    }
 }
diff --git a/Classes/Report/FilterVarStatus.php b/Classes/Report/FilterVarStatus.php
@@ -17,6 +17,7 @@
 
 namespace ApacheSolrForTypo3\Solr\Report;
 
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -31,13 +32,13 @@ class FilterVarStatus extends AbstractSolrStatus
     /**
      * Checks whether allow_url_fopen is enabled.
      *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
+     * @return array
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
 
-        $validUrl = 'http://www.typo3-solr.com';
+        $validUrl = 'https://www.typo3-solr.com';
         if (!filter_var($validUrl, FILTER_VALIDATE_URL)) {
             $message = 'You are using a PHP version that is affected by a bug in
 				function filter_var(). This bug causes said function to
@@ -53,10 +54,18 @@ function filter_var(). This bug causes said function to
                 'PHP filter_var() bug',
                 'Affected PHP version detected.',
                 $message,
-                Status::ERROR
+                ContextualFeedbackSeverity::ERROR
             );
         }
 
         return $reports;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/filter-var';
+    }
 }
diff --git a/Classes/Report/SchemaStatus.php b/Classes/Report/SchemaStatus.php
@@ -21,6 +21,7 @@
 use ApacheSolrForTypo3\Solr\System\Solr\SolrConnection;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
 use Throwable;
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -50,12 +51,12 @@ class SchemaStatus extends AbstractSolrStatus
      * Solr server. Only adds an entry if a schema other than the
      * recommended one was found.
      *
+     * @return array
+     *
      * @throws DBALDriverException
      * @throws Throwable
-     *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
         /** @var $connectionManager ConnectionManager */
@@ -77,7 +78,7 @@ public function getStatus()
                     /** @scrutinizer ignore-type */
                     $pingFailedMsg,
                     /** @scrutinizer ignore-type */
-                    Status::ERROR
+                    ContextualFeedbackSeverity::ERROR
                 );
                 $reports[] = $status;
                 continue;
@@ -96,12 +97,20 @@ public function getStatus()
                     /** @scrutinizer ignore-type */
                     $report,
                     /** @scrutinizer ignore-type */
-                    Status::WARNING
+                    ContextualFeedbackSeverity::WARNING
                 );
                 $reports[] = $status;
             }
         }
 
         return $reports;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/schema';
+    }
 }
diff --git a/Classes/Report/SiteHandlingStatus.php b/Classes/Report/SiteHandlingStatus.php
@@ -25,6 +25,7 @@
 use Throwable;
 use TYPO3\CMS\Core\Site\Entity\Site as Typo3Site;
 use TYPO3\CMS\Core\Site\Entity\SiteLanguage;
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -54,12 +55,12 @@ class SiteHandlingStatus extends AbstractSolrStatus
      *
      * @var SiteRepository
      */
-    protected $siteRepository;
+    protected SiteRepository $siteRepository;
 
     /**
      * @var ExtensionConfiguration
      */
-    protected $extensionConfiguration;
+    protected ExtensionConfiguration $extensionConfiguration;
 
     /**
      * SolrStatus constructor.
@@ -75,13 +76,14 @@ public function __construct(
     }
 
     /**
+     * Verifies the site configuration.
+     *
      * @return array
      *
      * @throws DBALDriverException
      * @throws Throwable
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
 
@@ -97,7 +99,7 @@ public function getStatus()
                     /** @scrutinizer ignore-type */
                     vsprintf('The configured Site "%s" is not TYPO3 managed site. Please refer to TYPO3 site management docs and configure the site properly.', [$site->getLabel()]),
                     /** @scrutinizer ignore-type */
-                    Status::ERROR
+                    ContextualFeedbackSeverity::ERROR
                 );
                 continue;
             }
@@ -147,10 +149,18 @@ protected function generateValidationReportForSingleSite(Typo3Site $ypo3Site): S
             /** @scrutinizer ignore-type */
             $renderedReport,
             /** @scrutinizer ignore-type */
-            $globalPassedStateForThisSite == true ? Status::OK : Status::ERROR
+            $globalPassedStateForThisSite == true ? ContextualFeedbackSeverity::OK : ContextualFeedbackSeverity::ERROR
         );
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/site-handling';
+    }
+
     /**
      * Generates the validation result array for using them in standalone view as a table row.
      *

diff --git a/Classes/Report/SolrConfigStatus.php b/Classes/Report/SolrConfigStatus.php
@@ -20,6 +20,7 @@
 use ApacheSolrForTypo3\Solr\ConnectionManager;
 use Doctrine\DBAL\Driver\Exception as DBALDriverException;
 use Throwable;
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -49,12 +50,12 @@ class SolrConfigStatus extends AbstractSolrStatus
      * Solr server. Only adds an entry if a solrconfig other than the
      * recommended one was found.
      *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
+     * @return array
      *
      * @throws DBALDriverException
      * @throws Throwable
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
         $solrConnections = GeneralUtility::makeInstance(ConnectionManager::class)->getAllConnections();
@@ -74,7 +75,7 @@ public function getStatus()
                     /** @scrutinizer ignore-type */
                     $report,
                     /** @scrutinizer ignore-type */
-                    Status::WARNING
+                    ContextualFeedbackSeverity::WARNING
                 );
 
                 $reports[] = $status;
@@ -83,4 +84,12 @@ public function getStatus()
 
         return $reports;
     }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/config';
+    }
 }
diff --git a/Classes/Report/SolrConfigurationStatus.php b/Classes/Report/SolrConfigurationStatus.php
@@ -24,6 +24,7 @@
 use RuntimeException;
 use TYPO3\CMS\Core\Error\Http\ServiceUnavailableException;
 use TYPO3\CMS\Core\Exception\SiteNotFoundException;
+use TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
 use TYPO3\CMS\Core\Utility\GeneralUtility;
 use TYPO3\CMS\Reports\Status;
 
@@ -38,12 +39,12 @@ class SolrConfigurationStatus extends AbstractSolrStatus
     /**
      * @var ExtensionConfiguration
      */
-    protected $extensionConfiguration;
+    protected ExtensionConfiguration $extensionConfiguration;
 
     /**
      * @var FrontendEnvironment
      */
-    protected $frontendEnvironment;
+    protected FrontendEnvironment $frontendEnvironment;
 
     /**
      * SolrConfigurationStatus constructor.
@@ -64,10 +65,8 @@ public function __construct(
      * @return array
      *
      * @throws DBALDriverException
-     *
-     * @noinspection PhpMissingReturnTypeInspection see {@link \TYPO3\CMS\Reports\StatusProviderInterface::getStatus()}
      */
-    public function getStatus()
+    public function getStatus(): array
     {
         $reports = [];
 
@@ -87,6 +86,14 @@ public function getStatus()
         return $reports;
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    public function getLabel(): string
+    {
+        return 'solr/configuration';
+    }
+
     /**
      * Checks whether the "Use as Root Page" page property has been set for any
      * site.
@@ -110,7 +117,7 @@ protected function getRootPageFlagStatus(): ?Status
             /** @scrutinizer ignore-type */
             $report,
             /** @scrutinizer ignore-type */
-            Status::ERROR
+            ContextualFeedbackSeverity::ERROR
         );
     }
 
@@ -138,7 +145,7 @@ protected function getConfigIndexEnableStatus(): ?Status
             /** @scrutinizer ignore-type */
             $report,
             /** @scrutinizer ignore-type */
-            Status::WARNING
+            ContextualFeedbackSeverity::WARNING
         );
     }