[FEATURE] Add new "requestOptions" parameter, resolves #14

Author: fsuter

ChangeLog

@@ -1,3 +1,7 @@
+2026-03-13 Francois Suter (Idéative)  <typo3@ideative.ch>
+
+    * Add new "requestOptions" parameter, resolves #14
+
 2026-02-02 Francois Suter (Idéative)  <typo3@ideative.ch>
 
     * Ensure compatibility with TYPO3 14 and PHP 8.5, resolves #13

Classes/Service/ConnectorFeed.php

@@ -61,6 +61,12 @@ public function checkConfiguration(): array
                 'LLL:EXT:svconnector_feed/Resources/Private/Language/locallang.xlf:no_feed_defined'
             );
         }
+        // The "requestOptions" parameter is expected to be an array
+        if (isset($this->parameters['requestOptions']) && !is_array($this->parameters['requestOptions'])) {
+            $result[ContextualFeedbackSeverity::WARNING->value][] = $this->sL(
+                'LLL:EXT:svconnector_feed/Resources/Private/Language/locallang.xlf:request_options_must_be_array'
+            );
+        }
         return $result;
     }
 
@@ -142,12 +148,26 @@ protected function query(): mixed
             );
         }
 
-        $headers = $this->parameters['headers'] ?? [];
+        // Define the request options
+        $requestOptions = $this->parameters['requestOptions'] ?? [];
+        // Include deprecated headers property
+        // TODO: remove in next major version
+        if (is_array($this->parameters['headers'] ?? null) && count($this->parameters['headers']) > 0) {
+            $requestOptions = array_merge_recursive($requestOptions, ['headers' => $this->parameters['headers']]);
+            $backtrace = debug_backtrace(DEBUG_BACKTRACE_IGNORE_ARGS, 2);
+            $caller = end($backtrace);
+            $callerLocation = sprintf('file %s, line %d', $caller['file'], $caller['line']);
+
+            trigger_error(sprintf(
+                'Property "headers" is deprecated. Pass headers as part of the "requestOptions" property instead. Location: %s',
+                $callerLocation,
+            ), E_USER_DEPRECATED);
+        }
         $fileUtility = GeneralUtility::makeInstance(FileUtility::class);
         $data = $fileUtility->getFileContent(
             $this->parameters['uri'],
-            count($headers) > 0 ? $headers : null,
-            $this->parameters['method'] ?? 'GET'
+            $this->parameters['method'] ?? 'GET',
+            $requestOptions
         );
         if ($data === false) {
             $message = sprintf(

Documentation/Configuration/Index.rst

@@ -46,6 +46,36 @@ Description
   This parameter is optional and the method defaults to GET.
 
 
+.. _configuration-request-options:
+
+requestOptions
+^^^^^^^^^^^^^^
+
+Type
+  array
+
+Description
+  Key-value pairs of options that can be passed to the request. Any of the
+  `request options supported by Guzzle HTTP <https://docs.guzzlephp.org/en/stable/request-options.html>`_
+  may be used.
+
+  .. note::
+
+     This makes sense only when using fully qualified URLs in the :ref:`uir parameter <configuration-uri>`.
+
+Example
+  Passing a "page" information in the body and setting an accepted mime type in the headers.
+
+  .. code-block:: php
+
+      'requestOptions' => [
+         'body' => '{"page": 1}',
+         'headers' => [
+            'Accept' => 'application/xml',
+         ],
+      ],
+
+
 .. _configuration-headers:
 
 headers
@@ -57,6 +87,11 @@ Type
 Description
   Key-value pairs of headers that should be sent along with the request.
 
+  .. warning::
+
+     This parameter has been deprecated. It will be removed in the next major version.
+     Use :ref:`requestOptions <configuration-request-options>` instead.
+
 Example
   Example headers for setting an alternate user agent and defining what reponse
   format to accept.

Documentation/Index.rst

@@ -27,7 +27,7 @@ Feed/XML Connector Service
 		  xml, rss, feed, data import, fetch data
 
 	:Copyright:
-		2009-2025
+		2009-2026
 
 	:Author:
 		  François Suter (Idéative)

Documentation/Installation/Index.rst

@@ -16,6 +16,20 @@ XML files inside your own code. It requires extension “svconnector”
 which provides the base for all connector services.
 
 
+.. _installation-update-600:
+
+Updating to 6.0.0
+^^^^^^^^^^^^^^^^^
+
+Version 6.0.0 adds support for TYPO3 13 and PHP 8.5, while dropping support
+for TYPO3 12 and PHP 8.1.
+
+A new parameter :ref:`requestOptions <configuration-request-options>` is available.
+It makes it possible to use any of the request options supported by Guzzle HTTP.
+The "headers" parameter has been deprecated. Headers should be passed as part of the
+"requestOptions" instead.
+
+
 .. _installation-update-500:
 
 Updating to 5.0.0

Documentation/guides.xml

@@ -13,7 +13,7 @@
     <project
             title="XML/RSS feed Connector Service"
             release="5.0.0"
-            copyright="2009-2025"
+            copyright="2009-2026"
     />
     <inventory id="svconnector" url="https://docs.typo3.org/p/cobweb/svconnector/main/en-us/"/>
 </guides>

Resources/Private/Language/locallang.xlf

@@ -9,6 +9,9 @@
 			<trans-unit id="feed_not_fetched" xml:space="preserve">
 				<source>XML file %1$s could not be fetched with error: %2$s</source>
 			</trans-unit>
+			<trans-unit id="request_options_must_be_array" xml:space="preserve">
+				<source>The "requestOptions" parameter must be an array. It will be ignored.</source>
+			</trans-unit>
 		</body>
 	</file>
 </xliff>