[FEATURE] Allow for using another method than GET in FileUtility, res…

…olves #29

ChangeLog

@@ -1,3 +1,7 @@
+2024-11-10 Francois Suter (Idéative)  <[email protected]>
+
+    * Allow for using another method than GET in FileUtility, resolves #29
+
 2024-11-04 Francois Suter (Idéative)  <[email protected]>
 
     * Add events for replacing all usual hooks, resolves #31

Classes/Utility/FileUtility.php

@@ -42,6 +42,7 @@ public function __toString(): string
     {
         return 'FileUtility';
     }
+
     /**
      * Reads data from a file pointed to by a versatile URI.
      *
@@ -51,9 +52,10 @@ public function __toString(): string
      *
      * @param string $uri Address of the file to read
      * @param array|null $headers Headers to pass on to the request
+     * @param string $method Method to use for fetching a remote URI, defaults to GET
      * @return string|bool
      */
-    public function getFileContent(string $uri, ?array $headers = null): bool|string
+    public function getFileContent(string $uri, ?array $headers = null, string $method = 'GET'): bool|string
     {
         // Reset the error message
         $this->setError('');
@@ -97,7 +99,7 @@ public function getFileContent(string $uri, ?array $headers = null): bool|string
             try {
                 $response = $requestFactory->request(
                     $uri,
-                    'GET',
+                    $method,
                     is_array($headers) ? ['headers' => $headers] : []
                 );
                 $data = $response->getBody()->getContents();
@@ -156,12 +158,13 @@ public function getFileContent(string $uri, ?array $headers = null): bool|string
      *
      * @param string $uri Address of the file to read
      * @param array|null $headers Headers to pass on to the request
+     * @param string $method Method to use for fetching a remote URI, defaults to GET
      * @return string|bool
      * @see getFileContent
      */
-    public function getFileAsTemporaryFile(string $uri, ?array $headers = null): bool|string
+    public function getFileAsTemporaryFile(string $uri, ?array $headers = null, string $method = 'GET'): bool|string
     {
-        $fileContent = $this->getFileContent($uri, $headers);
+        $fileContent = $this->getFileContent($uri, $headers, $method);
         // Exit early if file content could not be read
         if ($fileContent === false) {
             return false;
@@ -199,6 +202,6 @@ public function getError(): string
      */
     public function setError(string $error): void
     {
-        $this->error = (string)$error;
+        $this->error = $error;
     }
 }

Documentation/Developers/Utilities/Index.rst

@@ -47,8 +47,8 @@ Reading files
 """""""""""""
 
 The :code:`\Cobweb\Svconnector\Utility\FileUtility` provides a general
-method for reading the content of a file. It will transparently handle
-the following syntax for pointing to a file:
+method for reading the content of a file, even if that is actually an API endpoint.
+It will transparently handle the following syntax for pointing to a resource:
 
 - an absolute file path (within the TYPO3 root path or :code:`TYPO3_CONF_VARS[BE][lockRootPath]`),
   e.g. :file:`/var/foo/web/fileadmin/import/bar.csv`