[TASK] Clean up code, harden typing, remove deprecated method

cobwebch · Dec 27, 2022 · c0d2006 · c0d2006
1 parent 6b98481
commit c0d2006
Show file tree

Hide file tree

Showing 10 changed files with 36 additions and 51 deletions.
diff --git a/Classes/Exception/ConnectorException.php b/Classes/Exception/ConnectorException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -16,8 +19,6 @@
 
 /**
  * Base class for all Connector-related exceptions.
- * 
- * @package Cobweb\Svconnector\Exception
  */
 class ConnectorException extends \Exception
 {

diff --git a/Classes/Exception/ConnectorRuntimeException.php b/Classes/Exception/ConnectorRuntimeException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -17,8 +20,6 @@
 /**
  * Exception to throw when an error happens while performing
  * a non-specific connector operation.
- *
- * @package Cobweb\Svconnector\Exception
  */
 class ConnectorRuntimeException extends ConnectorException
 {

diff --git a/Classes/Exception/EmptySourceException.php b/Classes/Exception/EmptySourceException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -16,8 +19,6 @@
 
 /**
  * Exception to throw when the source of data is empty.
- *
- * @package Cobweb\Svconnector\Exception
  */
 class EmptySourceException extends ConnectorException
 {

diff --git a/Classes/Exception/InvalidSourceException.php b/Classes/Exception/InvalidSourceException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -16,8 +19,6 @@
 
 /**
  * Exception to throw when the source contains invalid or malformed data.
- *
- * @package Cobweb\Svconnector\Exception
  */
 class InvalidSourceException extends ConnectorException
 {

diff --git a/Classes/Exception/SourceErrorException.php b/Classes/Exception/SourceErrorException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -17,8 +20,6 @@
 /**
  * Exception to throw when an error occurs when trying to access a source of data
  * (e.g. a file is not found, a database cannot be accessed, etc.).
- *
- * @package Cobweb\Svconnector\Exception
  */
 class SourceErrorException extends ConnectorException
 {

diff --git a/Classes/Exception/UnknownServiceException.php b/Classes/Exception/UnknownServiceException.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Exception;
 
 /*
@@ -16,8 +19,6 @@
 
 /**
  * Exception to throw when an unknown service is requested.
- *
- * @package Cobweb\Svconnector\Exception
  */
 class UnknownServiceException extends ConnectorException
 {

diff --git a/Classes/Utility/AbstractFileReader.php b/Classes/Utility/AbstractFileReader.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Utility;
 
 /*
@@ -17,15 +19,13 @@
 
 /**
  * Abstract base class for classes used in the $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['svconnector']['fileReader'] hook.
- *
- * @package Cobweb\Svconnector\Utility
  */
 abstract class AbstractFileReader
 {
     /**
      * @var FileUtility
      */
-    protected $fileUtility;
+    protected FileUtility $fileUtility;
 
     public function __construct($fileUtility)
     {
@@ -40,5 +40,5 @@ public function __construct($fileUtility)
      * @param string $uri
      * @return string
      */
-    abstract public function read($uri): string;
+    abstract public function read(string $uri): string;
 }
diff --git a/Classes/Utility/ConnectorUtility.php b/Classes/Utility/ConnectorUtility.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Utility;
 
 /*
@@ -17,10 +19,6 @@
 
 /**
  * Utility class for the Connector family of services
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_svconnector
  */
 class ConnectorUtility
 {
@@ -73,10 +71,10 @@ class ConnectorUtility
      *
      * @param string $string XML to parse
      * @param int $options LIBXML options for XML parsing (optional)
-     * @throws \Exception
      * @return array PHP array
+     *@throws \Exception
      */
-    public static function convertXmlToArray($string, $options = null): array
+    public static function convertXmlToArray(string $string, int $options = 0): array
     {
         // If input string is empty, exit with exception
         if (empty($string)) {
@@ -107,7 +105,7 @@ public static function convertXmlToArray($string, $options = null): array
      * @param array $namespaces List of namespaces used (optional)
      * @return array Transformed XML node and children
      */
-    public static function handleXmlNode(\SimpleXMLElement $node, $namespaces = [])
+    public static function handleXmlNode(\SimpleXMLElement $node, array $namespaces = [])
     {
         // Init
         $nodeArray = [];
@@ -152,7 +150,7 @@ public static function handleXmlNode(\SimpleXMLElement $node, $namespaces = [])
      * @param string $namespace Namespace to be parsed (optional)
      * @return array
      */
-    public static function handleChildren(\SimpleXMLElement $node, $namespaces = [], $namespace = null) {
+    public static function handleChildren(\SimpleXMLElement $node, array $namespaces = [], $namespace = null) {
         $children = $node->children($namespace, true);
         $array = [];
         if ($children->count() > 0) {

diff --git a/Classes/Utility/FileUtility.php b/Classes/Utility/FileUtility.php
@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\Utility;
 
 /*
@@ -23,8 +25,6 @@
 
 /**
  * Class for opening either local or remote files.
- *
- * @package Cobweb\Svconnector\Utility
  */
 class FileUtility implements SingletonInterface
 {
@@ -54,7 +54,7 @@ public function __toString()
      * @param array|null $headers Headers to pass on to the request
      * @return string|bool
      */
-    public function getFileContent($uri, $headers = null)
+    public function getFileContent(string $uri, $headers = null)
     {
         // Reset the error message
         $this->setError('');
@@ -152,7 +152,7 @@ public function getFileContent($uri, $headers = null)
      * @return string|bool
      * @see getFileContent
      */
-    public function getFileAsTemporaryFile($uri, $headers = null)
+    public function getFileAsTemporaryFile(string $uri, $headers = null)
     {
         $fileContent = $this->getFileContent($uri, $headers);
         // Exit early if file content could not be read
@@ -194,7 +194,7 @@ public function getError(): string
      *
      * @param string $error
      */
-    public function setError($error)
+    public function setError(string $error): void
     {
         $this->error = (string)$error;
     }

diff --git a/Classes/ViewHelpers/Be/ResultViewHelper.php b/Classes/ViewHelpers/Be/ResultViewHelper.php
@@ -1,4 +1,7 @@
 <?php
+
+declare(strict_types=1);
+
 namespace Cobweb\Svconnector\ViewHelpers\Be;
 
 /*
@@ -20,10 +23,6 @@
 
 /**
  * This view helper is designed to output the result of the connection test appropriately, depending on its format
- *
- * @author Francois Suter (Cobweb) <typo3@cobweb.ch>
- * @package TYPO3
- * @subpackage tx_svconnector
  */
 class ResultViewHelper extends AbstractBackendViewHelper
 {
@@ -44,24 +43,6 @@ public function initializeArguments()
         $this->registerArgument('result', 'mixed', 'Result of the connection test', true);
     }
 
-    /**
-     * Renders whatever result the connection test returned.
-     *
-     * TODO: remove when v8 compatibility is dropped.
-     *
-     * @return string
-     */
-    public function render()
-    {
-        return static::renderStatic(
-                [
-                        'result' => $this->arguments['result']
-                ],
-                $this->buildRenderChildrenClosure(),
-                $this->renderingContext
-        );
-    }
-
     /**
      * Renders whatever result the connection test returned.
      *